Document existing TurboQuant types#8053
Merged
Merged
Conversation
Merging this PR will improve performance by 19.8%
|
| Mode | Benchmark | BASE |
HEAD |
Efficiency | |
|---|---|---|---|---|---|
| ⚡ | Simulation | chunked_varbinview_opt_canonical_into[(1000, 10)] |
225.2 µs | 188 µs | +19.8% |
Tip
Curious why this is faster? Comment @codspeedbot explain why this is faster on this PR, or directly use the CodSpeed MCP with your agent.
Comparing ct/tq-docs (70e6a90) with develop (1a5079b)
Doc-comment pass over the parts of vortex-turboquant that don't depend on the in-flight inv_direction_norms work: SplitMix64, the vector module, DecodeInputs's pre-existing fields, TurboQuant + TurboQuantMetadata + their fields, the TurboQuantMetadataProto wire-format note, validate_tq_metadata, validate_tq_storage_dtype, and the TurboQuantParsedStorage struct + existing fields. No semantic change. Signed-off-by: Connor Tsui <connor.tsui20@gmail.com>
robert3005
approved these changes
May 22, 2026
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
2 participants
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
Tracking issue: #7830
Adds a lot more documentation for the TurboQuant implementation (since in hindsight there are a lot of things that might not be obvious).
Testing
N/A