feat: Add options for what to do with missing metadata fields in MetaFieldRanker
#7700
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
…o metf_optionality
github-actions
bot
added
topic:tests
type:documentation
Pull Request Test Coverage Report for Build 9400372854Details
💛 - Coveralls |
robpasternak
requested review from
dfokina and
shadeMe
and removed request for
a team
shadeMe
requested changes
Jun 4, 2024
| @@ -43,6 +43,7 @@ def __init__( | |||
| top_k: Optional[int] = None, | |||
| ranking_mode: Literal["reciprocal_rank_fusion", "linear_score"] = "reciprocal_rank_fusion", | |||
| sort_order: Literal["ascending", "descending"] = "descending", | |||
| missing_meta: Literal["drop", "top", "bottom"] = "bottom", | |||
There was a problem hiding this comment.
Hmm, I'd want to convert the Literal init parameters to follow the enum pattern seen in other parts of the library (c.f HFGenerationAPIType and HuggingFaceAPIGenerator).
Would you be up to fixing that in a follow-up PR? This would also mean that the validation code gets changed/moved around.
Comment on lines
+70
to
+76
| What to do with documents that are missing the sorting metadata field. | ||
| Possible values are: | ||
| - 'drop' will drop the documents entirely. | ||
| - 'top' will place the documents at the top of the metadata-sorted list | ||
| (regardless of 'ascending' or 'descending'). | ||
| - 'bottom' will place the documents at the bottom of metadata-sorted list | ||
| (regardless of 'ascending' or 'descending'). |
There was a problem hiding this comment.
Once we introduce the enum, the bulk of this docstring can be moved to the corresponding docstrings of the former.
| ) | ||
| if missing_meta == "bottom": | ||
| logger.warning( | ||
| "The parameter <meta_field> is currently set to '{meta_field}' but the Documents with IDs {document_ids} don't have this meta key.\n" |
There was a problem hiding this comment.
Looks like this string can be extracted into a variable and reused in all three warnings?
| sorted_documents = self._merge_rankings(documents, sorted_documents, weight, ranking_mode) | ||
| if missing_meta == "bottom": | ||
| sorted_documents = sorted_by_meta + docs_missing_meta_field | ||
| sorted_documents = self._merge_rankings(documents, sorted_documents, weight, ranking_mode) |
There was a problem hiding this comment.
This statement can also be moved outside the if..elif..else clause.
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.
Related Issues
MetaFieldRanker: allow different options for what to do with missing metadata field #7691missing_metatoMetaFieldRanker:Proposed Changes:
missing_metaparam has three options:"bottom","top", and"drop"."bottom"exhibits the same behavior as was implemented prior to this PR, i.e., documents without the sorting metadata field are put on the bottom of the sorted list."top"puts them at the top instead."drop"drops such documents entirely.missing_metais legit.How did you test it?
Wrote and tried new tests functions in the
testdirectory:test_raises_value_error_if_wrong_missing_meta: Tests validation ofmissing_metatest_missing_meta_bottom: Tests thatmissing_meta = "bottom"behaves as desired.test_missing_meta_top: Tests thatmissing_meta = "top"behaves as desired.test_missing_meta_drop: Tests thatmissing_meta = "drop"behaves as desired.Notes for the reviewer
None
Checklist
fix:,feat:,build:,chore:,ci:,docs:,style:,refactor:,perf:,test:.