docs: Replace package abbreviations with full name(bitsandbytes) in docstrings
#33230
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
itazap
pushed a commit
to NielsRogge/transformers
that referenced
this pull request
Sep 20, 2024
… docstrings (huggingface#33230) * docs: Provide fullname for `bitsandbytes` package * docs: Provide fullname for `bitsandbytes` package (2)
BernardZach
pushed a commit
to BernardZach/transformers
that referenced
this pull request
Dec 5, 2024
… docstrings (huggingface#33230) * docs: Provide fullname for `bitsandbytes` package * docs: Provide fullname for `bitsandbytes` package (2)
BernardZach
pushed a commit
to innovationcore/transformers
that referenced
this pull request
Dec 6, 2024
… docstrings (huggingface#33230) * docs: Provide fullname for `bitsandbytes` package * docs: Provide fullname for `bitsandbytes` package (2)
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.
What does this PR do?
Hello, transformers team!
While setting up a new environment for LLM fine-tuning, I encountered an error message stating:
Trainer tried to instantiate bnb optimizer but bnb is not installed!. I recognized thatbnbrefers to thebitsandbytespackage and resolved the issue by installingbitsandbytes. However, this could be confusing for others who might not be aware thatbnbstands forbitsandbytes.To improve clarity and help users identify and install the correct package, I propose updating the docstrings to replace abbreviations like
bnbwith the full namebitsandbytes. This change will provide clearer guidance and reduce potential confusion when encountering similar error messages or documentation references.Thanks for the review in advance!
Before submitting
Who can review?
Anyone in the community is free to review the PR once the tests have passed. Feel free to tag
members/contributors who may be interested in your PR.