Clémentine commited on
Commit
910a08e
1 Parent(s): 24622c4

more info README

Browse files
Files changed (1) hide show
  1. README.md +10 -4
README.md CHANGED
@@ -10,12 +10,12 @@ pinned: true
10
  license: apache-2.0
11
  ---
12
 
13
- Check out the configuration reference at https://huggingface.co/docs/hub/spaces-config-reference
14
 
15
- Most of the variables to change for a default leaderboard are in src/env (replace the path for your leaderboard) and src/about.
16
 
17
- Results files should have the following format:
18
- ```
19
  {
20
  "config": {
21
  "model_dtype": "torch.float16", # or torch.bfloat16 or 8bit or 4bit
@@ -37,3 +37,9 @@ Request files are created automatically by this tool.
37
 
38
  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.
39
 
 
 
 
 
 
 
 
10
  license: apache-2.0
11
  ---
12
 
13
+ # Start the configuration
14
 
15
+ 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).
16
 
17
+ Results files should have the following format and be stored as json files:
18
+ ```json
19
  {
20
  "config": {
21
  "model_dtype": "torch.float16", # or torch.bfloat16 or 8bit or 4bit
 
37
 
38
  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.
39
 
40
+ # Code logic for more complex edits
41
+
42
+ You'll find
43
+ - the main table' columns names and properties in `src/display/utils.py`
44
+ - 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`
45
+ - teh logic to allow or filter submissions in `src/submission/submit.py` and `src/submission/check_validity.py`