-
Notifications
You must be signed in to change notification settings - Fork 25.7k
Minor documentation fixes #61785
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
Minor documentation fixes #61785
Conversation
[ghstack-poisoned]
💊 CI failures summary and remediationsAs of commit f8b0221 (more details on the Dr. CI page and at hud.pytorch.org/pr/61785):
🕵️ 1 new failure recognized by patternsThe following CI failures do not appear to be due to upstream breakages:
|
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.
Thanks for enhancing the docs!
| class _Joinable(ABC): | ||
| r""" | ||
| This defines an abstract base class for joinable classes. A joinable class | ||
| (inheriting from :class:`_Joinable`) should implement a private |
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.
Is _Joinable ever intended to be used by non PyTorch developers? If so we should eventually remove the _ prefix and make it a public API.
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.
Yup, I think it is intended to be used by non-PyTorch developers eventually. Everything (meaning _Joinable, _Join, _JoinHook and also DistributedDataParallel._join_hook(), ZeroRedundancyOptimizer._join_hook()) has a prefix underscore for now. I am not sure when would be the time to do the removal, and I was originally waiting for the feature to be approved. I also think it would be good to discuss exactly which components will be made public and which are kept private.
|
@andwgu has imported this pull request. If you are a Facebook employee, you can view this diff on Phabricator. |
Stack from ghstack:
Differential Revision: D29746648