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

[PERF]: pipeline segment committing/flushing #3163

Closed

Conversation

codetheweb
Copy link
Contributor

@codetheweb codetheweb commented Nov 19, 2024

Description of changes

This introduces two new operators that allow committing and flushing individual segments. This enables pipelining across all segment types.

Some changes in service of this:

  • write_to_blockfiles() is renamed to a generic finish() method on the SegmentWriter trait.
  • There is an enum over all segment writer and flusher types to allow for enum dispatch.
  • Flushers are now clonable because .flush() consumes self but operators receive &input. I don't love this, I think the alternative is allowing operators to consume the input.
  • Tasks for each segment are grouped together under the same span.

An example trace (with two partitions):

Screen.Recording.2024-11-20.at.5.09.37.PM.mov

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

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

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
Contributor Author

codetheweb commented Nov 19, 2024

Warning

This pull request is not mergeable via GitHub because a downstack PR is open. Once all requirements are satisfied, merge this PR as a stack on Graphite.
Learn more

This stack of pull requests is managed by Graphite. Learn more about stacking.

@codetheweb codetheweb changed the title Add finish() to SegmentWriter (== write_to_blockfile()) [PERF]: pipeline segment committing/flushing Nov 19, 2024
@codetheweb codetheweb force-pushed the perf-parallelize-applying-log branch from 7be9113 to cffe2a3 Compare November 20, 2024 23:01
@codetheweb codetheweb force-pushed the feat-pipeline-flushing branch from 9c5a117 to 5be9243 Compare November 20, 2024 23:01
@codetheweb codetheweb force-pushed the perf-parallelize-applying-log branch from e696cd7 to 851511a Compare November 20, 2024 23:12
@codetheweb codetheweb force-pushed the feat-pipeline-flushing branch 6 times, most recently from da5e9e4 to ae2797b Compare November 21, 2024 00:24
@codetheweb codetheweb marked this pull request as ready for review November 21, 2024 01:11
@codetheweb codetheweb force-pushed the perf-parallelize-applying-log branch from 92a0f28 to f8ab4ac Compare November 21, 2024 18:32
@codetheweb codetheweb force-pushed the feat-pipeline-flushing branch from ae2797b to 34410cd Compare November 21, 2024 18:32
@codetheweb codetheweb requested a review from HammadB November 25, 2024 19:43
@codetheweb
Copy link
Contributor Author

Superseded by #3360. Creating a new branch was easier than rebasing as the approach changed slightly.

@codetheweb codetheweb closed this Dec 27, 2024
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