docs(optimization): document num_cycles, not the nonexistent num_periods - #14727
Open
simpleqt wants to merge 1 commit into
Open
docs(optimization): document num_cycles, not the nonexistent num_periods#14727simpleqt wants to merge 1 commit into
simpleqt wants to merge 1 commit into
Conversation
get_cosine_schedule_with_warmup's docstring said num_periods; the signature and closure use num_cycles (the hard-restart sibling documents it correctly).
Contributor
|
Hi @simpleqt, thanks for the PR! It does not appear to link an issue it fixes. If this PR addresses an existing issue, please add a closing keyword (e.g. Please note that PRs without a linked issue are likely to be automatically closed 10 days after this notice. Once the PR links an issue (or gets the |
This file contains hidden or 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
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.
get_cosine_schedule_with_warmup's docstring documents anum_periodsparameter. No such parameter exists — the signature and the cosine closure usenum_cycles(and the hard-restart sibling documentsnum_cyclescorrectly). One-line docstring fix.