EunsuKim commited on
Commit
c9eb332
·
verified ·
1 Parent(s): 75eb05b

Upload README.md

Browse files
Files changed (1) hide show
  1. README.md +9 -41
README.md CHANGED
@@ -1,44 +1,12 @@
1
- ---
2
- title: Config Collection
3
- emoji: 🥇
4
- colorFrom: green
5
- colorTo: indigo
6
- sdk: gradio
7
- app_file: app.py
8
- pinned: true
9
- license: apache-2.0
10
- ---
11
 
12
- # Start the configuration
 
 
13
 
14
- Most of the variables to change for a default leaderboard are in `src/env.py` (replace the path for your leaderboard) and `src/about.py` (for tasks).
 
 
15
 
16
- Results files should have the following format and be stored as json files:
17
- ```json
18
- {
19
- "config": {
20
- "model_dtype": "torch.float16", # or torch.bfloat16 or 8bit or 4bit
21
- "model_name": "path of the model on the hub: org/model",
22
- "model_sha": "revision on the hub",
23
- },
24
- "results": {
25
- "task_name": {
26
- "metric_name": score,
27
- },
28
- "task_name2": {
29
- "metric_name": score,
30
- }
31
- }
32
- }
33
- ```
34
-
35
- Request files are created automatically by this tool.
36
-
37
- If you encounter problem on the space, don't hesitate to restart it to remove the create eval-queue, eval-queue-bk, eval-results and eval-results-bk created folder.
38
-
39
- # Code logic for more complex edits
40
-
41
- You'll find
42
- - the main table' columns names and properties in `src/display/utils.py`
43
- - the logic to read all results and request files, then convert them in dataframe lines, in `src/leaderboard/read_evals.py`, and `src/populate.py`
44
- - the logic to allow or filter submissions in `src/submission/submit.py` and `src/submission/check_validity.py`
 
1
+ # Configuration Card Sharing Space
 
 
 
 
 
 
 
 
 
2
 
3
+ This Space allows users to upload and share configuration cards with task descriptions. Users can:
4
+ - Upload configuration files and describe the associated tasks.
5
+ - Browse and download configuration cards shared by others.
6
 
7
+ ## How to Use
8
+ 1. Upload your configuration card and provide a task description.
9
+ 2. Browse uploaded files and download any file you like.
10
 
11
+ ## Contribution
12
+ Feel free to upload your files and share them with the community!