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] Add include metadata to MetadataReader to avoid unncessary payload size #2750

Merged
merged 3 commits into from
Aug 30, 2024

Conversation

HammadB
Copy link
Collaborator

@HammadB HammadB commented Aug 30, 2024

Description of changes

Summarize the changes made by this PR.

  • Improvements & Bug fixes
    • This PR introduces a "include_metadata" field to the MetadataReader across the local and distributed implementations. This way the filter step can only transmit ids, and only final hydration requests all data. This reduces overall payload sizes.
    • I chose this pattern to mirror what is done by the VectorReader with the "include_embeddings" flag
    • The correct solution for this is push the query down to one node instead of roundtripping.
  • New functionality
    • None

Test plan

How are these changes tested?
I extended the tests for the metadata segment

  • 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?

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)

@sanketkedia sanketkedia merged commit 50459a0 into main Aug 30, 2024
67 checks passed
spikechroma pushed a commit that referenced this pull request Sep 12, 2024
…load size (#2750)

## Description of changes

*Summarize the changes made by this PR.*
 - Improvements & Bug fixes
- This PR introduces a "include_metadata" field to the MetadataReader
across the local and distributed implementations. This way the filter
step can only transmit ids, and only final hydration requests all data.
This reduces overall payload sizes.
- I chose this pattern to mirror what is done by the VectorReader with
the "include_embeddings" flag
- The correct solution for this is push the query down to one node
instead of roundtripping.
 - New functionality
	 - None

## Test plan
*How are these changes tested?*
I extended the tests for the metadata segment
- [x] 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](https:/chroma-core/docs)?*

---------

Co-authored-by: Sanket Kedia <[email protected]>
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.

2 participants