[docs] Optimizer and integrations #1125
Merged
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. |
Titus-von-Koeller
approved these changes
Mar 15, 2024
There was a problem hiding this comment.
I really like the refactor you did in this section. Everything flows much better, is coherent and I like the new additions, cleaned up code examples and clarifications a lot! Great work, thanks :D I wish I had these docs when I got started with BNB at the time 😅
|
|
||
| [[autodoc]] bitsandbytes.nn.StableEmbedding | ||
| - __init__ | ||
| For more conceptual details and explanation about 8-bit optimizers, take a look at the [8-bit optimizers](./explanations/optimizers) guide. |
There was a problem hiding this comment.
Really like the new structure, much more graspable and gradual disclosure of details is dosed just right. Excellent!
There was a problem hiding this comment.
Nice rework, 0 complaints!
Titus-von-Koeller
merged commit 0548376
into
bitsandbytes-foundation:main
2 checks passed
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 cleans up the optimizer section by separating the actionable and practical code examples from the more conceptual explanations of how 8-bit optimizers work. I also added very brief code examples in the Integration section to better show how they work for each HF library. Other more minor things include:
➖ remove duplicate Quantization doc from the API section
➕ new explanation doc for how 8-bit optimizers work
cc @Titus-von-Koeller