update typo in bnb quantisation 4bit flag docstring#3828
Merged
SunMarc merged 1 commit intohuggingface:mainfrom Nov 4, 2025
Merged
update typo in bnb quantisation 4bit flag docstring#3828SunMarc merged 1 commit intohuggingface:mainfrom
SunMarc merged 1 commit intohuggingface:mainfrom
Conversation
|
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. |
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.
What does this PR do?
Current stable (v11.1.0) docs at https://huggingface.co/docs/accelerate/v1.11.0/en/package_reference/utilities#accelerate.utils.BnbQuantizationConfig reference the 4 bit quantisation flag as
load_in_4_bitinstead ofload_in_4bitas in the class constructor, example code, andtransformers.BitsAndBytesConfig.Note that the source code expects and uses
load_in_4bitin the actual constructor, and the only reference I found matchingload_in_4_bitwas in the docstring for BnBQuantizationConfig in src/accelerate/utils/dataclasses.py.Very minor change, but hoping to save others a quick moment of of puzzle, initially was confused as to why the
transformers.BitsAndBytesConfigwould have subtly different named kwargs, but turned out to be a non issue, as the underlying kwargs I was relying on were actually the same.I thought it would be easier to raise a PR than an issue, but let me know if this was inappropriate.
I haven't run the tests as changes were only in the docstring, but did verify parsing via
python -m compileall src/accelerate/utils/dataclasses.pyand also ranmake stylewithout issues.Before submitting
Pull Request section?
to it if that's the case.
documentation guidelines, and
here are tips on formatting docstrings.
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.
Tagging from the suggested list,
Thanks, let me know if I have missed anything, appreciate the work you all do!