fix: Add documentation#1567
Merged
Merged
Conversation
Samoed
reviewed
Dec 7, 2024
x-tabdeveloping
left a comment
Collaborator
There was a problem hiding this comment.
Awesome work so far, I really like it
isaac-chung
reviewed
Dec 8, 2024
isaac-chung
left a comment
Collaborator
There was a problem hiding this comment.
Great stuff! Added some suggested edits.
Comment on lines
+31
to
+36
| 1. Open a PR at https://huggingface.co/spaces/mteb/leaderboard modifying app.py to add your tab: | ||
| - Add any new models & their specs to the global lists | ||
| - Add your tab, credits etc to where the other tabs are defined | ||
| - If you're adding new results to existing models, remove those models from `EXTERNAL_MODEL_RESULTS.json` such that they can be reloaded with the new results and are not cached. | ||
| - You may also have to uncomment `, download_mode='force_redownload', verification_mode="no_checks")` where the datasets are loaded to experiment locally without caching of results | ||
| - Test that it runs & works locally as you desire with python app.py, **please add screenshots to the PR** |
Collaborator
There was a problem hiding this comment.
Is it only for adding a new tab to the leaderboard, or every time a new model is added?
If it's the latter, then 3 PRs are needed to add a new model: MTEB repo, results repo, and leaderboard repo.
Contributor
Author
There was a problem hiding this comment.
Nothing should be needed to the leaderboard repo
Merged
2 tasks
Co-authored-by: Isaac Chung <chungisaac1217@gmail.com>
Contributor
Author
|
Updated docs and merged everything. I merge this into the branch now |
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
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.
I had some time on a plane so I made a documentation page!! I initially was thinking of moving everything there, but there were too many problems (especially with circular imports encountered when using the autodoc function) so I decided to work only on the API documentation which we currently don't have.
Therefore there are a lot of changes that are currently not used in the docs. The hope is that after this PR we can resolve some of these issues.
Here are some examples of the docs: