-
Notifications
You must be signed in to change notification settings - Fork 313
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
mehrzadshm
wants to merge
14
commits into
embeddings-benchmark:main
Choose a base branch
from
mehrzadshm:main
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+177
−0
Open
Changes from all commits
Commits
Show all changes
14 commits
Select commit
Hold shift + click to select a range
0a70913
adding clustering tasks (built-bench-clustering S2S & P2P)
mehrzadshm 1486386
Merge remote-tracking branch 'upstream/main'
mehrzadshm e378c71
updated built-bench-clustering tasks
mehrzadshm 34f2e86
Updated BuiltBenchClustering tasks
mehrzadshm f8be95f
resolved merge conflicts
mehrzadshm d3ec031
Merge remote-tracking branch 'upstream/main'
mehrzadshm b8ff15e
updated metadata for clustering tasks
mehrzadshm 68d5316
Merge remote-tracking branch 'upstream/main'
mehrzadshm b299df5
Add/update BuiltBench tasks
mehrzadshm e8c7e10
update BuiltBench benchmark
mehrzadshm 3abb5d4
Merge remote-tracking branch 'upstream/main'
mehrzadshm 0a777b3
Update mteb/benchmarks/benchmarks.py
mehrzadshm f236c04
Update mteb/tasks/Clustering/eng/BuiltBenchClusteringS2S.py
mehrzadshm 681d6f3
Update mteb/tasks/Clustering/eng/BuiltBenchClusteringP2P.py
mehrzadshm File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
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
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
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,36 @@ | ||
from __future__ import annotations | ||
|
||
from mteb.abstasks.AbsTaskClustering import AbsTaskClustering | ||
from mteb.abstasks.TaskMetadata import TaskMetadata | ||
|
||
|
||
class BuiltBenchClusteringP2P(AbsTaskClustering): | ||
metadata = TaskMetadata( | ||
name="BuiltBenchClusteringP2P", | ||
description="Clustering of built asset item descriptions based on categories identified within industry classification systems such as IFC, Uniclass, etc.", | ||
reference="https://arxiv.org/abs/2411.12056", | ||
dataset={ | ||
"path": "mehrzad-shahin/BuiltBench-clustering-p2p", | ||
"revision": "919bb71053e9de62a68998161ce4f0cee8f786fb", | ||
}, | ||
type="Clustering", | ||
category="p2p", | ||
modalities=["text"], | ||
eval_splits=["test"], | ||
eval_langs=["eng-Latn"], | ||
main_score="v_measure", | ||
date=("2024-06-01", "2024-11-30"), | ||
domains=["Engineering", "Written"], | ||
task_subtypes=["Thematic clustering"], | ||
license="cc-by-nd-4.0", | ||
annotations_creators="derived", | ||
dialect=[], | ||
sample_creation="created", | ||
bibtex_citation="""@article{shahinmoghadam2024benchmarking, | ||
title={Benchmarking pre-trained text embedding models in aligning built asset information}, | ||
author={Shahinmoghadam, Mehrzad and Motamedi, Ali}, | ||
journal={arXiv preprint arXiv:2411.12056}, | ||
year={2024} | ||
}""", | ||
prompt="Identify the category of the built asset entities based on the entity description", | ||
) |
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,36 @@ | ||
from __future__ import annotations | ||
|
||
from mteb.abstasks.AbsTaskClustering import AbsTaskClustering | ||
from mteb.abstasks.TaskMetadata import TaskMetadata | ||
|
||
|
||
class BuiltBenchClusteringS2S(AbsTaskClustering): | ||
metadata = TaskMetadata( | ||
name="BuiltBenchClusteringS2S", | ||
description="Clustering of built asset names/titles based on categories identified within industry classification systems such as IFC, Uniclass, etc.", | ||
reference="https://arxiv.org/abs/2411.12056", | ||
dataset={ | ||
"path": "mehrzad-shahin/BuiltBench-clustering-s2s", | ||
"revision": "1aaeb2ece89ea0a8c64e215c95c4cfaf7e891149", | ||
}, | ||
type="Clustering", | ||
category="s2s", | ||
modalities=["text"], | ||
eval_splits=["test"], | ||
eval_langs=["eng-Latn"], | ||
main_score="v_measure", | ||
date=("2024-06-01", "2024-11-30"), | ||
domains=["Engineering", "Written"], | ||
task_subtypes=["Thematic clustering"], | ||
license="cc-by-nd-4.0", | ||
annotations_creators="derived", | ||
dialect=[], | ||
sample_creation="created", | ||
bibtex_citation="""@article{shahinmoghadam2024benchmarking, | ||
title={Benchmarking pre-trained text embedding models in aligning built asset information}, | ||
author={Shahinmoghadam, Mehrzad and Motamedi, Ali}, | ||
journal={arXiv preprint arXiv:2411.12056}, | ||
year={2024} | ||
}""", | ||
prompt="Identify the category of the built asset entities based on the names or titles", | ||
) |
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
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,39 @@ | ||
from __future__ import annotations | ||
|
||
from mteb.abstasks.TaskMetadata import TaskMetadata | ||
|
||
from ....abstasks.AbsTaskReranking import AbsTaskReranking | ||
|
||
|
||
class BuiltBenchReranking(AbsTaskReranking): | ||
metadata = TaskMetadata( | ||
name="BuiltBenchReranking", | ||
description="Reranking of built asset entity type/class descriptions given a query describing an entity as represented in well-established industry classification systems such as Uniclass, IFC, etc.", | ||
reference="https://arxiv.org/abs/2411.12056", | ||
dataset={ | ||
"path": "mehrzad-shahin/BuiltBench-reranking", | ||
"revision": "fd33b0b3454deb256be06a57e8147b32ba078ff9", | ||
}, | ||
type="Reranking", | ||
category="p2p", | ||
modalities=["text"], | ||
eval_splits=["test"], | ||
eval_langs=["eng-Latn"], | ||
main_score="map", | ||
date=("2024-06-01", "2024-11-30"), | ||
domains=["Engineering", "Written"], | ||
task_subtypes=[], | ||
license="cc-by-nd-4.0", | ||
annotations_creators="derived", | ||
dialect=[], | ||
sample_creation="created", | ||
bibtex_citation="""@article{shahinmoghadam2024benchmarking, | ||
title={Benchmarking pre-trained text embedding models in aligning built asset information}, | ||
author={Shahinmoghadam, Mehrzad and Motamedi, Ali}, | ||
journal={arXiv preprint arXiv:2411.12056}, | ||
year={2024} | ||
}""", | ||
prompt={ | ||
"query": "Given a query, retrieve relevant entity descriptions from buit asset classification systems such as IFC and Uniclass" | ||
}, | ||
) |
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
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,39 @@ | ||
from __future__ import annotations | ||
|
||
from mteb.abstasks.TaskMetadata import TaskMetadata | ||
|
||
from ....abstasks.AbsTaskRetrieval import AbsTaskRetrieval | ||
|
||
|
||
class BuiltBenchRetrieval(AbsTaskRetrieval): | ||
metadata = TaskMetadata( | ||
name="BuiltBenchRetrieval", | ||
description="Retrieval of built asset entity type/class descriptions given a query describing an entity as represented in well-established industry classification systems such as Uniclass, IFC, etc.", | ||
reference="https://arxiv.org/abs/2411.12056", | ||
dataset={ | ||
"path": "mehrzad-shahin/BuiltBench-retrieval", | ||
"revision": "ae611238a58dae85f3130563fe9f9e995444a8d6", | ||
}, | ||
type="Retrieval", | ||
category="p2p", | ||
modalities=["text"], | ||
eval_splits=["test"], | ||
eval_langs=["eng-Latn"], | ||
main_score="ndcg_at_10", | ||
date=("2024-06-01", "2024-11-30"), | ||
domains=["Engineering", "Written"], | ||
task_subtypes=["Question answering"], | ||
license="cc-by-nd-4.0", | ||
annotations_creators="derived", | ||
dialect=[], | ||
sample_creation="created", | ||
bibtex_citation="""@article{shahinmoghadam2024benchmarking, | ||
title={Benchmarking pre-trained text embedding models in aligning built asset information}, | ||
author={Shahinmoghadam, Mehrzad and Motamedi, Ali}, | ||
journal={arXiv preprint arXiv:2411.12056}, | ||
year={2024} | ||
}""", | ||
prompt={ | ||
"query": "Given a query, retrieve relevant entity descriptions from buit asset classification systems such as IFC and Uniclass" | ||
}, | ||
) |
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Tiny typo
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Sharp eyes!