docs(ckpts): Clarify 'quantize' behavior in load_params #502
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Title:
docs(ckpts): Clarify 'quantize' behavior in load_paramsDescription
This PR addresses the TODO at line 277 regarding the
quantizeargument in_checkpoint.py.Currently, the
quantize=Trueargument inload_paramsdoes not perform actual weight quantization (e.g., to int8), but rather restructures the parameters for Quantization Aware Training (QAT). This can be misleading for users expecting immediate weight compression.This change updates the docstring to explicitly state that
quantize=Trueonly enables the QAT structure, improving API clarity and developer experience.Changes
load_paramsdocstring to clarify that actual quantization happens during training, not loading.Related Issue
Refers to:
# TODO(epot): Better API. Currently this do not quantize the weights...