raises ValueError when num_label !=1 when using Crossencoder.rank() #3126
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
tomaarsen
reviewed
Dec 10, 2024
| @@ -527,6 +527,8 @@ def rank( | |||
| 'score': -5.082967, | |||
| 'text': "The 'Harry Potter' series, which consists of seven fantasy novels written by British author J.K. Rowling, is among the most popular and critically acclaimed books of the modern era."}] | |||
| """ | |||
| if self.config.num_labels != 1: | |||
| raise ValueError("CrossEncoder.rank() only works for models with num_labels=1.") | |||
There was a problem hiding this comment.
Nice!
What do you think, should we maybe also refer people to CrossEncoder.predict()?
Something like:
Suggested change
| raise ValueError("CrossEncoder.rank() only works for models with num_labels=1.") | |
| raise ValueError( | |
| "CrossEncoder.rank() only works for models with num_labels=1. " | |
| "Consider using CrossEncoder.predict() with input pairs instead." | |
| ) |
Otherwise people might just stop using Sentence Transformers altogether when CrossEncoder.rank fails.
|
I like it! Well done - I appreciate it.
|
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.
Raises ValueError when num_label !=1 when using Crossencoder.rank()
Fixes #3124
Who can review?
@tomaarsen