Skip to content

Default to Qwen3 in README.md and docs/ examples #641

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 4 commits into from
Jun 16, 2025

Conversation

alvarobartt
Copy link
Member

What does this PR do?

This PR updates the default --model-id value showed within the example in the README.md and the docs/ so as to point to the recently released and integrated Qwen/Qwen3-Embedding-0.6B (from the Qwen3-Embedding collection), due to its small size compared to other more performant alternatives, making it available on CPU, MPS and GPUs seamlessly, and with an MTEB mean score of 64.33 way above other alternatives with bigger or the same size.

Additionally, this PR also aligns the "Supported models" tables in the README.md and in docs/source/en/supported_models.md to show the same content.

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

Narsil
Narsil previously approved these changes Jun 16, 2025
Copy link
Collaborator

@Narsil Narsil left a comment

Choose a reason for hiding this comment

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

LGTM

@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.

@Narsil Narsil merged commit d1d65cf into main Jun 16, 2025
3 checks passed
@Narsil Narsil deleted the update-readme-instructions branch June 16, 2025 19:50
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants