Skip to content
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

Add datasets for a benchmark newly introduced for "Engineering" domain #1911

Open
wants to merge 14 commits into
base: main
Choose a base branch
from

Conversation

mehrzadshm
Copy link

@mehrzadshm mehrzadshm commented Jan 30, 2025

The datasets are associated with this research work (under review): Benchmarking pre-trained text embedding models in aligning built asset information

The initial results are included in embeddings-benchmark/results; related PR: #110

The proposed benchmark introduces 4 tasks, under three main types: clustering, retrieval, and reranking.

HuggingFace links to datasets :

Adding datasets checklist

Reason for dataset addition: This dataset points to a new domain, i.e., "Engineering" (more specifically related to architecture, construction, and built asset management)

  • I have run the following models on the task (adding the results to the pr). These can be run using the mteb -m {model_name} -t {task_name} command.
    • sentence-transformers/paraphrase-multilingual-MiniLM-L12-v2
    • intfloat/multilingual-e5-small
  • I have checked that the performance is neither trivial (both models gain close to perfect scores) nor random (both models gain close to random scores).
  • If the dataset is too big (e.g. >2048 examples), considering using self.stratified_subsampling() under dataset_transform()
  • I have filled out the metadata object in the dataset file (find documentation on it here).
  • Run tests locally to make sure nothing is broken using make test.
  • Run the formatter to format the code using make lint.

Looking forward to your feedback!

* Added "Engineering" as new domain to TaskMetadata.py
* Updated tasks table in docs
* Updated task metadata for BuiltBenchClustering S2S and P2P
Copy link
Collaborator

@Samoed Samoed left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It seems you want to add missing tasks to benchmark. You can follow adding_a_benchmark doc to fully integrate it

@mehrzadshm
Copy link
Author

Makes perfect sense; I'll be adding other tasks and putting it all together as a new benchmark

@isaac-chung
Copy link
Collaborator

Just converted this to draft. Feel free to mark it as ready when it's ready for review :)

@mehrzadshm
Copy link
Author

Awesome! will do it shortly; tnx for your time!

- Add BuiltBenchRetrieval task
- Add BuiltBenchReranking task
- Update metadata for BuiltBenchClusterinP2P
- Update metadata for BuiltBenchClusterinS2S
@mehrzadshm mehrzadshm changed the title Add new clustering tasks for a new domain (Engineering) Add datasets for a benchmark newly introduced for "Engineering" domain Feb 4, 2025
mehrzadshm added a commit to mehrzadshm/results that referenced this pull request Feb 6, 2025
* add initial  results for proposed tasks
* update paths.json
@mehrzadshm
Copy link
Author

mehrzadshm commented Feb 6, 2025

Just followed the advice and integrated all changes, including new datasets and an associated new benchmark class in mteb, plus adding results in embeddings-benchmark/results (related PR: embeddings-benchmark/results#110)

Just marking the PR ready for review :) Looking forward to your feedback.

Thanks in advance for your time!

@mehrzadshm mehrzadshm requested a review from Samoed February 6, 2025 13:50
@mehrzadshm mehrzadshm marked this pull request as ready for review February 6, 2025 13:53
mteb/benchmarks/benchmarks.py Show resolved Hide resolved
mteb/tasks/Clustering/eng/BuiltBenchClusteringS2S.py Outdated Show resolved Hide resolved
mteb/tasks/Clustering/eng/BuiltBenchClusteringP2P.py Outdated Show resolved Hide resolved
Samoed pushed a commit to embeddings-benchmark/results that referenced this pull request Feb 7, 2025
…110)

* Add BuiltBench results (related mteb PR: embeddings-benchmark/mteb#1911)

* add initial  results for proposed tasks
* update paths.json

* Update model_meta files modified in BuiltBench PR: #110

* rollback paths.json (see PR: #110)
Copy link
Collaborator

@isaac-chung isaac-chung left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for adding this, good work!

"BuiltBenchReranking",
],
),
description="\"Built-Bench\" is an ongoing effort aimed at evaluating text embedding models in the context of buit asset management, spanning over various dicsiplines such as architeture, engineering, constrcution, and operations management of the built environment.",
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Tiny typo

Suggested change
description="\"Built-Bench\" is an ongoing effort aimed at evaluating text embedding models in the context of buit asset management, spanning over various dicsiplines such as architeture, engineering, constrcution, and operations management of the built environment.",
description="\"Built-Bench\" is an ongoing effort aimed at evaluating text embedding models in the context of built asset management, spanning over various dicsiplines such as architeture, engineering, constrcution, and operations management of the built environment.",

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sharp eyes!

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.

3 participants