Update docs for tf.unstack with respect to numpy compatibility #18694
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
In 18692 an issue was raised over whether tf.unstack is compatible with numpy.unstack (specified in current docs) or numpy.split. It looks like there is no numpy.unstack. And for numpy.split, it is not compatible with tf.unstack. The tf.split is very close to numpy.split. However, the second arg `num_or_size_splits` in `tf.split` requires the number of the splits, while the second arg `indices_or_sections` in `numpy.split` requires the index of the splits. For that reason the tf.split is not compatible with numpy.split as well. According to the above this fix simply removes `The numpy equivalent` part in the docs of tf.unstack. This fix fixes 18692. Signed-off-by: Yong Tang <yong.tang.github@outlook.com>
martinwicke
approved these changes
Apr 22, 2018
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
In #18692 an issue was raised over whether
tf.unstackis compatible withnumpy.unstack(specified in existing docs) ornumpy.split.It looks like there is no
numpy.unstack. And fornumpy.split, it is not compatible withtf.unstack.The
tf.splitis indeed very close tonumpy.split. However, the second argnum_or_size_splitsintf.splitrequires the number of the splits, while the second argindices_or_sectionsinnumpy.splitrequires the index of the splits. For that reason thetf.splitis not compatible withnumpy.splitas well.According to the above this fix simply removes
The numpy equivalentpart in the docs oftf.unstack.This fix fixes #18692.
Signed-off-by: Yong Tang yong.tang.github@outlook.com