[V2] Update v2 #1618
Merged
[V2] Update v2 #1618
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
* feat: add new arctic v2.0 models * chore: make lint
* Add dataset class and file requirements * pass tests * make lint changes * adjust meta data and remove load_data --------- Co-authored-by: Omar Elshehy <omarelshehy@Omars-MacBook-Pro.local>
* fix SouthAfricanLangClassification.py * add check for langs * lint
* feat: add max_sim operator for IR tasks to support multi-vector models * docs: add doc for Model2VecWrapper.__init__(...) * feat: add ColBERTWrapper to models & add ColBERTv2 * fix: resolve issues * fix: resolve issues * Update README.md Co-authored-by: Roman Solomatin <samoed.roman@gmail.com> * Update README.md Co-authored-by: Isaac Chung <chungisaac1217@gmail.com> * Update README.md Co-authored-by: Isaac Chung <chungisaac1217@gmail.com> * Update mteb/evaluation/evaluators/RetrievalEvaluator.py Co-authored-by: Isaac Chung <chungisaac1217@gmail.com> * Update README.md Co-authored-by: Isaac Chung <chungisaac1217@gmail.com> * README.md: rm subset * doc: update example for Late Interaction * get colbert running without errors * fix: pass is_query to pylate * fix: max_sim add pad_sequence * feat: integrate Jinja templates for ColBERTv2 and add model prompt handling * feat: add revision & prompt_name * doc: pad_sequence * rm TODO jina colbert v2 * doc: warning: higher resource usage for MaxSim --------- Co-authored-by: sam021313 <40773225+sam021313@users.noreply.github.com> Co-authored-by: Roman Solomatin <samoed.roman@gmail.com> Co-authored-by: Isaac Chung <chungisaac1217@gmail.com>
* doc: colbert add score_function & doc section * doc: Update README.md Co-authored-by: Kenneth Enevoldsen <kennethcenevoldsen@gmail.com> * doc: Update README.md Co-authored-by: Isaac Chung <chungisaac1217@gmail.com> --------- Co-authored-by: sam021313 <40773225+sam021313@users.noreply.github.com> Co-authored-by: Kenneth Enevoldsen <kennethcenevoldsen@gmail.com> Co-authored-by: Isaac Chung <chungisaac1217@gmail.com>
* add support for scoring function * lint * move similarity to wrapper * remove score function * lint * remove from InstructionRetrievalEvaluator * Update mteb/evaluation/evaluators/RetrievalEvaluator.py Co-authored-by: Kenneth Enevoldsen <kennethcenevoldsen@gmail.com> * remove score function from README.md --------- Co-authored-by: Kenneth Enevoldsen <kennethcenevoldsen@gmail.com>
* Add new models nvidia, gte, linq * add warning for gte-Qwen and nvidia models re: instruction used in docs as well --------- Co-authored-by: isaac-chung <chungisaac1217@gmail.com>
* Added embedding size guide to performance-size plot, removed shading on radar chart * Changed plot names to something more descriptive * Made plots failsafe
* Added explanation of aggregate measures * Added download button to result tables * Task info gets sorted by task name * Added custom, shareable links for each benchmark * Moved explanation of aggregate metrics to the summary tab
* Use similarity scores if available * lint
* add NanoClimateFeverRetrieval task, still requires some debugging * move task to correct place in init file * add all Nano datasets and results * format code * Update mteb/tasks/Retrieval/eng/tempCodeRunnerFile.py Co-authored-by: Roman Solomatin <samoed.roman@gmail.com> * pin revision to commit and add datasets to benchmark.py * create new benchmark for NanoBEIR * add revision when loading datasets * lint --------- Co-authored-by: Roman Solomatin <samoed.roman@gmail.com> Co-authored-by: isaac-chung <chungisaac1217@gmail.com>
* init * fix tests * update mock retrieval * update tests * use subsets instead of langs * Apply suggestions from code review Co-authored-by: Isaac Chung <chungisaac1217@gmail.com> * fix tests * add to readme * rename subset in readme --------- Co-authored-by: Isaac Chung <chungisaac1217@gmail.com>
* add IBM granite embedding models * lint formatting * add adapted_from and superseded_by to ModelMeta
feat: set `use_instructions` to True in models using prompts
# Conflicts: # docs/tasks.md # mteb/abstasks/AbsTaskInstructionRetrieval.py # mteb/evaluation/MTEB.py # mteb/evaluation/evaluators/InstructionRetrievalEvaluator.py # mteb/evaluation/evaluators/RerankingEvaluator.py # mteb/evaluation/evaluators/RetrievalEvaluator.py # mteb/model_meta.py # mteb/models/arctic_models.py # mteb/models/bge_models.py # mteb/models/ru_sentence_models.py # mteb/models/uae_models.py # mteb/tasks/Reranking/__init__.py # mteb/tasks/Retrieval/__init__.py # tests/test_TaskMetadata.py
|
Thanks @Samoed! Score function looks good. Is the ColBERT stuff new here - I am a bit confused by the commit threads. |
|
Yes, this is a new model and was integrated into the main branch, but GitHub is displaying it a bit oddly. I've added you to review the |
|
Yes refactor looks good! Only one small nit, model.score in the model classes as a replacement is a bit ambiguous, would prefer something like score_fn or distance_fn or something more verbose. Otherwise LGTM, feel free to merge. |
orionw
reviewed
Dec 21, 2024
| @@ -338,17 +320,20 @@ def _full_corpus_search( | |||
| logging.info("Computing Similarities...") | |||
| query_embeddings = torch.as_tensor(query_embeddings).to(device) | |||
| sub_corpus_embeddings = torch.as_tensor(sub_corpus_embeddings).to(device) | |||
|
|
|||
| score_function = ( | |||
| self.model.score if hasattr(self.model, "score") else cos_sim | |||
There was a problem hiding this comment.
This was the line that confused me, but I am only on mobile today so perhaps I’m misreading. Feel free to ignore, since I see score_fn later in the code
There was a problem hiding this comment.
You are right. This should be similarity function as in sentence_transformers
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.
Checklist
Run tests locally to make sure nothing is broken using
make test.Run the formatter to format the code using
make lint.Updated tasks and their metadata
Updated the score function in
AbsTaskRetrieval