Skip to content

update rotation doc.#1999

Merged
chensuyue merged 2 commits into
intel:mainfrom
lkk12014402:update_rotation_doc
Jul 6, 2026
Merged

update rotation doc.#1999
chensuyue merged 2 commits into
intel:mainfrom
lkk12014402:update_rotation_doc

Conversation

@lkk12014402

Copy link
Copy Markdown
Contributor

Description

  1. simply the step_by_step* documents
  2. add rotation details documents with roation accuracy results

Signed-off-by: lkk12014402 <kaokao.lv@intel.com>
@lkk12014402 lkk12014402 requested review from wenhuach21 and xin3he and removed request for xin3he July 6, 2026 08:31
@lkk12014402 lkk12014402 requested a review from chensuyue July 6, 2026 08:33
@chensuyue chensuyue added this to the 0.14.0 milestone Jul 6, 2026
@chensuyue chensuyue requested a review from Copilot July 6, 2026 08:46
@chensuyue

Copy link
Copy Markdown
Contributor

/azp run Unit-Test-CUDA-AutoRound

@azure-pipelines

Copy link
Copy Markdown
Azure Pipelines could not run because the pipeline triggers exclude this branch/path.

@chensuyue chensuyue merged commit 5ee45db into intel:main Jul 6, 2026
10 checks passed

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Pull request overview

Note

Copilot couldn't run its full agentic review because no GitHub Actions runner was available. Make sure your repository has a runner available to run Copilot's review, or add a copilot-setup-steps.yml file specifying one with the runs-on attribute. See the docs for more details.

Simplifies the step-by-step rotation documentation in both English and Chinese, and adds a dedicated “Rotation Details” reference including example accuracy results.

Changes:

  • Condensed the Rotation (Experimental) sections in step_by_step.md and step_by_step_CN.md to a short API-focused summary.
  • Added docs/rotation_details.md as an in-depth rotation reference, including configuration details and lm-eval results tables.

Reviewed changes

Copilot reviewed 3 out of 3 changed files in this pull request and generated 2 comments.

File Description
docs/step_by_step.md Replaces the long rotation explanation with a brief usage snippet and a link to the new detailed doc.
docs/step_by_step_CN.md Mirrors the English simplification and links to the new detailed doc (English).
docs/rotation_details.md New detailed rotation reference covering modes/configs, dispatch behavior, and example accuracy results.

Comment thread docs/step_by_step.md
Rotation redistributes outliers in weights and activations before quantization, making the distribution more uniform and quantization-friendly. It is most useful for aggressive low-bit schemes such as MXFP4, NVFP4 and W4A4.

Two rotation approaches are available:
AutoRound applies rotation through the `rotation_config` argument. The `"quarot"` preset — deterministic Hadamard rotation (QuaRot / SpinQuant), no training and no calibration data — is recommended for most use cases.
Comment thread docs/step_by_step_CN.md
旋转在量化前对权重和激活中的离群点进行重分布,使分布更加均匀、对量化更友好。它对 MXFP4、NVFP4、W4A4 等激进的低比特方案最为有效

目前提供两种旋转方式:
AutoRound 通过 `rotation_config` 参数应用旋转。推荐在大多数场景中使用 `"quarot"` 预设——确定性 Hadamard 旋转(QuaRot / SpinQuant),无需训练、无需校准数据。
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.

3 participants