Skip to content
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

Remove warning, and update documentation. #43352

Open
vincentqb opened this issue Aug 20, 2020 · 2 comments
Open

Remove warning, and update documentation. #43352

vincentqb opened this issue Aug 20, 2020 · 2 comments
Labels
module: docs Related to our documentation, both in docs/ and docblocks module: optimizer Related to torch.optim triaged This issue has been looked at a team member, and triaged and prioritized into an appropriate module

Comments

@vincentqb
Copy link
Contributor

vincentqb commented Aug 20, 2020 •
edited

As mentioned here, the warning in LambdaLR should be removed and replaced by a simple note in the load/save state_dict documentation.

cc @jlin27 @vincentqb @gchanan
@vincentqb vincentqb added module: docs Related to our documentation, both in docs/ and docblocks module: optimizer Related to torch.optim triaged This issue has been looked at a team member, and triaged and prioritized into an appropriate module labels Aug 20, 2020
@vincentqb vincentqb mentioned this issue Aug 20, 2020
Closed
@vincentqb vincentqb mentioned this issue Oct 21, 2020
Closed
@jsrozner jsrozner mentioned this issue Oct 24, 2020
Closed
@jsrozner
Copy link
Contributor

Hi, I tried to do the pretty simple pull request. I'm not sure if I need to also recompile documentation or make any other changes?

@vincentqb
Copy link
Contributor Author

Once a PR has landed, the documentation should be propagates automatically to master. :) All that is needed is removing the warning, and adding a comment in the docstring :)

facebook-github-bot pushed a commit that referenced this issue Dec 4, 2020
@jsrozner @facebook-github-bot
Remove save_state_warning in LambdaLR (#46813)
42e6951 
Summary:
Fixes #46405, #43352

I updated the docstring in the local file (function level comments). Do I also need to edit somewhere else or recompile docstrings?

Also, though I didn't change any types here, how is typing (for IDE type checking) documentation generated / used)?

Pull Request resolved: #46813

Reviewed By: ezyang

Differential Revision: D24923112

Pulled By: vincentqb

fbshipit-source-id: be7818e0d4593bfc5d74023b9c361ac2a538589a
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
module: docs Related to our documentation, both in docs/ and docblocks module: optimizer Related to torch.optim triaged This issue has been looked at a team member, and triaged and prioritized into an appropriate module
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@jsrozner @vincentqb