Add note about using text_similarity task for rerank to the import model CLI #716
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
davidkyle
added
enhancement
miguelgrinberg
approved these changes
Aug 12, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
As reported in #712 several people have tried to use
--task-type rerankto upload a reranking model to Elasticsearch where--task-type text_similarityshould be used. This change adds a message toeland_import_hub_modelhelp to use--task-type text_similarityfor reranking and adds the same information to the error message produced when the--task-typeargument fails validation.There isn't a straight forward extension point to change the error message produced by ArgParse when the argument as a set of valid choices. Catching and checking the
ArgumentErroris the best option I could see.Closes #712