Fix DecodingPress argument names in README#249
Open
fallintoplace wants to merge 1 commit into
Open
Conversation
Signed-off-by: Minh Vu <vuhoangminh97@gmail.com>
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
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.
Summary
DecodingPressREADME examples to use the current constructor argument namescompression_interval,target_size, andhidden_states_buffer_sizeRoot cause
The README examples still used older argument names like
compression_stepsandtoken_buffer_size, while the implementation now expectscompression_interval,target_size, andhidden_states_buffer_size. Copy-pasting the old examples raisedTypeError.Validation
rg -n "compression_steps|token_buffer_size|compression_interval|target_size|hidden_states_buffer_size" README.mdfrom kvpress import DecodingPress, KnormPress, CriticalKVPress, PrefillDecodingPress
DecodingPress(base_press=KnormPress(), compression_interval=10, target_size=512)
PrefillDecodingPress(
prefilling_press=CriticalKVPress(KnormPress()),
decoding_press=DecodingPress(base_press=KnormPress(compression_ratio=0.2), compression_interval=5, target_size=256),
)
print("doc-snippets-ok")
PY`