Chroma Similarity Backend Integration

BigCoop commented 1 week ago

What changes are proposed in this pull request?

builds out an integration to facilitate using chromaDB as a backend for the similarity functionality.

How is this patch tested? If it is not, please explain why.

Trying to do that right now ~ it has passed unit tests on my end but I can't get fiftyone to import the module to utilize some tests from @brimoor .

Release Notes

Is this a user-facing change that should be mentioned in the release notes?

[ ] No. You can skip the rest of this section.
[x] Yes. Give a description of this change to be included in the release notes for FiftyOne users.

(Details in 1-2 sentences. You can just refer to another PR with a description if this PR is part of a larger change.) Chroma can now be used as a backend for the image similarity function.

What areas of FiftyOne does this PR affect?

[ ] App: FiftyOne application changes
[ ] Build: Build and test infrastructure changes
[ ] Core: Core fiftyone Python library changes
[ ] Documentation: FiftyOne documentation changes
[x] Other

Summary by CodeRabbit

New Features
- Introduced support for ChromaDB similarity backend to enable similarity search based on embeddings.
Tests
- Added test cases for image and patch similarity to ensure functionality and robustness.

coderabbitai[bot] commented 1 week ago

Walkthrough

The updates enhance FiftyOne with a new backend called ChromaDB for similarity search. The changes introduce classes and methods to manage configurations, compute similarities, and interact with similarity indexes. Additionally, testing functionalities are integrated to validate image and patch similarity processes.

Changes

File Path	Change Summary
`fiftyone/utils/chroma_fiftyone.py`	Introduced classes and methods for ChromaDB interaction: `ChromaSimilarityConfig`, `ChromaSimilarity`, and `ChromaSimilarityIndex`. Enhanced similarity search within FiftyOne.
`fiftyone/utils/tests_ch.py`	Added test cases (`test_image_similarity_backend`, `test_patch_similarity_backend`) and `dataset` fixture. Enabled testing of ChromaDB similarity functionalities.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant FiftyOne
    participant ChromaSimilarityConfig
    participant ChromaSimilarity
    participant ChromaSimilarityIndex

    User->>FiftyOne: Initialize ChromaDB Similarity
    FiftyOne->>ChromaSimilarityConfig: Load configuration
    ChromaSimilarityConfig->>FiftyOne: Return config object
    FiftyOne->>ChromaSimilarity: Initialize with config
    FiftyOne->>ChromaSimilarityIndex: Create/Manage collection
    User->>FiftyOne: Perform similarity search
    FiftyOne->>ChromaSimilarityIndex: Query collection with embeddings
    ChromaSimilarityIndex->>FiftyOne: Return similarity results
    FiftyOne->>User: Display results

Poem

In fields of code where data roam, A bunny builds a Chroma home. With lines of logic, a search so bright, Finding likeness in pixel light. Backends align, precision prime, Hippity-hop, it's Chroma time! 🐰✨

[!WARNING]

Review ran into problems

Problems (1)
* Git: Failed to clone repository. Please contact CodeRabbit support.

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share

- [X](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)

Tips

### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit .` - `Generate unit testing code for this file.` - `Open a follow-up GitHub issue for this discussion.` - Files and specific lines of code (under the "Files changed" tab): Tag `@coderabbitai` in a new review comment at the desired location with your query. Examples: - `@coderabbitai generate unit testing code for this file.` - `@coderabbitai modularize this function.` - PR comments: Tag `@coderabbitai` in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples: - `@coderabbitai generate interesting stats about this repository and render them as a table.` - `@coderabbitai show all the console.log statements in this repository.` - `@coderabbitai read src/utils.ts and generate unit testing code.` - `@coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.` - `@coderabbitai help me debug CodeRabbit configuration file.` Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. ### CodeRabbit Commands (invoked as PR comments) - `@coderabbitai pause` to pause the reviews on a PR. - `@coderabbitai resume` to resume the paused reviews. - `@coderabbitai review` to trigger an incremental review. This is useful when automatic reviews are disabled for the repository. - `@coderabbitai full review` to do a full review from scratch and review all the files again. - `@coderabbitai summary` to regenerate the summary of the PR. - `@coderabbitai resolve` resolve all the CodeRabbit review comments. - `@coderabbitai configuration` to show the current CodeRabbit configuration for the repository. - `@coderabbitai help` to get help. Additionally, you can add `@coderabbitai ignore` anywhere in the PR description to prevent this PR from being reviewed. ### CodeRabbit Configration File (`.coderabbit.yaml`) - You can programmatically configure CodeRabbit by adding a `.coderabbit.yaml` file to the root of your repository. - Please see the [configuration documentation](https://docs.coderabbit.ai/guides/configure-coderabbit) for more information. - If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: `# yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json` ### Documentation and Community - Visit our [Documentation](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.

BigCoop commented 1 week ago

I don't know where to put the file to have it be imported after I have setup the brain_config.json (as attached). Any advice would be appreciated. brain_config.json

voxel51 / fiftyone