pytorch / pytorch/ao

Stale MXFP4 training entry in workflow documentation

Open Beginner friendly
#4,841 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Python
Stars
3k
Forks
627
Avg merge
4d 14h
Merged PRs (30d)
34

Description

Documentation mismatch

As a torchao user comparing release/0.16.0 and release/0.18.0, I noticed that the MXFP4 table in docs/source/workflows/training.md still contains descriptions from the former general MX training workflow:

  • MXFP4 training for torch.nn.Linear is shown as available.
  • MXFP4 QAT is shown as planned.
  • Enabling MXFP4 QAT is listed as a planned improvement.

These entries do not match the current source:

  • In 0.16, MXLinearConfig exposed the MXFP4_EMULATED and MXFP4_CUTLASS training recipes.
  • #3968 removed MXLinearConfig, MXLinear, and the corresponding training tests.
  • The current low-precision MX training configuration and linear path are MXFP8-specific.
  • The current MXFP4 workflows are inference and QAT. MXFP4 QAT is implemented in torchao.prototype.qat.mx and covered by forward/backward tests.

The same stale table is present in release/0.18.0 and the current main branch.

Proposed documentation correction

  • Remove the obsolete MXFP4 quantized-training row.
  • Update MXFP4 QAT from planned to its current prototype status.
  • Remove the obsolete planned-improvement item about enabling MXFP4 QAT.

This is a documentation-only correction and does not propose adding or removing any runtime functionality.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Open docs/source/workflows/training.md and compare the MXFP4 table with the current MX training configuration and the MXFP4 implementation in torchao.prototype.qat.mx. Remove the obsolete quantized-training and planned-improvement entries, and mark MXFP4 QAT as implemented prototype functionality consistent with the referenced forward/backward tests.

Written by the indexing model from the issue text.

Assessment

Tech stack
python, pytorch
Domain
documentation, machine-learning
Issue type
Documentation
Difficulty
1/5
Estimated time
Under an hour
Activity status
Active
Clarity
Clearly specified
Newbie friendliness
92/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.