search

Anush008 / fastembed-rs

Library for generating vector embeddings, reranking in Rust
https://docs.rs/fastembed
Apache License 2.0
264 stars 36 forks source link

feat: Support jinaai/jina-reranker-v1-turbo-en #76

Closed jawj closed 3 months ago

jawj commented 3 months ago

Per #75, I've had a go at adding this in. I tried to follow the same format as is used for embedding models (though there is a certain amount of repetition involved in this).

A breaking change is that I renamed UserDefinedEmbeddingModel to UserDefinedModel, because it can cover user-defined models for both embedding and reranking. For backwards compatibility you may want to add an alias?

Summary by CodeRabbit

coderabbitai[bot] commented 3 months ago

Walkthrough

The updates introduce a new reranking model (jinaai/jina-reranker-v1-turbo-en) and enhance support for user-defined models by consolidating UserDefinedEmbeddingModel into UserDefinedModel. Additionally, new structs (UserDefinedModel and TokenizerFiles) are added, improving the flexibility and initialization of user-defined models and tokenizers.

Changes

Files Change Summaries
src/tests.rs Updated import statements and renamed UserDefinedEmbeddingModel to UserDefinedModel.
README.md Added documentation for a new reranking model: jinaai/jina-reranker-v1-turbo-en.
src/common.rs Added new structs UserDefinedModel and TokenizerFiles.
src/lib.rs Updated public exports and modified imports in the text_embedding module.
src/models/reranking.rs Added JINARerankerV1TurboEn variant to RerankingModel enum and updated reranker_model_list.
src/reranking.rs Introduced RerankInitOptionsUserDefined struct and methods for user-defined reranker models.
src/text_embedding.rs Consolidated UserDefinedEmbeddingModel into UserDefinedModel and adjusted related functions.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant System
    participant ModelLoader
    participant TokenizerLoader

    User->>System: Provide UserDefinedModel and TokenizerFiles
    System->>ModelLoader: Load UserDefinedModel
    ModelLoader-->>System: Loaded Model
    System->>TokenizerLoader: Load TokenizerFiles
    TokenizerLoader-->>System: Loaded TokenizerFiles
    System->>User: Initialization Complete
sequenceDiagram
    participant User
    participant System
    participant RerankModelLoader

    User->>System: Request new reranker model (jinaai/jina-reranker-v1-turbo-en)
    System->>RerankModelLoader: Load JINARerankerV1TurboEn model
    RerankModelLoader-->>System: Loaded JINARerankerV1TurboEn model
    System->>User: Reranker Initialization Complete

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.
Anush008 commented 3 months ago

A breaking change is that I renamed UserDefinedEmbeddingModel to UserDefinedModel

We can't break unless it's a major version release. Some frameworks use this lib. https://github.com/Abraxas-365/langchain-rust/blob/806fa8122104991c203d9fa9a52e3b5478e26cc0/Cargo.toml#L53

Please add a new struct for user-defined rerankers. I'd even recommend, keeping this PR for the new Jina model. A separate PR for user-defined rerankers.

jawj commented 3 months ago

OK, this PR now only adds the reranking model.

Anush008 commented 3 months ago

Could you add the model to https://github.com/jawj/fastembed-rs/blob/eead92e13b3e753876d6e2c33b7b465e741fb5ca/src/tests.rs#L134-L156? To ensure its working?

It can be this iterative pattern. https://github.com/jawj/fastembed-rs/blob/eead92e13b3e753876d6e2c33b7b465e741fb5ca/src%2Ftests.rs#L12-L39

Anush008 commented 3 months ago

Looks like a6ec27(#76) unintentionally added the user-defined model changes back.

jawj commented 3 months ago

The test workflow appears to have failed but it's not obvious to me why.

Anush008 commented 3 months ago

P.S. Would you like to list this model in the README.md?

github-actions[bot] commented 3 months ago

:tada: This issue has been resolved in version 3.8.0 :tada:

The release is available on:

Your semantic-release bot :package::rocket: