Skip to content

[Docs] Add Entrypoints section to User Guides#2518

Open
dsikka wants to merge 4 commits intomainfrom
entrypoint_docs
Open

[Docs] Add Entrypoints section to User Guides#2518
dsikka wants to merge 4 commits intomainfrom
entrypoint_docs

Conversation

@dsikka
Copy link
Collaborator

@dsikka dsikka commented Mar 25, 2026

Summary

Adds a new Entrypoints section under User Guides with detailed documentation for both PTQ entrypoints:

  • Entrypoints overview (guides/entrypoints/index.md) — decision table comparing oneshot vs model_free_ptq to help users choose the right entrypoint
  • oneshot (guides/entrypoints/oneshot.md) — full lifecycle (preprocessing, calibration, postprocessing), all arguments organized by category (model, recipe, dataset, pipeline, misc), calibration pipeline descriptions, and examples for FP8 data-free, GPTQ W4A16, and Llama4 MoE NVFP4 with a proper ignore list
  • model_free_ptq (guides/entrypoints/model-free-ptq.md) — when to use (data-free schemes, no transformers definition, oneshot fallback), how it works internally (file-by-file safetensors processing), standard flow vs NVFP4 microscale flow (with reindex_fused_weights), ignore patterns, and supported schemes table

Also updates .nav.yml to nest the three pages under Entrypoints in User Guides.

🤖 Generated with Claude Code

Adds detailed documentation for both PTQ entrypoints:
- guides/entrypoints/index.md: decision table for oneshot vs model_free_ptq
- guides/entrypoints/oneshot.md: full lifecycle, all arguments in tables,
  calibration pipelines, and examples (FP8, GPTQ W4A16, MoE)
- guides/entrypoints/model-free-ptq.md: when to use, how it works internally,
  standard vs NVFP4 microscale flow (with reindexing), ignore patterns,
  and supported schemes

Updates .nav.yml to nest the three pages under Entrypoints in User Guides.

Co-Authored-By: Claude Sonnet 4.6 (1M context) <noreply@anthropic.com>
@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.

@gemini-code-assist
Copy link
Contributor

Summary of Changes

Hello, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request significantly enhances the documentation for LLM Compressor's post-training quantization (PTQ) entrypoints. It introduces a dedicated 'Entrypoints' section within the User Guides, offering comprehensive details on both oneshot and model_free_ptq. The new content clarifies when and how to use each entrypoint, providing users with the necessary information to select the appropriate quantization method for their specific models and data requirements.

Highlights

  • New Entrypoints Section: A new 'Entrypoints' section has been added under User Guides to centralize documentation for post-training quantization (PTQ) entrypoints.
  • Detailed oneshot Documentation: Comprehensive documentation for the oneshot entrypoint was added, covering its lifecycle (preprocessing, calibration, postprocessing), arguments categorized by model, recipe, dataset, and pipeline, and examples for various quantization scenarios.
  • Detailed model_free_ptq Documentation: Extensive documentation for the model_free_ptq entrypoint was included, detailing its use cases, internal workings, arguments, and specific flows like NVFP4 microscale quantization.
  • Entrypoint Comparison Guide: An overview page for Entrypoints was created, featuring a decision table to help users choose between oneshot and model_free_ptq based on their specific needs.

🧠 New Feature in Public Preview: You can now enable Memory to help Gemini Code Assist learn from your team's feedback. This makes future code reviews more consistent and personalized to your project's style. Click here to enable Memory in your admin console.

Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature Command Description
Code Review /gemini review Performs a code review for the current pull request in its current state.
Pull Request Summary /gemini summary Provides a summary of the current pull request in its current state.
Comment @gemini-code-assist Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help /gemini help Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for GitHub and other Google products, sign up here.

Footnotes

  1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution.

@mergify mergify bot added the documentation Improvements or additions to documentation label Mar 25, 2026
Copy link
Contributor

@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

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

Code Review

This pull request introduces new documentation for two post-training quantization (PTQ) entrypoints: oneshot and model_free_ptq. The oneshot guide details its use for schemes requiring calibration data and Hugging Face model definitions, while model_free_ptq covers data-free quantization for models without such definitions. The navigation file docs/.nav.yml has been updated to include these new guides. Feedback suggests improving the model_free_ptq documentation by updating the default value for the ignore argument to [] for better readability and formatting a note as a !!! note block for consistency. Additionally, a redundant example in the oneshot documentation should be removed.

@dsikka dsikka added the ready When a PR is ready for review label Mar 25, 2026
@dsikka dsikka requested a review from kylesayrs March 25, 2026 19:12
dsikka and others added 2 commits March 25, 2026 19:20
@dsikka dsikka enabled auto-merge (squash) March 25, 2026 21:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation ready When a PR is ready for review

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant