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

Restructing the readme #262

Merged
merged 3 commits into from
Mar 20, 2024
Merged

Restructing the readme #262

merged 3 commits into from
Mar 20, 2024

Conversation

KennethEnevoldsen
Copy link
Contributor

@KennethEnevoldsen KennethEnevoldsen commented Mar 19, 2024

This does PR restructes the readme to allow users to get an easier overview. It does the following:

  1. splits up test using parametrize (this makes then run notably faster as they can be run in parallel)
  2. Introduced the docs folder
  3. Split larger segments of the readme into the docs folder and introduces a table which links to these
  4. Moved setup.py --> pyproject.toml
  5. Removed the double specification of version it is now only specified in one place!

Copy link
Contributor

@imenelydiaker imenelydiaker left a comment

Choose a reason for hiding this comment

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

That's amazing! The README is way more accessible this way, nice job! 🚀

@KennethEnevoldsen KennethEnevoldsen merged commit 769157b into main Mar 20, 2024
3 checks passed
@KennethEnevoldsen KennethEnevoldsen deleted the update-readme branch March 20, 2024 08:48
MartinBernstorff pushed a commit to MartinBernstorff/mteb that referenced this pull request Mar 20, 2024
* restructing the readme

* removed double specification of versions and moved all setup to pyproject.toml

* correctly use flat-layout for the package
MartinBernstorff added a commit that referenced this pull request Mar 21, 2024
* refactor: rename description to metadata dict

* refactor: add TaskMetadata and first example

* update 9 files

* update TaskMetadata.py

* update TaskMetadata.py

* update TaskMetadata.py

* update LICENSE, TaskMetadata.py and requirements.dev.txt

* update 151 files

* update 150 files

* update 43 files and delete 1 file

* update 106 files

* update 45 files

* update 6 files

* update 14 files

* Added model results to repo and updated CLI to create consistent folder structure. (#254)

* Added model results to repo and updated CLI to create consistent folder structure.

* ci: updated ci to use make install

* Added missing pytest dependencies

* Update README.md

Co-authored-by: Niklas Muennighoff <[email protected]>

---------

Co-authored-by: Niklas Muennighoff <[email protected]>

* Restructing the readme (#262)

* restructing the readme

* removed double specification of versions and moved all setup to pyproject.toml

* correctly use flat-layout for the package

* build(deps): update TaskMetadata.py and pyproject.toml

* update 221 files

* build(deps): update pyproject.toml

* build(deps): update pyproject.toml

* build(deps): update pyproject.toml

---------

Co-authored-by: Kenneth Enevoldsen <[email protected]>
Co-authored-by: Niklas Muennighoff <[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.

2 participants