Removed debug code in refresh.py intended to only update one board (#20)

* Removed debug code in refresh.py intended to only update one board I additionally removed types from docstring (some were lying) and added types where I could guess them to make it easier to debug the code in the future. Also added a minor description to the readme for ease of navigation. * Added import for type annotations * Ensure that the reset_index happens inplace * Avoid adding duplicates in refresh.py
embeddings-benchmark · Jul 28, 2024 · b8ed799 · b8ed799
1 parent 1fd4bba
commit b8ed799
Show file tree

Hide file tree

Showing 2 changed files with 354 additions and 133 deletions.
diff --git a/README.md b/README.md
@@ -12,3 +12,23 @@ tags:
 startup_duration_timeout: 1h
 fullWidth: true
 ---
+
+## The MTEB Leaderboard repository
+
+This repository contains the code for pushing and updating the MTEB leaderboard daily. 
+
+| Relevant Links                                                | Decription                                                                                                                                                                                                |
+|------------------------------------------|------------------------------|
+| [mteb](https://github.com/embeddings-benchmark/mteb)          | The implementation of the benchmark. Here you e.g. find the code to run your model on the benchmark.                                                                                                      |
+| [leaderboard](https://huggingface.co/spaces/mteb/leaderboard) | The leaderboard itself, here you can view results of model run on MTEB.                                                                                                                                   |
+| [results](https://github.com/embeddings-benchmark/results)    | The results of MTEB is stored here. Though you can publish them to the leaderboard [adding](https://github.com/embeddings-benchmark/mteb/blob/main/docs/adding_a_model.md) the result to your model card. |
+
+## Developer setup
+
+To setup the repository:
+
+```         
+git clone {repo_url}
+# potentially create virtual environment using python 3.9
+pip install -r requirements.txt
+```