Add docstring for torch.slice
#7902
Closed
Conversation
This file contains hidden or 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
sethah
requested review from
apaszke,
colesbury,
ezyang,
gchanan,
soumith and
zdevito
as code owners
sethah
commented
May 28, 2018
| :attr:`dim` between the indices given by integer inputs :attr:`start` and | ||
| :attr:`stop` with the corresponding :attr:`step`, which is an integer. | ||
| The returned tensor has the same number of dimensions as the original tensor |
This comment was marked as off-topic.
This comment was marked as off-topic.
Sorry, something went wrong.
| The returned tensor has the same number of dimensions as the original tensor | ||
| (:attr:`input`). The size of the :attr:`dim`\ th dimension is given by | ||
| ``ceil((min(stop, input.size(dim)) - start) / step)`` |
This comment was marked as off-topic.
This comment was marked as off-topic.
Sorry, something went wrong.
Contributor
Author
|
I'm not sure the test failures are relevant? |
Contributor
|
@pytorchbot retest this please |
Member
Contributor
|
I think it shouldn't be part of the Python API. It has no benefits over regular indexing. |
Contributor
Author
|
Ok, thanks for the feedback. I would propose closing this PR and opening a new one that removes the Python bindings for the |
Contributor
Author
|
Closing this in favor of #7924. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
5 participants
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.
I noticed that
torch.slicedoes not have a docstring (I assume it is an oversight?), so this patch adds docstrings fortorch.sliceandtensor.slice.I built docs with
make htmland inspected them. If there are other checks or changes that need to be made that I have missed, please let me know.