Behnamm commited on
Commit
47730ef
1 Parent(s): c4ee4c8

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +1 -35
README.md CHANGED
@@ -9,38 +9,4 @@ pinned: true
9
  license: apache-2.0
10
  sdk_version: 4.42.0
11
  short_description: A Leaderboard for Evaluating LLMs in Persian Language.
12
- ---
13
-
14
- # Start the configuration
15
-
16
- 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).
17
-
18
- Results files should have the following format and be stored as json files:
19
- ```json
20
- {
21
- "config": {
22
- "model_dtype": "torch.float16", # or torch.bfloat16 or 8bit or 4bit
23
- "model_name": "path of the model on the hub: org/model",
24
- "model_sha": "revision on the hub",
25
- },
26
- "results": {
27
- "task_name": {
28
- "metric_name": score,
29
- },
30
- "task_name2": {
31
- "metric_name": score,
32
- }
33
- }
34
- }
35
- ```
36
-
37
- Request files are created automatically by this tool.
38
-
39
- 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.
40
-
41
- # Code logic for more complex edits
42
-
43
- You'll find
44
- - the main table' columns names and properties in `src/display/utils.py`
45
- - 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`
46
- - the logic to allow or filter submissions in `src/submission/submit.py` and `src/submission/check_validity.py`
 
9
  license: apache-2.0
10
  sdk_version: 4.42.0
11
  short_description: A Leaderboard for Evaluating LLMs in Persian Language.
12
+ ---