Skip to content

Remove default --model-id argument #679

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

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

alvarobartt
Copy link
Member

What does this PR do?

This PR removes the default value for the --model-id in the clap CLI i.e., the entrypoint for Text Embeddings Inference (TEI), to prevent cases where the model is not captured correctly from e.g. an environment variable, and the BAAI/bge-large-en-v1.5 model is served instead without specific definition from the user, which can be misleading / confusing in some scenarios.

Note

Since this PR represents somehow a "breaking change", the PR should be released within a minor version i.e., 1.8.0 if within the next release.

What's missing?

  • Once the PR is approved, update the --help outputs over the documentation and the README.md so that those are consistent with the latest CLI.

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

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.

1 participant