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.

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

docs: Replace package abbreviations with full name(bitsandbytes) in docstrings #33230

Merged

Conversation

rapsealk
Copy link
Contributor

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 that bnb refers to the bitsandbytes package and resolved the issue by installing bitsandbytes. However, this could be confusing for others who might not be aware that bnb stands for bitsandbytes.

To improve clarity and help users identify and install the correct package, I propose updating the docstrings to replace abbreviations like bnb with the full name bitsandbytes. 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

  • This PR fixes a typo or improves the docs (you can dismiss the other checks if that's the case).
  • Did you read the contributor guideline, Pull Request section?

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.

Copy link
Member

@LysandreJik LysandreJik left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sure, thanks @rapsealk!

@LysandreJik LysandreJik merged commit 963ed98 into huggingface:main Sep 2, 2024
20 checks passed
@rapsealk rapsealk deleted the docs/annotate-fullname-bitsandbytes branch September 2, 2024 11:41
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)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants