search

Anush008 / fastembed-rs

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

feat: User defined reranking #77

Closed jawj closed 4 months ago

jawj commented 4 months ago

As previously discussed in #75, these changes allow a user-defined reranking model, similar to user-defined embedding models.

Summary by CodeRabbit

coderabbitai[bot] commented 4 months ago

Walkthrough

The recent update introduces support for custom user-defined models within the Rust project, specifically focusing on tokenizer files and reranking models. It adds new structs, enums, and methods to handle user-defined text embedding and reranking models, enabling users to load raw .onnx files with additional configuration parameters. Furthermore, a new RerankerModel variant and expanded public entity declarations enhance the flexibility and functionality of the text processing capabilities.

Changes

File(s) Change Summary
src/common.rs Added TokenizerFiles struct to manage tokenizer files.
src/lib.rs Expanded public entities, including TokenizerFiles and UserDefinedRerankingModel.
src/models/reranking.rs Introduced JINARerankerV1TurboEn variant to RerankerModel and updated reranker_model_list function.
src/reranking.rs Added new structs and methods for initializing and using user-defined reranking models.
src/tests.rs Added entities for user-defined reranking models and updated tests.
src/text_embedding.rs Integrated TokenizerFiles into UserDefinedEmbeddingModel struct.
Cargo.toml Added George MacKerron as an author.
README.md Documented new features for loading user-defined text embedding and reranking models.

Sequence Diagrams

Loading a User-Defined Reranking Model

sequenceDiagram
    participant User
    participant TextRerank
    participant UserDefinedRerankingModel
    participant RerankInitOptionsUserDefined

    User->>TextRerank: try_new_from_user_defined(model, options)
    activate TextRerank
    TextRerank->>UserDefinedRerankingModel: Load model files
    TextRerank->>RerankInitOptionsUserDefined: Initialize options
    TextRerank-->>User: User-defined reranking model instance created
    deactivate TextRerank

Loading a User-Defined Embedding Model

sequenceDiagram
    participant User
    participant TextEmbedding
    participant UserDefinedEmbeddingModel
    participant InitOptionsUserDefined

    User->>TextEmbedding: try_new_from_user_defined(model, options)
    activate TextEmbedding
    TextEmbedding->>UserDefinedEmbeddingModel: Load model files
    TextEmbedding->>InitOptionsUserDefined: Initialize options
    TextEmbedding-->>User: User-defined embedding model instance created
    deactivate TextEmbedding

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.
jawj commented 4 months ago

@Anush008 I'm not clear why GitHub thinks there's a conflict here: the start of the incoming change is identical to the existing code that it claims conflicts.

Please take a look and then perhaps you can resolve this in favour of the incoming code?

Anush008 commented 4 months ago

Also, please feel free to add yourself to the authors list in the Cargo.toml file.

github-actions[bot] commented 4 months ago

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

The release is available on:

Your semantic-release bot :package::rocket:

Anush008 commented 4 months ago

I just realised, the README example looks a little terrifying but also cool. LOL 😆