Fix quantization option comments in base.yml #2594
Open
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Fixed incorrect quantization option names and descriptions in the inline comments of
src/MaxText/configs/base.ymlto match the actual implementation in the codebase.The comments previously contained incorrect option names and misleading descriptions that didn't align with the valid options defined in pyconfig.py and implemented in quantizations.py.
Why this change is being made
Users relying on these inline comments could:
'nanoo_fp8'(which doesn't exist) instead of the correct'fp8_nanoo', leading to validation errors'fp8'is NVIDIA GPU-specific, when the actual GPU-optimized option is'fp8_gpu''fp8_gpu'option entirely since it wasn't documentedChanges made
'nanoo_fp8'→'fp8_nanoo'to match code'fp8_gpu'for NVIDIA GPU-specific quantization'int8': "dynamic range quantization using 8-bits" → "8-bit integer quantization"'fp8': removed "on NVIDIA GPUs" as it's the generic FP8 option'fp8_gpu'and'fp8_nanoo'Why this is a good solution
The comments now serve as accurate inline documentation that matches:
valid_quant_methodstuple inpyconfig.pyquantizations.pydocs/explanations/quantization.mdThis ensures consistency across all documentation sources and prevents user confusion.
Implementation
This is purely a documentation change - no code logic was modified. Only the inline comments in
base.ymlwere updated.FIXES: #2593
Tests
This change only modifies inline comments in the YAML configuration file and does not affect code functionality. Testing performed:
valid_quant_methods = ("", "int8", "fp8", "fp8_full", "fp8_gpu", "fp8_nanoo")To verify the documentation accuracy:
Checklist
Before submitting this PR, please make sure (put X in square brackets):
gemini-reviewlabel.