Skip to content

[docs] quant_kwargs #11712

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

Merged
merged 2 commits into from
Jul 29, 2025
Merged

[docs] quant_kwargs #11712

merged 2 commits into from
Jul 29, 2025

Conversation

stevhliu
Copy link
Member

Improves where you can find the quant_kwargs in the PipelineQuantizationConfig docs

@stevhliu stevhliu requested review from sayakpaul and asomoza June 14, 2025 00:40
Copy link
Member

@sayakpaul sayakpaul left a comment

Choose a reason for hiding this comment

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

Thanks! Do we have to include an explicit point on how users can derive qaunt_kwargs for a given backend?

Copy link
Member

@asomoza asomoza left a comment

Choose a reason for hiding this comment

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

I'm undecided as to what is best, to include each quantization backend here as @sayakpaul mentioned or to an index of them like you did, so I'll leave it to you.

Also I wanted to see the final docs but the doc builder failed.

@stevhliu
Copy link
Member Author

stevhliu commented Jun 16, 2025

I think it's probably best to refer the user to the specific API docs for each backend where they can find all the relevant arguments, and keep this one more high-level.

Not sure why the doc-builder is failing though. bitsandbytes should already be installed in the CI test environment no? 🤔

@sayakpaul
Copy link
Member

I think it's probably best to refer the user to the specific API docs for each backend where they can find all the relevant arguments, and keep this one more high-level.

Yeah indeed. I was asking for an explicit note that says just that.

@sayakpaul
Copy link
Member

Not sure why the doc-builder is failing though. bitsandbytes should already be installed in the CI test environment no? 🤔

No actually. bitsandbytes is not a required dependency in our CI and we install it only when running the quantization tests.

I opened #11728 for this. Let's see.

@HuggingFaceDocBuilderDev

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.

@stevhliu stevhliu merged commit dfa4883 into huggingface:main Jul 29, 2025
1 check passed
@stevhliu stevhliu deleted the quant-kwargs branch July 29, 2025 17:23

### Simple quantization
### Basic quantization
Copy link
Member

Choose a reason for hiding this comment

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

in line 94 there's a link to 'simple quantization' so this will break it, change the other link then?

Copy link
Member

Choose a reason for hiding this comment

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

saw this too late I think

Copy link
Member Author

Choose a reason for hiding this comment

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

Oops, should be fixed in #12018!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
4 participants