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.
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
[doc] fix amp doc #125673
[doc] fix amp doc #125673
Conversation
🔗 Helpful Links🧪 See artifacts and rendered test results at hud.pytorch.org/pr/125673
Note: Links to docs will display an error until the docs builds have been completed. ❌ 1 New FailureAs of commit 5b262d6 with merge base 470723f (): NEW FAILURE - The following job has failed:
This comment was automatically generated by Dr. CI and updates every 15 minutes. |
ghstack-source-id: 48445cc521730517f3ea483ff04cd31c2a0388b3 Pull Request resolved: #125673
ghstack-source-id: 28766aee2c0ada9b8ae3bfe626aa3c31aa3f6494 Pull Request resolved: #125673
ghstack-source-id: 560b821247756b5532f70c854148a79843554eea Pull Request resolved: #125673
@albanD Sorry, I made a mistake on the document |
docs/source/conf.py
Outdated
@@ -159,6 +159,7 @@ | |||
"hierarchical_pickle", | |||
# torch.amp.autocast_mode | |||
"autocast_decorator", | |||
"is_autocast_available", |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is not ok to add new entries in this file.
You can check how we do with "torch.no_grad" as an example I guess?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
OK, let me check.
ghstack-source-id: 10f6a231bf46752a1663bfefbc98e72baa2ed53d Pull Request resolved: #125673
[ghstack-poisoned]
[ghstack-poisoned]
[ghstack-poisoned]
# Motivation The doc shown on https://pytorch.org/docs/main/amp.html#torch.amp.autocast_mode.is_autocast_available should be `torch.amp.is_autocast_available` instead of `torch.amp.autocast_mode.is_autocast_available`. This PR aims to fix it. [ghstack-poisoned]
ghstack-source-id: 1298912c99609e9f6dcb20040cf609ac9ea44350 Pull Request resolved: #125673
ghstack-source-id: ef57fbbcf7efe4e088c94adf6eb7bd2c4c8016a5 Pull Request resolved: #125673
ghstack-source-id: 253396d0239abe8be2fa9a3ac22fa5b556a0df94 Pull Request resolved: #125673
# Motivation The doc shown on https://pytorch.org/docs/main/amp.html#torch.amp.autocast_mode.is_autocast_available should be `torch.amp.is_autocast_available` instead of `torch.amp.autocast_mode.is_autocast_available`. This PR aims to fix it. [ghstack-poisoned]
# Motivation The doc shown on https://pytorch.org/docs/main/amp.html#torch.amp.autocast_mode.is_autocast_available should be `torch.amp.is_autocast_available` instead of `torch.amp.autocast_mode.is_autocast_available`. This PR aims to fix it. [ghstack-poisoned]
# Motivation The doc shown on https://pytorch.org/docs/main/amp.html#torch.amp.autocast_mode.is_autocast_available should be `torch.amp.is_autocast_available` instead of `torch.amp.autocast_mode.is_autocast_available`. This PR aims to fix it. cc mcarilli ptrblck leslie-fang-intel jgong5 [ghstack-poisoned]
ghstack-source-id: cb6b83640473157192caa4138506c52bdb18ec12 Pull Request resolved: #125673
# Motivation The doc shown on https://pytorch.org/docs/main/amp.html#torch.amp.autocast_mode.is_autocast_available should be `torch.amp.is_autocast_available` instead of `torch.amp.autocast_mode.is_autocast_available`. This PR aims to fix it. cc mcarilli ptrblck leslie-fang-intel jgong5 [ghstack-poisoned]
ghstack-source-id: 4350555e10cd4080e22f2f47130f414026808074 Pull Request resolved: #125673
ghstack-source-id: 80cade57a140d8c9711bb38791016be2fc63e127 Pull Request resolved: #125673
ghstack-source-id: 8475486c809e4f9df1d79674c43647a03bf1b7d4 Pull Request resolved: #125673
ghstack-source-id: d9b0244159593a51a7bf0ac35d454e580a0cef7c Pull Request resolved: #125673
ghstack-source-id: 104df0365a65f1cd92393f406a7bd73e32cc2667 Pull Request resolved: #125673
ghstack-source-id: 9558cec09ca30076152fe04b1df07e83692c7627 Pull Request resolved: #125673
# Motivation The doc shown on https://pytorch.org/docs/main/amp.html#torch.amp.autocast_mode.is_autocast_available should be `torch.amp.is_autocast_available` instead of `torch.amp.autocast_mode.is_autocast_available`. This PR aims to fix it. cc mcarilli ptrblck leslie-fang-intel jgong5 [ghstack-poisoned]
# Motivation The doc shown on https://pytorch.org/docs/main/amp.html#torch.amp.autocast_mode.is_autocast_available should be `torch.amp.is_autocast_available` instead of `torch.amp.autocast_mode.is_autocast_available`. This PR aims to fix it. cc mcarilli ptrblck leslie-fang-intel jgong5 [ghstack-poisoned]
# Motivation The doc shown on https://pytorch.org/docs/main/amp.html#torch.amp.autocast_mode.is_autocast_available should be `torch.amp.is_autocast_available` instead of `torch.amp.autocast_mode.is_autocast_available`. This PR aims to fix it. cc mcarilli ptrblck leslie-fang-intel jgong5 [ghstack-poisoned]
# Motivation The doc shown on https://pytorch.org/docs/main/amp.html#torch.amp.autocast_mode.is_autocast_available should be `torch.amp.is_autocast_available` instead of `torch.amp.autocast_mode.is_autocast_available`. This PR aims to fix it. cc mcarilli ptrblck leslie-fang-intel jgong5 [ghstack-poisoned]
# Motivation The doc shown on https://pytorch.org/docs/main/amp.html#torch.amp.autocast_mode.is_autocast_available should be `torch.amp.is_autocast_available` instead of `torch.amp.autocast_mode.is_autocast_available`. This PR aims to fix it. cc mcarilli ptrblck leslie-fang-intel jgong5 [ghstack-poisoned]
CI seems to be not so happy right now? |
ghstack-source-id: a543fe698c3aa503a1e8d06256679c7c1dc2ba9e Pull Request resolved: #125673
ghstack-source-id: 31d838235c70ce833ab64faa253f61e204380c0e Pull Request resolved: #125673
ghstack-source-id: f9033f5960b604ffc01e78977a675226b32c91be Pull Request resolved: #125673
# Motivation The doc shown on https://pytorch.org/docs/main/amp.html#torch.amp.autocast_mode.is_autocast_available should be `torch.amp.is_autocast_available` instead of `torch.amp.autocast_mode.is_autocast_available`. This PR aims to fix it. cc mcarilli ptrblck leslie-fang-intel jgong5 [ghstack-poisoned]
ghstack-source-id: 968a9904a1bc40796de7c6e12b0d72b97fd4f009 Pull Request resolved: #125673
# Motivation The doc shown on https://pytorch.org/docs/main/amp.html#torch.amp.autocast_mode.is_autocast_available should be `torch.amp.is_autocast_available` instead of `torch.amp.autocast_mode.is_autocast_available`. This PR aims to fix it. cc mcarilli ptrblck leslie-fang-intel jgong5 [ghstack-poisoned]
ghstack-source-id: ae2957d91375f4f3a10d7faebe5442b24337c21b Pull Request resolved: #125673
I can't fully understand the syntax of these docs, so I'm experimenting with them over and over again :( |
# Motivation The doc shown on https://pytorch.org/docs/main/amp.html#torch.amp.autocast_mode.is_autocast_available should be `torch.amp.is_autocast_available` instead of `torch.amp.autocast_mode.is_autocast_available`. This PR aims to fix it. cc mcarilli ptrblck leslie-fang-intel jgong5 [ghstack-poisoned]
# Motivation The doc shown on https://pytorch.org/docs/main/amp.html#torch.amp.autocast_mode.is_autocast_available should be `torch.amp.is_autocast_available` instead of `torch.amp.autocast_mode.is_autocast_available`. This PR aims to fix it. cc mcarilli ptrblck leslie-fang-intel jgong5 [ghstack-poisoned]
# Motivation The doc shown on https://pytorch.org/docs/main/amp.html#torch.amp.autocast_mode.is_autocast_available should be `torch.amp.is_autocast_available` instead of `torch.amp.autocast_mode.is_autocast_available`. This PR aims to fix it. cc mcarilli ptrblck leslie-fang-intel jgong5 [ghstack-poisoned]
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yes they are a bit finicky. Especially for re-exposed APIs.
ghstack-source-id: b5871a1d912907a1c5e2c6427068b8faeac2d0d5 Pull Request resolved: #125673
ghstack-source-id: d65347675b113a328ba41a6190366916a2225431 Pull Request resolved: #125673
ghstack-source-id: 2c1e280d87b302a0907e6620e6afe1086f75e6a0 Pull Request resolved: #125673
# Motivation The doc shown on https://pytorch.org/docs/main/amp.html#torch.amp.autocast_mode.is_autocast_available should be `torch.amp.is_autocast_available` instead of `torch.amp.autocast_mode.is_autocast_available`. This PR aims to fix it. cc mcarilli ptrblck leslie-fang-intel jgong5 [ghstack-poisoned]
# Motivation The doc shown on https://pytorch.org/docs/main/amp.html#torch.amp.autocast_mode.is_autocast_available should be `torch.amp.is_autocast_available` instead of `torch.amp.autocast_mode.is_autocast_available`. This PR aims to fix it. cc mcarilli ptrblck leslie-fang-intel jgong5 [ghstack-poisoned]
# Motivation The doc shown on https://pytorch.org/docs/main/amp.html#torch.amp.autocast_mode.is_autocast_available should be `torch.amp.is_autocast_available` instead of `torch.amp.autocast_mode.is_autocast_available`. This PR aims to fix it. cc mcarilli ptrblck leslie-fang-intel jgong5 [ghstack-poisoned]
ghstack-source-id: bfe3b839847c859e90968282a808acbdefa4580b Pull Request resolved: #125673
ghstack-source-id: dd3b49cd91565ef514499eabdf95c7f8421b8189 Pull Request resolved: #125673
# Motivation The doc shown on https://pytorch.org/docs/main/amp.html#torch.amp.autocast_mode.is_autocast_available should be `torch.amp.is_autocast_available` instead of `torch.amp.autocast_mode.is_autocast_available`. This PR aims to fix it. cc mcarilli ptrblck leslie-fang-intel jgong5 [ghstack-poisoned]
# Motivation The doc shown on https://pytorch.org/docs/main/amp.html#torch.amp.autocast_mode.is_autocast_available should be `torch.amp.is_autocast_available` instead of `torch.amp.autocast_mode.is_autocast_available`. This PR aims to fix it. cc mcarilli ptrblck leslie-fang-intel jgong5 [ghstack-poisoned]
Close this PR as it is expected. |
Stack from ghstack (oldest at bottom):
Motivation
The doc shown on https://pytorch.org/docs/main/amp.html#torch.amp.autocast_mode.is_autocast_available should be
torch.amp.is_autocast_available
instead oftorch.amp.autocast_mode.is_autocast_available
. This PR aims to fix it.cc @mcarilli @ptrblck @leslie-fang-intel @jgong5