Deprecate archive struct

[joein]

No description provided.

[coderabbitai]

📝 Walkthrough

Walkthrough

The changes introduce a new private boolean attribute and corresponding property to handle a deprecated tar structure flag in model definition classes. This flag is incorporated into both the model description and model management components. In the management logic, an optional parameter is added to relevant retrieval and download methods. The parameter controls how the model name is constructed, prepending a specific prefix when the deprecated tar structure is in use. Additionally, several model source instantiations are updated to include this flag, marking certain models as using the deprecated tar structure. Finally, the package version is updated to reflect these modifications.

---

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 6cda2ce and 5114a94.

📒 Files selected for processing (6)

• fastembed/common/model_description.py (1 hunks)
• fastembed/common/model_management.py (2 hunks)
• fastembed/text/onnx_embedding.py (4 hunks)
• fastembed/text/pooled_embedding.py (1 hunks)
• fastembed/text/pooled_normalized_embedding.py (1 hunks)
• pyproject.toml (1 hunks)

✅ Files skipped from review due to trivial changes (2)

• pyproject.toml
• fastembed/text/pooled_normalized_embedding.py

⏰ Context from checks skipped due to timeout of 90000ms (15)

• GitHub Check: Python 3.13.x on windows-latest test
• GitHub Check: Python 3.13.x on macos-latest test
• GitHub Check: Python 3.13.x on ubuntu-latest test
• GitHub Check: Python 3.12.x on windows-latest test
• GitHub Check: Python 3.12.x on macos-latest test
• GitHub Check: Python 3.12.x on ubuntu-latest test
• GitHub Check: Python 3.11.x on windows-latest test
• GitHub Check: Python 3.11.x on macos-latest test
• GitHub Check: Python 3.11.x on ubuntu-latest test
• GitHub Check: Python 3.10.x on windows-latest test
• GitHub Check: Python 3.10.x on macos-latest test
• GitHub Check: Python 3.10.x on ubuntu-latest test
• GitHub Check: Python 3.9.x on windows-latest test
• GitHub Check: Python 3.9.x on macos-latest test
• GitHub Check: Python 3.9.x on ubuntu-latest test

🔇 Additional comments (8)

fastembed/common/model_description.py (1)

10-14: Good implementation of a backward compatibility flag.

The addition of the _deprecated_tar_struct property with a proper getter method follows good encapsulation practices, making it clear that some models use a deprecated archive structure.

fastembed/common/model_management.py (2)

333-336: Well-structured conditional naming for backward compatibility.

The parameter addition and conditional string formatting logic look good. This allows models marked with the deprecated structure to continue using the "fast-" prefix while newer models can use a different naming convention.

---

442-442: Property correctly used from model sources.

Good job using the property accessor method instead of directly accessing the private attribute.

fastembed/text/onnx_embedding.py (4)

24-24: Model marked as using deprecated tar structure.

This flag identifies that the BAAI/bge-base-en model uses a deprecated archive structure. This is consistent with the PR objectives.

---

40-40: Model marked as using deprecated tar structure.

This flag identifies that the BAAI/bge-base-en-v1.5 model uses a deprecated archive structure.

---

68-68: Model marked as using deprecated tar structure.

This flag identifies that the BAAI/bge-small-en model uses a deprecated archive structure.

---

96-96: Model marked as using deprecated tar structure.

This flag identifies that the BAAI/bge-small-zh-v1.5 model uses a deprecated archive structure.

fastembed/text/pooled_embedding.py (1)

85-85: Model marked as using deprecated tar structure.

This flag identifies that the intfloat/multilingual-e5-large model uses a deprecated archive structure, consistent with the changes in other files.

✨ Finishing Touches

• 📝 Generate Docstrings

---

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • 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 gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @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 using 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 generate docstrings to generate docstrings for this 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.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration 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 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 for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.