Fix torch.bucketize docs for "right" #104474
Closed
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
The docs correctly (i.e matching actual op behavior) state that `right = False` means `boundaries[i-1] < input[m][n]...[l][x] <= boundaries[i]`. However they previously stated that `If 'right' is False (default), then the left boundary is closed.` which contradicts the `boundaries[i-1] < input[m][n]...[l][x] <= boundaries[i]` statement. This modifies the docs to say `... then the left boundary is OPEN.` and also clarifies that this is the opposite behavior of numpy.digitize. [ghstack-poisoned]
🔗 Helpful Links🧪 See artifacts and rendered test results at hud.pytorch.org/pr/104474
Note: Links to docs will display an error until the docs builds have been completed. ✅ No FailuresAs of commit 9159edc with merge base 1f6c1d9 ( This comment was automatically generated by Dr. CI and updates every 15 minutes. |
davidberard98
added a commit
that referenced
this pull request
Jun 30, 2023
The docs correctly (i.e matching actual op behavior) state that `right = False` means `boundaries[i-1] < input[m][n]...[l][x] <= boundaries[i]`. However they previously stated that `If 'right' is False (default), then the left boundary is closed.` which contradicts the `boundaries[i-1] < input[m][n]...[l][x] <= boundaries[i]` statement. This modifies the docs to say `... then the left boundary is OPEN.` and also clarifies that this is the opposite behavior of numpy.digitize. ghstack-source-id: b830fa57419cb2b86d42f84564f9ec500fd342a6 Pull Request resolved: #104474
|
@pytorchbot rebase -s |
|
@pytorchbot started a rebase job onto refs/remotes/origin/viable/strict. Check the current status here |
The docs correctly (i.e matching actual op behavior) state that `right = False` means `boundaries[i-1] < input[m][n]...[l][x] <= boundaries[i]`. However they previously stated that `If 'right' is False (default), then the left boundary is closed.` which contradicts the `boundaries[i-1] < input[m][n]...[l][x] <= boundaries[i]` statement. This modifies the docs to say `... then the left boundary is OPEN.` and also clarifies that this is the opposite behavior of numpy.digitize. Fixes #91580 [ghstack-poisoned]
|
Successfully rebased |
pytorchmergebot
pushed a commit
that referenced
this pull request
Aug 16, 2023
The docs correctly (i.e matching actual op behavior) state that `right = False` means `boundaries[i-1] < input[m][n]...[l][x] <= boundaries[i]`. However they previously stated that `If 'right' is False (default), then the left boundary is closed.` which contradicts the `boundaries[i-1] < input[m][n]...[l][x] <= boundaries[i]` statement. This modifies the docs to say `... then the left boundary is OPEN.` and also clarifies that this is the opposite behavior of numpy.digitize. ghstack-source-id: 641dc9124bc6075dfe15faaf70ff29a5e843e612 Pull Request resolved: #104474
davidberard98
added
topic: docs
|
@pytorchbot merge |
Merge failedReason: Approval needed from one of the following: |
svekars
approved these changes
Aug 16, 2023
torch/_torch_docs.py
Outdated
| formally, the returned index satisfies the following rules: | ||
| as :attr:`input`. If :attr:`right` is False (default), then the left boundary is open. Note that | ||
| this behavior is opposite the behavior of | ||
| `numpy.digitize <https://docs.scipy.org/doc/numpy/reference/generated/numpy.digitize.html>`_ |
There was a problem hiding this comment.
Suggested change
| `numpy.digitize <https://docs.scipy.org/doc/numpy/reference/generated/numpy.digitize.html>`_ | |
| `numpy.digitize <https://docs.scipy.org/doc/numpy/reference/generated/numpy.digitize.html>`_. |
…cs for "right"" The docs correctly (i.e matching actual op behavior) state that `right = False` means `boundaries[i-1] < input[m][n]...[l][x] <= boundaries[i]`. However they previously stated that `If 'right' is False (default), then the left boundary is closed.` which contradicts the `boundaries[i-1] < input[m][n]...[l][x] <= boundaries[i]` statement. This modifies the docs to say `... then the left boundary is OPEN.` and also clarifies that this is the opposite behavior of numpy.digitize. Fixes #91580 [ghstack-poisoned]
davidberard98
added a commit
that referenced
this pull request
Aug 16, 2023
The docs correctly (i.e matching actual op behavior) state that `right = False` means `boundaries[i-1] < input[m][n]...[l][x] <= boundaries[i]`. However they previously stated that `If 'right' is False (default), then the left boundary is closed.` which contradicts the `boundaries[i-1] < input[m][n]...[l][x] <= boundaries[i]` statement. This modifies the docs to say `... then the left boundary is OPEN.` and also clarifies that this is the opposite behavior of numpy.digitize. ghstack-source-id: 718098d6f075f8a7394200cbfea261405c13d6e8 Pull Request resolved: #104474
|
@pytorchbot merge |
Merge startedYour change will be merged once all checks pass (ETA 0-4 Hours). Learn more about merging in the wiki. Questions? Feedback? Please reach out to the PyTorch DevX Team |
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.
Stack from ghstack:
The docs correctly (i.e matching actual op behavior) state that
right = Falsemeansboundaries[i-1] < input[m][n]...[l][x] <= boundaries[i].However they previously stated that
If 'right' is False (default), then the left boundary is closed.which contradicts the
boundaries[i-1] < input[m][n]...[l][x] <= boundaries[i]statement.This modifies the docs to say
... then the left boundary is OPEN.and also clarifies that this is the opposite behavior of numpy.digitize.Fixes #91580