Skip to content

Conversation

@mutichung
Copy link

@mutichung mutichung commented Nov 19, 2025

Summary

Modified some of the docstrings within the llmcompressor.modifiers submodule, mainly:

  • Minor typos.
  • Example YAML config formatting 1 so that they can be correctly rendered and easily copied by users.
  • Lifecycle bullet list formatting.

Test Plan

  • Code: both make quality and make style have been applied.
  • Document:
    • Site is successfully built with make build and make serve.
    • Screenshot is provided for visual checks (left - original; right - modified).
      IMG_20251119_154411_936.jpg

Note

Hi, first-time contributor here. Thank you for the great work!

I'm currently on my way into learning/using the library. While reading through the docs, I noticed these small typos/bugs and felt like I can make the changes to improve the experiences of future readers, so here I am. Please let me know if there's something I did not take into consideration. Looking forward to further discussions!

Footnotes

  1. Are there any preferences regarding YAML formatting? I went for 2 white spaces by following other correctly-formatted YAML samples, but am willing to change if I happen to miss any formatting guidelines.

@github-actions
Copy link

👋 Hi! Thank you for contributing to llm-compressor. Please add the ready label when the PR is ready for review.

Note: This is required to complete the testing suite, please only add the label once the PR is code complete and local testing has been performed.

@mutichung mutichung marked this pull request as ready for review November 19, 2025 09:16
:param module: module being calibrated
:param args: inputs to the module, the first element of which is the
cannonical input
Copy link
Collaborator

Choose a reason for hiding this comment

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

Artillery based quantization was sadly deemed out of scope.

Copy link
Collaborator

@HDCharles HDCharles left a comment

Choose a reason for hiding this comment

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

Nice work!

@HDCharles HDCharles enabled auto-merge (squash) November 20, 2025 21:58
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