[Doc] Update docstrings for torch/random.py #125443
Merged
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
Updates the docstrings for torch/random.py to clarify what device / RNG each function operates on.
While trying to understand the difference between
```
state = torch.random.get_rng_state()
some_code
torch.random.set_rng_state(state)
```
and
```
with torch.random.fork_rng():
some_code
```
I found out that there was a note about this in the docstring that wasn't being rendered on the website. I fixed that note and added additional clarifications on other functions in this file.
Test Plan:
Built the docs and verified that everything renders correctly.
<img width="911" alt="Screenshot 2024-04-30 at 2 22 08 PM" src="https://github.com/pytorch/pytorch/assets/9263852/f219bc35-89bd-4f5b-ba60-255b089499a4">
<img width="901" alt="Screenshot 2024-04-30 at 2 22 13 PM" src="https://github.com/pytorch/pytorch/assets/9263852/c141e7fa-afc9-4c66-b460-96668ce35606">
Pull Request resolved: pytorch#125265
Approved by: https://github.com/Balandat, https://github.com/lezcano
🔗 Helpful Links🧪 See artifacts and rendered test results at hud.pytorch.org/pr/125443
Note: Links to docs will display an error until the docs builds have been completed. ✅ No FailuresAs of commit 5a2ca8c with merge base 86a2d67 ( This comment was automatically generated by Dr. CI and updates every 15 minutes. |
atalman
approved these changes
May 13, 2024
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.
Updates the docstrings for torch/random.py to clarify what device / RNG each function operates on.
While trying to understand the difference between
and
I found out that there was a note about this in the docstring that wasn't being rendered on the website. I fixed that note and added additional clarifications on other functions in this file.
Test Plan:
Built the docs and verified that everything renders correctly.
Cherry picked: #125265
Approved by: https://github.com/Balandat, https://github.com/lezcano