Skip to content

Update README.md and supported_models.md #572

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

Merged
merged 1 commit into from
Apr 9, 2025
Merged

Conversation

alvarobartt
Copy link
Member

What does this PR do?

This PR updates the README.md to update the references to the ghcr.io/huggingface/text-embeddings-inference container to the latest i.e. 1.7, as well as fixing the table ordering. After that, then the docs/source/en/supported_models.md file has been updated accordingly in order to be aligned with the README.md since it was outdated and pointing to outdated revision branches for the re-rankers, and not aligned with the README.md.

Before submitting

  • This PR fixes a typo or improves the docs (you can dismiss the other checks if that's the case).
  • Did you read the contributor guideline, Pull Request section?
  • Was this discussed/approved via a GitHub issue or the forum? Please add a link to it if that's the case.
  • Did you make sure to update the documentation with your changes? Here are the documentation guidelines, and here are tips on formatting docstrings.
  • Did you write any new necessary tests?

Who can review?

@Narsil or @McPatate

@alvarobartt alvarobartt added the documentation Improvements or additions to documentation label Apr 9, 2025
@HuggingFaceDocBuilderDev

The docs for this PR live here. All of your documentation changes will be reflected on that endpoint. The docs are available until 30 days after the last update.

@CoolFish88
Copy link

CoolFish88 commented Apr 9, 2025

Hello,

Are jina reranker models supported? While I didn't see them being mentioned in the updated documents listing supported models, I noticed there are tickets referencing attempts to deploy these models.

@alvarobartt
Copy link
Member Author

Hello,

Are jina reranker models supported? While I didn't see them being mentioned in the updated documents listing supported models, I noticed there are tickets referencing attempts to deploy these models.

Hey @CoolFish88, indeed those are, let me revisit the list of supported models there, as those have the JinaBERT architecture, but apparently jinaai/jina-reranker-v1-turbo-en is failing, which I'm reviewing at the moment! 🤗

Copy link
Member

@McPatate McPatate left a comment

Choose a reason for hiding this comment

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

👌🏻

@Narsil Narsil merged commit dbf19a9 into main Apr 9, 2025
3 checks passed
@Narsil Narsil deleted the update-documentation branch April 9, 2025 14:44
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants