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

[CLN] Cleanup codebase with the refactored metadata filtering pipeline #2849

Conversation

Sicheng-Pan
Copy link
Contributor

@Sicheng-Pan Sicheng-Pan commented Sep 24, 2024

Description of changes

Summarize the changes made by this PR.

  • Improvements & Bug fixes
    • Address all breaking changes in the previous PRs.
  • New functionality
    • N/A

Test plan

How are these changes tested?

The existing tests should pass

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

@Sicheng-Pan Sicheng-Pan marked this pull request as ready for review September 24, 2024 23:30
@Sicheng-Pan Sicheng-Pan force-pushed the 09-24-_cln_refactor_mergemetadataresultsoperator_ branch from 90b6d82 to 25b4e7a Compare September 25, 2024 01:02
@Sicheng-Pan Sicheng-Pan force-pushed the 09-24-_cln_cleanup_codebase_with_the_refactored_metadata_filtering_pipeline branch from 034df37 to 61bd467 Compare September 25, 2024 01:02
@Sicheng-Pan Sicheng-Pan force-pushed the 09-24-_cln_refactor_mergemetadataresultsoperator_ branch from 25b4e7a to 19d282c Compare September 25, 2024 18:40
@Sicheng-Pan Sicheng-Pan force-pushed the 09-24-_cln_cleanup_codebase_with_the_refactored_metadata_filtering_pipeline branch from 61bd467 to 20da0c5 Compare September 25, 2024 18:40
@Sicheng-Pan Sicheng-Pan force-pushed the 09-24-_cln_refactor_mergemetadataresultsoperator_ branch from 19d282c to b0ea68d Compare September 25, 2024 18:48
@Sicheng-Pan Sicheng-Pan force-pushed the 09-24-_cln_cleanup_codebase_with_the_refactored_metadata_filtering_pipeline branch from 20da0c5 to 936d0f6 Compare September 25, 2024 18:48
@Sicheng-Pan Sicheng-Pan force-pushed the 09-24-_cln_refactor_mergemetadataresultsoperator_ branch from b0ea68d to e5c7aec Compare September 25, 2024 19:25
@Sicheng-Pan Sicheng-Pan force-pushed the 09-24-_cln_cleanup_codebase_with_the_refactored_metadata_filtering_pipeline branch from 936d0f6 to 4f86f02 Compare September 25, 2024 19:25
@Sicheng-Pan Sicheng-Pan force-pushed the 09-24-_cln_refactor_mergemetadataresultsoperator_ branch from e5c7aec to 0f4d278 Compare September 26, 2024 22:12
@Sicheng-Pan Sicheng-Pan force-pushed the 09-24-_cln_cleanup_codebase_with_the_refactored_metadata_filtering_pipeline branch from 4f86f02 to eecff23 Compare September 26, 2024 22:13
}

// DEPRECATED: This exists only for the legacy testing. Please checkout `MetadataFilteringOperator` for the up to date implementation.
Copy link
Contributor

Choose a reason for hiding this comment

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

curious, why did we not remove it? Is it just more work or are there other considerations?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Simply because there's a lot unit tests depending on this and I'm not planning to refactor them altogether in this stack of PRs.

@@ -1164,10 +1164,11 @@ impl MetadataSegmentReader<'_> {
})
}

// DEPRECATED: This exists only for the legacy testing. Please checkout `MetadataFilteringOperator` for the up to date implementation.
pub async fn query(
Copy link
Contributor

Choose a reason for hiding this comment

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

curious, why did we not remove it? Is it just more work or are there other considerations?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

See above

@Sicheng-Pan Sicheng-Pan force-pushed the 09-24-_cln_refactor_mergemetadataresultsoperator_ branch from 0f4d278 to 5135e49 Compare September 30, 2024 22:56
@Sicheng-Pan Sicheng-Pan force-pushed the 09-24-_cln_cleanup_codebase_with_the_refactored_metadata_filtering_pipeline branch from 696d0ad to 95af42d Compare September 30, 2024 22:56
Copy link
Contributor Author

Sicheng-Pan commented Sep 30, 2024

Merge activity

  • Sep 30, 7:32 PM EDT: @Sicheng-Pan started a stack merge that includes this pull request via Graphite.
  • Sep 30, 7:40 PM EDT: Graphite rebased this pull request as part of a merge.
  • Sep 30, 7:41 PM EDT: @Sicheng-Pan merged this pull request with Graphite.

@Sicheng-Pan Sicheng-Pan changed the base branch from 09-24-_cln_refactor_mergemetadataresultsoperator_ to graphite-base/2849 September 30, 2024 23:36
@Sicheng-Pan Sicheng-Pan changed the base branch from graphite-base/2849 to main September 30, 2024 23:38
Sicheng Pan and others added 6 commits September 30, 2024 23:39
*Summarize the changes made by this PR.*
- Clean up warnings under rust/types.

*How are these changes tested?*
- `cargo clippy --all-targets`

- [ ] Tests pass locally with `pytest` for python, `yarn test` for js,
`cargo test` for rust

*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)?*
*Summarize the changes made by this PR.*
 - Improvements & Bug fixes
- This switches to `debug_struct` over `f.write` as per @rescrv's
suggestion.
	 - Fixes a spurious warning about an unused struct field
 - New functionality
	 - None

*How are these changes tested?*
We do not test the debug behavior.
- [x] Tests pass locally with `pytest` for python, `yarn test` for js,
`cargo test` for rust

None
…2858)

## Description of changes

*Summarize the changes made by this PR.*
- Clean up warnings under rust/types.

## Test plan
*How are these changes tested?*
- `cargo clippy --all-targets`

- [ ] 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)?*
rescrv and others added 5 commits September 30, 2024 23:39
*Summarize the changes made by this PR.*
 - clean up cache, distance, index, storage clippy warnings

*How are these changes tested?*
- cargo clippy locally

- [ ] Tests pass locally with `pytest` for python, `yarn test` for js,
`cargo test` for rust

*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)?*
Left some of worker untouched for concurrent PRs.

*Summarize the changes made by this PR.*
 - Cleans up warnings.

*How are these changes tested?*

- [ ] cargo clippy && cargo test w/ tilt up.

*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)?*
@Sicheng-Pan Sicheng-Pan force-pushed the 09-24-_cln_cleanup_codebase_with_the_refactored_metadata_filtering_pipeline branch from 200ce7f to 57505da Compare September 30, 2024 23:39
@Sicheng-Pan Sicheng-Pan merged commit 14b11e4 into main Sep 30, 2024
69 checks passed
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.

5 participants