[docs] APIs #1075
Merged
[docs] APIs #1075
Conversation
This file contains 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
|
The docs for this PR live here. All of your documentation changes will be reflected on that endpoint. The docs are available until 30 days after the last update. |
|
Hey @Titus-von-Koeller, can you check the docstring descriptions for AdaGrad and the base optimizer classes? Since most of the docstring descriptions are the same, if these look good to you, I can easily copy most of them over to the remaining optimizers. |
|
Hey @stevhliu, I'll take a look now. Please be sure to run |
|
Everything looks really good, thanks! I think the docstring for the optimizers and base class is good the way you did it. |
| @@ -1,17 +1,18 @@ | |||
| # AdaGrad | |||
|
|
|||
| [AdaGrad (Adaptive Gradient)](https://jmlr.org/papers/v12/duchi11a.html) is an optimizer that adaptively adjusts the learning rate for each parameter based on their historical gradients. | |||
| [AdaGrad (Adaptive Gradient)](https://jmlr.org/papers/v12/duchi11a.html) is an adaptive learning rate optimizer. AdaGrad stores a sum of the squared past gradients for each parameter and uses it to scale their learning rate. This allows the learning rate to be automatically lower or higher depending on the magnitude of the gradient, eliminating the need to manually tune the learning rate. | |||
There was a problem hiding this comment.
nice summary, much cleaner now!
Titus-von-Koeller
merged commit ac5d6ee
into
bitsandbytes-foundation:main
10 checks passed
Merged
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.
This PR expands the API docs to showcase high-level classes and core lower-level building blocks, starting with the optimizers.