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

feat: Cleaned up scripts folder #1144

Merged
merged 5 commits into from
Aug 12, 2024
Merged

feat: Cleaned up scripts folder #1144

merged 5 commits into from
Aug 12, 2024

Conversation

KennethEnevoldsen
Copy link
Contributor

@KennethEnevoldsen KennethEnevoldsen commented Aug 11, 2024

  • A few of the benchmarks weren't implemented in the benchmark list. The best choice seem to move them benchmarks and remove the script (there were already a few issues). To ensure that they are maintained with the rest. Almost all of these had a task that had been renamed. The new approach will raise an error if this is the case.
  • Removed trivial (e.g., running one task) or outdated examples. Removing them ensure that we have less to maintain.
  • moved the mteb-specific (paper) script into a scirpts/mteb folder.

Note: This caused a change in the order of imports, which turns out that (due to our shady naming practices) causes:

from mteb.abstasks import TaskMetadata

to import the Module TaskMetadata instead of the object. I have instead specified all places to avoid future issues:

from mteb.abstasks.TaskMetadata import TaskMetadata

I have moved this fix to the associated PR: #1145 to clarify it.

Checklist

  • Run tests locally to make sure nothing is broken using make test.
  • Run the formatter to format the code using make lint.

- A few of the benchmarks weren't implemented in the benchmark list. The best choice seem to move them benchmarks and remove the script (there were already a few issues). To ensure that they are maintained with the rest.
- Removed trivial (e.g. running one task) or outdated examples. Removing them ensure that we have less to maintain.
- moved mteb specific script into a mteb-folder.
@KennethEnevoldsen KennethEnevoldsen changed the title feat: Move benchmarks from script to benchmarks.py and specify arbitrary imports feat: Cleaned up scripts folder Aug 11, 2024
Copy link
Contributor

@Muennighoff Muennighoff left a comment

Choose a reason for hiding this comment

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

Nice! Rather than breaking it up into mteb & mmteb, I would probably just break it up into scripts/data, scripts/running and maybe scripts/analysis and put single files directly into scripts rather than having folders with just one file 🤔

But I think the current way is also fine if you prefer!

This avoids loading in classes as modules (see PR ...)
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.

I agree with Niklas' suggestion as well, but the current way is fine too.

@KennethEnevoldsen
Copy link
Contributor Author

That is perfectly fine with me as well. I have changed it to match

@KennethEnevoldsen KennethEnevoldsen enabled auto-merge (squash) August 12, 2024 08:39
@KennethEnevoldsen KennethEnevoldsen merged commit ebe6def into main Aug 12, 2024
9 checks passed
@KennethEnevoldsen KennethEnevoldsen deleted the scripts-cleanup branch August 12, 2024 08:44
isaac-chung added a commit that referenced this pull request Aug 14, 2024
* fix: when create meta merge results with existing README.md (#1117)
* init version
* merge scores
* add test without frontmatter
* lint
* 1.12.91
Automatically generated by python-semantic-release
* fix: IWSLT2017BitextMining loading dataset. (#1132)
fix: the way of loading and transform dataset and typo of filename on IWSLT2017BitextMining
* 1.12.92
Automatically generated by python-semantic-release
* fix: Allow more linient TaskMetadata (#1131)
* fix: Allow more linient TaskMetadata
This fix allows for more lenient TaskMetadata when using the package, but maintain the validation for the package within the tests.
This is intended to ensure flexibility and ease of use, while maintaining high-quality doucementation of tasks
* Added fixes based on corrections
* Update points table
* 1.12.93
Automatically generated by python-semantic-release
* Added pyupgrade (using ruff) to lint CI (#1137)
* Added pyupgrade (using ruff) to lint CI
* Added FA ruleset
* Added C4 ruleset for simplifying comprehensions
* Added a few exceptions for points
Co-authored-by: bryant1410 <[email protected]>
* Added required import
* Add co-author
Co-authored-by: bryant1410 <[email protected]>
* format
---------
Co-authored-by: bryant1410 <[email protected]>
Co-authored-by: bryant1410 <[email protected]>
* fix: add CoIR tasks (#1130)
* add CoIR tasks
* change to mteb datasets
* Update points table
* Update tasks table
* 1.12.94
Automatically generated by python-semantic-release
* feat: Added in functionality to allow loading outdated results (#1141)
* 1.13.0
Automatically generated by python-semantic-release
* fix: add CoIR as Benchmark (#1142)
* add CoIR as Benchmark
* lint
* 1.13.1
Automatically generated by python-semantic-release
* Simplify models (#1118)
* Merge
* Adapt
* Simplify
* Check for rev again
* Rmv cmmnt
* Simplify
* simplify
* Rmv comment
Co-authored-by: Kenneth Enevoldsen <[email protected]>
* Use logging; change try except; add info
* Lint
* Rmv results
* Update rev
* Simplify models; Allow instructions
* Jobs
* Fix merge
* Format
* Adapt models
* Fix task types
* Update
* Fix syntax
* Simplify
* Add comparison
* Format
* Fix double comment
Co-authored-by: Kenneth Enevoldsen <[email protected]>
* Move example
* Format
* Rmv outdated instructions
---------
Co-authored-by: Kenneth Enevoldsen <[email protected]>
* Missing import for SadeemQuestionRetrieval (#1146)
Fixes #1143
* fix: Remove unused tests (#1148)
These tests are no longer used since results moved to the results repo.
* Update tasks table
* 1.13.2
Automatically generated by python-semantic-release
* feat: Cleaned up scripts folder  (#1144)
* fix: Move benchmarks from script to benchmarks.py
- A few of the benchmarks weren't implemented in the benchmark list. The best choice seem to move them benchmarks and remove the script (there were already a few issues). To ensure that they are maintained with the rest.
- Removed trivial (e.g. running one task) or outdated examples. Removing them ensure that we have less to maintain.
- moved mteb specific script into a mteb-folder.
* format
* fix: Convert arbitrary imports to absolute imports. (#1145)
This avoids loading in classes as modules (see PR ...)
* restructe scripts folder
* 1.14.0
Automatically generated by python-semantic-release
* Fix: llm2vec for retrieval (#1152)
* fix: remove  kwargs LLM2Vec doesn't have
* fix: linter error
* fix: an item automatically added by linter
* fix: removed test set for AFQMC with no gold labels (#1153)
The test set of AFQMC is hidden so has removed it from the default suite. This influences the C-MTEB. Who is the best person to contact for this? (@Muennighoff)
* 1.14.1
Automatically generated by python-semantic-release
* LitSearchRetrieval added (#1150)
* LitSearchRetrieval added
* points added
* fixed descriptive_stats in LitSearchRetrieval
* fix lint
* metadata fixed for LitSearchRetrieval
* metadata fixed for LitSearchRetrieval again
* metadata fixed for LitSearchRetrieval again
* points 1150 updated
* metadata fixed for LitSearchRetrieval again
* lint fix
* Update points table
* Update tasks table
* ruff check fixed
* make lint
* fix imports
* make lint
---------
Co-authored-by: Roman Solomatin <[email protected]>
Co-authored-by: github-actions <[email protected]>
Co-authored-by: Hiroki Iida <[email protected]>
Co-authored-by: Kenneth Enevoldsen <[email protected]>
Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
Co-authored-by: Roman Solomatin <[email protected]>
Co-authored-by: Niklas Muennighoff <[email protected]>
Co-authored-by: dokato <[email protected]>
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