Skip to content

[Docs] Fix description in torch.save docs to show default for pickle_protocol instead of variable name #138153

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Closed
zeshengzong wants to merge 1 commit into from
Closed

[Docs] Fix description in torch.save docs to show default for pickle_protocol instead of variable name #138153

zeshengzong wants to merge 1 commit into from

Conversation

@zeshengzong
Copy link
Contributor

@zeshengzong zeshengzong commented Oct 17, 2024

Fixes #138013

Replace DEFAULT_PROTOCOL with actual default value 2 in torch.save method document

Before
image

After
image

@pytorch-bot
Copy link

pytorch-bot bot commented Oct 17, 2024 •
edited
Loading

🔗 Helpful Links

🧪 See artifacts and rendered test results at hud.pytorch.org/pr/138153

Note: Links to docs will display an error until the docs builds have been completed.

✅ No Failures

As of commit d6b5336 with merge base 7711f00 (image):
💚 Looks good so far! There are no failures yet. 💚

This comment was automatically generated by Dr. CI and updates every 15 minutes.

@zeshengzong
Copy link
Contributor Author

zeshengzong commented Oct 17, 2024

@pytorchbot label "topic: not user facing"

@pytorch-bot pytorch-bot bot added the topic: not user facing topic category label Oct 17, 2024
@zeshengzong zeshengzong marked this pull request as ready for review October 17, 2024 06:09
mikaylagawarecki
mikaylagawarecki approved these changes Oct 17, 2024
View reviewed changes
Copy link
Contributor

@mikaylagawarecki mikaylagawarecki left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks

@mikaylagawarecki mikaylagawarecki changed the title [Docs] Fix description in docs to show actural value instead of variable name [Docs] Fix description in torch.save docs to show default for pickle_protocol instead of variable name Oct 17, 2024
@mikaylagawarecki mikaylagawarecki added release notes: python_frontend python frontend release notes category topic: docs topic category and removed topic: not user facing topic category labels Oct 17, 2024
@mikaylagawarecki
Copy link
Contributor

mikaylagawarecki commented Oct 17, 2024

@pytorchbot merge

@pytorch-bot pytorch-bot bot added the ciflow/trunk Trigger trunk jobs on your pull request label Oct 17, 2024
@pytorchmergebot
Copy link
Collaborator

pytorchmergebot commented Oct 17, 2024

Merge started

Your 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

Advanced Debugging
Check the merge workflow status
here

@zeshengzong zeshengzong deleted the opt/docs/6 branch October 18, 2024 00:50
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@mikaylagawarecki mikaylagawarecki mikaylagawarecki approved these changes

Assignees

No one assigned

Labels

ciflow/trunk Trigger trunk jobs on your pull request Merged open source release notes: python_frontend python frontend release notes category topic: docs topic category

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

The doc of save() should say the default value of pickle_protocol parameter is 2

4 participants

@zeshengzong @mikaylagawarecki @pytorchmergebot @pytorchbot