-
Notifications
You must be signed in to change notification settings - Fork 419
Open
Labels
documentationImprovements or additions to documentationImprovements or additions to documentation
Description
Documentation
URL or Section:
src/MaxText/configs/base.yml(lines 91-98)src/MaxText/pyconfig.py(line 287)src/MaxText/layers/quantizations.py(lines 642-692)docs/explanations/quantization.md(lines 51-56)
Describe the problem:
The inline comments in base.yml documenting the quantization config option contain incorrect option names that don't match the actual implementation in the codebase. This could cause users to use invalid configuration values.
Issues found:
-
CRITICAL - Wrong option name:
base.ymldocumented'nanoo_fp8'- Actual valid option in code:
'fp8_nanoo'(seepyconfig.pyline 287 andquantizations.pyline 682) - Users following the comments would use an invalid option that doesn't exist!
-
Missing option:
base.ymldid not mention'fp8_gpu'- This option exists in
pyconfig.pyvalid_quant_methods (line 287) and has implementation inquantizations.py(line 673)
-
Misleading descriptions:
base.ymldescribed'fp8'as "for 8-bit floating-point GeMMs on NVIDIA GPUs"- But
'fp8_gpu'is the actual NVIDIA-specific option 'fp8'is the generic 8-bit floating-point quantization
-
Inconsistency across documentation sources:
pyconfig.py: defines valid options as("", "int8", "fp8", "fp8_full", "fp8_gpu", "fp8_nanoo")quantizations.py: implements all these options in the case statementquantization.md: documents some of these optionsbase.yml: had different names and missing options
Expected behavior:
The comments in base.yml should exactly match:
- The valid option names defined in
pyconfig.py - The case statements implemented in
quantizations.py - The documentation in
quantization.md
Impact:
- Users following the
base.ymlcomments might try to use'nanoo_fp8'which would fail validation, causing confusion and errors - Misleading description like "fp8 is for GPU" could cause users to incorrectly choose
'fp8'when they specifically need GPU optimization ('fp8_gpu'), or vice versa, leading to suboptimal performance or unexpected behavior
Additional Context
AI GDE / Kakao
Metadata
Metadata
Assignees
Labels
documentationImprovements or additions to documentationImprovements or additions to documentation