Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[ENH]: better ordered writer block splitting #3177

Draft
wants to merge 4 commits into
base: main
Choose a base branch
from

Conversation

codetheweb
Copy link
Contributor

Description of changes

These changes result in fuller blocks when using ordered writing mode, leading to less fragmentation and slightly better writing performance depending on the write pattern:

Screenshot 2024-11-12 at 5 51 14 PM

Test plan

How are these changes tested?

  • Tests pass locally with pytest for python, yarn test for js, cargo test for rust

Documentation Changes

Are all docstrings for user-facing APIs updated if required? Do we need to make documentation changes in the docs repository?

n/a

Copy link

Reviewer Checklist

Please leverage this checklist to ensure your code review is thorough before approving

Testing, Bugs, Errors, Logs, Documentation

  • Can you think of any use case in which the code does not behave as intended? Have they been tested?
  • Can you think of any inputs or external events that could break the code? Is user input validated and safe? Have they been tested?
  • If appropriate, are there adequate property based tests?
  • If appropriate, are there adequate unit tests?
  • Should any logging, debugging, tracing information be added or removed?
  • Are error messages user-friendly?
  • Have all documentation changes needed been made?
  • Have all non-obvious changes been commented?

System Compatibility

  • Are there any potential impacts on other parts of the system or backward compatibility?
  • Does this change intersect with any items on our roadmap, and if so, is there a plan for fitting them together?

Quality

  • Is this code of a unexpectedly high quality (Readability, Modularity, Intuitiveness)

Copy link

Please tag your PR title with one of: [ENH | BUG | DOC | TST | BLD | PERF | TYP | CLN | CHORE]. See https://docs.trychroma.com/contributing#contributing-code-and-ideas

Copy link

github-actions bot commented Jan 6, 2025

Please tag your PR title with one of: [ENH | BUG | DOC | TST | BLD | PERF | TYP | CLN | CHORE]. See https://docs.trychroma.com/contributing#contributing-code-and-ideas

Copy link

Please tag your PR title with one of: [ENH | BUG | DOC | TST | BLD | PERF | TYP | CLN | CHORE]. See https://docs.trychroma.com/contributing#contributing-code-and-ideas

@codetheweb codetheweb changed the title [FEAT]: better ordered writer block splitting [ENH]: better ordered writer block splitting Jan 21, 2025
@codetheweb codetheweb force-pushed the revert-3174-revert-3128-feat-better-ordered-writer-block-splitting branch from 33b6b42 to 82ebeae Compare January 21, 2025 18:54
@codetheweb codetheweb force-pushed the revert-3174-revert-3128-feat-better-ordered-writer-block-splitting branch from 82ebeae to 5e2a058 Compare January 21, 2025 19:23
@@ -316,7 +316,8 @@ impl ArrowOrderedBlockfileWriter {
.current_block_delta
.take()
.expect("We already checked above that there is a current delta");
let new_delta = current_delta.split_off_half::<K, V>();

let new_delta = current_delta.split_off_last_key().expect("This returns None only if the delta is empty. We just added to the delta, so it is not empty.");
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is the main change. Since the ordered writer writes keys in strictly increasing order, we can always split deltas at the last key instead of splitting them at their midpoint. This results in full blocks (rather than half-sized blocks) and better performance.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant