yangzhitao commited on
Commit
2c1d263
·
1 Parent(s): c85dcc4

docs: update README for EASI Leaderboard

Browse files
Files changed (1) hide show
  1. README.md +2 -36
README.md CHANGED
@@ -1,5 +1,5 @@
1
  ---
2
- title: Example Leaderboard Template
3
  emoji: 🥇
4
  colorFrom: green
5
  colorTo: indigo
@@ -7,42 +7,8 @@ sdk: gradio
7
  app_file: app.py
8
  pinned: true
9
  license: apache-2.0
10
- short_description: Duplicate this leaderboard to initialize your own!
11
  sdk_version: 5.43.1
12
  tags:
13
  - leaderboard
14
  ---
15
-
16
- # Start the configuration
17
-
18
- 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).
19
-
20
- Results files should have the following format and be stored as json files:
21
- ```json
22
- {
23
- "config": {
24
- "model_dtype": "torch.float16", # or torch.bfloat16 or 8bit or 4bit
25
- "model_name": "path of the model on the hub: org/model",
26
- "model_sha": "revision on the hub",
27
- },
28
- "results": {
29
- "task_name": {
30
- "metric_name": score,
31
- },
32
- "task_name2": {
33
- "metric_name": score,
34
- }
35
- }
36
- }
37
- ```
38
-
39
- Request files are created automatically by this tool.
40
-
41
- 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.
42
-
43
- # Code logic for more complex edits
44
-
45
- You'll find
46
- - the main table' columns names and properties in `src/display/utils.py`
47
- - 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`
48
- - the logic to allow or filter submissions in `src/submission/submit.py` and `src/submission/check_validity.py`
 
1
  ---
2
+ title: EASI Leaderboard
3
  emoji: 🥇
4
  colorFrom: green
5
  colorTo: indigo
 
7
  app_file: app.py
8
  pinned: true
9
  license: apache-2.0
10
+ short_description: "EASI: Holistic Evaluation and Analysis for Spatial Intelligence Made Easy"
11
  sdk_version: 5.43.1
12
  tags:
13
  - leaderboard
14
  ---