lvkaokao commited on
Commit
3f45e26
1 Parent(s): 49e6356

update descriptions.

Browse files
Files changed (3) hide show
  1. src/display/about.py +16 -41
  2. src/display/utils.py +3 -3
  3. src/envs.py +3 -4
src/display/about.py CHANGED
@@ -14,9 +14,9 @@ icons = f"""
14
  """
15
  LLM_BENCHMARKS_TEXT = f"""
16
  ## ABOUT
17
- With the plethora of large language models (LLMs) and chatbots being released week upon week, often with grandiose claims of their performance, it can be hard to filter out the genuine progress that is being made by the open-source community and which model is the current state of the art.
18
 
19
- Submit a model for automated evaluation on the GPU cluster on the "Submit" page!
20
  The leaderboard's backend runs the great [Eleuther AI Language Model Evaluation Harness](https://github.com/EleutherAI/lm-evaluation-harness) - read more details below!
21
 
22
  ### Tasks
@@ -42,7 +42,7 @@ We chose these benchmarks as they test a variety of reasoning and general knowle
42
  To reproduce our results, here is the commands you can run, using [v0.4.2](https://github.com/EleutherAI/lm-evaluation-harness/tree/v0.4.2) of the Eleuther AI Harness:
43
  ```
44
  python main.py --model=hf-causal-experimental
45
- --model_args="pretrained=<your_model>,use_accelerate=True,revision=<your_model_revision>"
46
  --tasks=<task_list>
47
  --num_fewshot=<n_few_shot>
48
  --batch_size=1
@@ -54,7 +54,6 @@ python main.py --model=hf-causal-experimental
54
  - If model paramerters > 7B, we use `--batch_size 4`. If model parameters < 7B, we use `--batch_size 2`. And we set `--batch_size 1` for llama.cpp. You can expect results to vary slightly for different batch sizes because of padding.
55
 
56
 
57
-
58
  ### The tasks and few shots parameters are:
59
  - ARC-C: 0-shot, *arc_challenge* (`acc`)
60
  - ARC-E: 0-shot, *arc_easy* (`acc`)
@@ -76,15 +75,13 @@ Side note on the baseline scores:
76
 
77
  ### Quantization
78
  To get more information about quantization, see:
 
79
  - 4 bits: [blog post](https://huggingface.co/blog/4bit-transformers-bitsandbytes), [paper](https://arxiv.org/abs/2305.14314)
80
 
81
- ### Useful links
82
- - [Community resources](https://huggingface.co/spaces/HuggingFaceH4/open_llm_leaderboard/discussions/174)
83
- - [Collection of best models](https://huggingface.co/collections/open-llm-leaderboard/llm-leaderboard-best-models-652d6c7965a4619fb5c27a03)
84
-
85
  ### Other cool leaderboards:
86
  - [LLM safety](https://huggingface.co/spaces/AI-Secure/llm-trustworthy-leaderboard)
87
  - [LLM performance](https://huggingface.co/spaces/optimum/llm-perf-leaderboard)
 
88
 
89
 
90
  """
@@ -93,42 +90,33 @@ FAQ_TEXT = """
93
 
94
  ## SUBMISSIONS
95
  My model requires `trust_remote_code=True`, can I submit it?
96
- - *We only support models that have been integrated in a stable version of the `transformers` library for automatic submission, as we don't want to run possibly unsafe code on our cluster.*
97
-
98
- What about models of type X?
99
- - *We only support models that have been integrated in a stable version of the `transformers` library for automatic submission.*
100
 
101
  How can I follow when my model is launched?
102
- - *You can look for its request file [here](https://huggingface.co/datasets/open-llm-leaderboard/requests) and follow the status evolution, or directly in the queues above the submit form.*
103
 
104
  My model disappeared from all the queues, what happened?
105
- - *A model disappearing from all the queues usually means that there has been a failure. You can check if that is the case by looking for your model [here](https://huggingface.co/datasets/open-llm-leaderboard/requests).*
106
 
107
  What causes an evaluation failure?
108
- - *Most of the failures we get come from problems in the submissions (corrupted files, config problems, wrong parameters selected for eval ...), so we'll be grateful if you first make sure you have followed the steps in `About`. However, from time to time, we have failures on our side (hardware/node failures, problem with an update of our backend, connectivity problem ending up in the results not being saved, ...).*
109
 
110
  How can I report an evaluation failure?
111
- - *As we store the logs for all models, feel free to create an issue, **where you link to the requests file of your model** (look for it [here](https://huggingface.co/datasets/open-llm-leaderboard/requests/tree/main)), so we can investigate! If the model failed due to a problem on our side, we'll relaunch it right away!*
112
  *Note: Please do not re-upload your model under a different name, it will not help*
113
 
114
  ---------------------------
115
 
116
  ## RESULTS
117
  What kind of information can I find?
118
- - *Let's imagine you are interested in the Yi-34B results. You have access to 3 different information categories:*
119
- - *The [request file](https://huggingface.co/datasets/open-llm-leaderboard/requests/blob/main/01-ai/Yi-34B_eval_request_False_bfloat16_Original.json): it gives you information about the status of the evaluation*
120
- - *The [aggregated results folder](https://huggingface.co/datasets/open-llm-leaderboard/results/tree/main/01-ai/Yi-34B): it gives you aggregated scores, per experimental run*
121
- - *The [details dataset](https://huggingface.co/datasets/open-llm-leaderboard/details_01-ai__Yi-34B/tree/main): it gives you the full details (scores and examples for each task and a given model)*
122
 
123
 
124
  Why do models appear several times in the leaderboard?
125
  - *We run evaluations with user selected precision and model commit. Sometimes, users submit specific models at different commits and at different precisions (for example, in float16 and 4bit to see how quantization affects performance). You should be able to verify this by displaying the `precision` and `model sha` columns in the display. If, however, you see models appearing several time with the same precision and hash commit, this is not normal.*
126
 
127
- What is this concept of "flagging"?
128
- - *This mechanism allows user to report models that have unfair performance on the leaderboard. This contains several categories: exceedingly good results on the leaderboard because the model was (maybe accidentally) trained on the evaluation data, models that are copy of other models not atrributed properly, etc.*
129
-
130
- My model has been flagged improperly, what can I do?
131
- - *Every flagged model has a discussion associated with it - feel free to plead your case there, and we'll see what to do together with the community.*
132
 
133
  ---------------------------
134
 
@@ -136,22 +124,9 @@ My model has been flagged improperly, what can I do?
136
  I upgraded my model and want to re-submit, how can I do that?
137
  - *Please open an issue with the precise name of your model, and we'll remove your model from the leaderboard so you can resubmit. You can also resubmit directly with the new commit hash!*
138
 
139
- I need to rename my model, how can I do that?
140
- - *You can use @Weyaxi 's [super cool tool](https://huggingface.co/spaces/Weyaxi/open-llm-leaderboard-renamer) to request model name changes, then open a discussion where you link to the created pull request, and we'll check them and merge them as needed.*
141
-
142
  ---------------------------
143
 
144
  ## OTHER
145
- Why do you differentiate between pretrained, continously pretrained, fine-tuned, merges, etc ?
146
- - *These different models do not play in the same categories, and therefore need to be separated for fair comparision. Base pretrained models are the most interesting for the community, as they are usually good models to fine-tune later on - any jump in performance from a pretrained model represents a true improvement on the SOTA.
147
- Fine tuned and IFT/RLHF/chat models usually have better performance, but the latter might be more sensitive to system prompts, which we do not cover at the moment in the Open LLM Leaderboard.
148
- Merges and moerges have artificially inflated performance on test sets, which is not always explainable, and does not always apply to real world situations.*
149
-
150
- What should I use the leaderboard for?
151
- - *We recommend using the leaderboard for 3 use cases: 1) getting an idea of the state of open pretrained models, by looking only at the ranks and score of this category; 2) experimenting with different fine tuning methods, datasets, quantization techniques, etc, and comparing their score in a reproducible setup, and 3) checking the performance of a model of interest to you, wrt to other models of its category.*
152
-
153
- Why don't you display closed source model scores?
154
- - *This is a leaderboard for Open models, both for philosophical reasons (openness is cool) and for practical reasons: we want to ensure that the results we display are accurate and reproducible, but 1) commercial closed models can change their API thus rendering any scoring at a given time incorrect 2) we re-run everything on our cluster to ensure all models are run on the same setup and you can't do that for these models.*
155
 
156
  I have an issue about accessing the leaderboard through the Gradio API
157
  - *Since this is not the recommended way to access the leaderboard, we won't provide support for this, but you can look at tools provided by the community for inspiration!*
@@ -191,8 +166,8 @@ This is a leaderboard for Open LLMs, and we'd love for as many people as possibl
191
  ### 4) Fill up your model card
192
  When we add extra information about models to the leaderboard, it will be automatically taken from the model card
193
 
194
- ### 5) Select the correct precision
195
- Not all models are converted properly from `float16` to `bfloat16`, and selecting the wrong precision can sometimes cause evaluation error (as loading a `bf16` model in `fp16` can sometimes generate NaNs, depending on the weight range).
196
 
197
  """
198
 
@@ -206,7 +181,7 @@ CITATION_BUTTON_TEXT = r"""
206
  url={https://arxiv.org/abs/2309.05516}
207
  }
208
  @software{neural-compressor,
209
- title = intel/neural-compressor,
210
  publisher = {Intel},
211
  url = {https://github.com/intel/neural-compressor/tree/master}
212
  }
 
14
  """
15
  LLM_BENCHMARKS_TEXT = f"""
16
  ## ABOUT
17
+ Quantization is a key technique for making LLMs more accessible and practical for a wide range of applications, especially where computational resources are a limiting factor. While there is no tool to track and compare quantization LLMs with different quantization algorithms, which is hard to filter out the genuine progress that is being made by the open-source community and which model is the current state of the art.
18
 
19
+ Submit a model for automated evaluation on the CPU/GPU cluster on the "Submit" page!
20
  The leaderboard's backend runs the great [Eleuther AI Language Model Evaluation Harness](https://github.com/EleutherAI/lm-evaluation-harness) - read more details below!
21
 
22
  ### Tasks
 
42
  To reproduce our results, here is the commands you can run, using [v0.4.2](https://github.com/EleutherAI/lm-evaluation-harness/tree/v0.4.2) of the Eleuther AI Harness:
43
  ```
44
  python main.py --model=hf-causal-experimental
45
+ --model_args="pretrained=<your_model>,use_accelerate=True,revision=<your_model_revision>,dtype=<compute_dtype>"
46
  --tasks=<task_list>
47
  --num_fewshot=<n_few_shot>
48
  --batch_size=1
 
54
  - If model paramerters > 7B, we use `--batch_size 4`. If model parameters < 7B, we use `--batch_size 2`. And we set `--batch_size 1` for llama.cpp. You can expect results to vary slightly for different batch sizes because of padding.
55
 
56
 
 
57
  ### The tasks and few shots parameters are:
58
  - ARC-C: 0-shot, *arc_challenge* (`acc`)
59
  - ARC-E: 0-shot, *arc_easy* (`acc`)
 
75
 
76
  ### Quantization
77
  To get more information about quantization, see:
78
+ - neural-compressor: [intel/neural-compressor](https://github.com/intel/neural-compressor/tree/master)
79
  - 4 bits: [blog post](https://huggingface.co/blog/4bit-transformers-bitsandbytes), [paper](https://arxiv.org/abs/2305.14314)
80
 
 
 
 
 
81
  ### Other cool leaderboards:
82
  - [LLM safety](https://huggingface.co/spaces/AI-Secure/llm-trustworthy-leaderboard)
83
  - [LLM performance](https://huggingface.co/spaces/optimum/llm-perf-leaderboard)
84
+ - [Open LLM Leaderboard](https://huggingface.co/spaces/HuggingFaceH4/open_llm_leaderboard)
85
 
86
 
87
  """
 
90
 
91
  ## SUBMISSIONS
92
  My model requires `trust_remote_code=True`, can I submit it?
93
+ - *Yes, we want to support the newest models.*
 
 
 
94
 
95
  How can I follow when my model is launched?
96
+ - *You can look for its request file [here](https://huggingface.co/datasets/Intel/ld_requests) and follow the status evolution, or directly in the queues above the submit form.*
97
 
98
  My model disappeared from all the queues, what happened?
99
+ - *A model disappearing from all the queues usually means that there has been a failure. You can check if that is the case by looking for your model [here](https://huggingface.co/datasets/Intel/ld_requests).*
100
 
101
  What causes an evaluation failure?
102
+ - *Most of the failures we get come from problems in the submissions (not quantization model, corrupted files, config problems, wrong parameters selected for eval ...), so we'll be grateful if you first make sure you have followed the steps in `About`. However, from time to time, we have failures on our side (hardware/node failures, problem with an update of our backend, connectivity problem ending up in the results not being saved, ...).*
103
 
104
  How can I report an evaluation failure?
105
+ - *As we store the logs for all models, feel free to create an issue, **where you link to the requests file of your model** (look for it [here](https://huggingface.co/datasets/Intel/ld_requests)), so we can investigate! If the model failed due to a problem on our side, we'll relaunch it right away!*
106
  *Note: Please do not re-upload your model under a different name, it will not help*
107
 
108
  ---------------------------
109
 
110
  ## RESULTS
111
  What kind of information can I find?
112
+ - *Let's imagine you are interested in the Solar-10.7B results. You have access to 2 different information categories:*
113
+ - *The [request file](https://huggingface.co/datasets/Intel/ld_requests/blob/main/TheBloke/SOLAR-10.7B-Instruct-v1.0-GPTQ_eval_request_False_GPTQ_4bit_int4_float16.json): it gives you information about the status of the evaluation*
114
+ - *The [aggregated results folder](https://huggingface.co/datasets/Intel/ld_results/blob/main/TheBloke/): it gives you aggregated scores, per experimental run*
 
115
 
116
 
117
  Why do models appear several times in the leaderboard?
118
  - *We run evaluations with user selected precision and model commit. Sometimes, users submit specific models at different commits and at different precisions (for example, in float16 and 4bit to see how quantization affects performance). You should be able to verify this by displaying the `precision` and `model sha` columns in the display. If, however, you see models appearing several time with the same precision and hash commit, this is not normal.*
119
 
 
 
 
 
 
120
 
121
  ---------------------------
122
 
 
124
  I upgraded my model and want to re-submit, how can I do that?
125
  - *Please open an issue with the precise name of your model, and we'll remove your model from the leaderboard so you can resubmit. You can also resubmit directly with the new commit hash!*
126
 
 
 
 
127
  ---------------------------
128
 
129
  ## OTHER
 
 
 
 
 
 
 
 
 
 
130
 
131
  I have an issue about accessing the leaderboard through the Gradio API
132
  - *Since this is not the recommended way to access the leaderboard, we won't provide support for this, but you can look at tools provided by the community for inspiration!*
 
166
  ### 4) Fill up your model card
167
  When we add extra information about models to the leaderboard, it will be automatically taken from the model card
168
 
169
+ ### 5) Select the compute dtype
170
+ The compute dtype will pass to `lm-eval` for the inference. Currently, we only support float16 and bfloat16. Other selections will supported soon.
171
 
172
  """
173
 
 
181
  url={https://arxiv.org/abs/2309.05516}
182
  }
183
  @software{neural-compressor,
184
+ title = Intel® Neural Compressor,
185
  publisher = {Intel},
186
  url = {https://github.com/intel/neural-compressor/tree/master}
187
  }
src/display/utils.py CHANGED
@@ -55,14 +55,14 @@ auto_eval_column_dict.append(["model_size", ColumnContent, ColumnContent("#Size
55
  # Dummy column for the search bar (hidden by the custom CSS)
56
  auto_eval_column_dict.append(["dummy", ColumnContent, ColumnContent("model_name_for_query", "str", False, dummy=True)])
57
  # Model information
58
- auto_eval_column_dict.append(["model_type", ColumnContent, ColumnContent("Type", "str", False)])
59
  auto_eval_column_dict.append(["architecture", ColumnContent, ColumnContent("Architecture", "str", False)])
60
  auto_eval_column_dict.append(["weight_type", ColumnContent, ColumnContent("Weight type", "str", False, True)])
61
  auto_eval_column_dict.append(["quant_type", ColumnContent, ColumnContent("Quant type", "str", False)])
62
  auto_eval_column_dict.append(["precision", ColumnContent, ColumnContent("Precision", "str", False)])
63
  auto_eval_column_dict.append(["weight_dtype", ColumnContent, ColumnContent("Weight dtype", "str", False)])
64
  auto_eval_column_dict.append(["compute_dtype", ColumnContent, ColumnContent("Compute dtype", "str", False)])
65
- auto_eval_column_dict.append(["merged", ColumnContent, ColumnContent("Merged", "bool", False)])
66
  auto_eval_column_dict.append(["license", ColumnContent, ColumnContent("Hub License", "str", False)])
67
  # auto_eval_column_dict.append(["params", ColumnContent, ColumnContent("#Params (B)", "number", False)])
68
  auto_eval_column_dict.append(["likes", ColumnContent, ColumnContent("Hub ❤️", "number", False)])
@@ -244,10 +244,10 @@ class WeightDtype(Enum):
244
  return WeightDtype.Unknown
245
 
246
  class ComputeDtype(Enum):
 
247
  bf16 = ModelDetails("bfloat16")
248
  int8 = ModelDetails("int8")
249
  fp32 = ModelDetails("float32")
250
- fp16 = ModelDetails("float16")
251
 
252
  Unknown = ModelDetails("?")
253
 
 
55
  # Dummy column for the search bar (hidden by the custom CSS)
56
  auto_eval_column_dict.append(["dummy", ColumnContent, ColumnContent("model_name_for_query", "str", False, dummy=True)])
57
  # Model information
58
+ auto_eval_column_dict.append(["model_type", ColumnContent, ColumnContent("Type", "str", False, hidden=True)])
59
  auto_eval_column_dict.append(["architecture", ColumnContent, ColumnContent("Architecture", "str", False)])
60
  auto_eval_column_dict.append(["weight_type", ColumnContent, ColumnContent("Weight type", "str", False, True)])
61
  auto_eval_column_dict.append(["quant_type", ColumnContent, ColumnContent("Quant type", "str", False)])
62
  auto_eval_column_dict.append(["precision", ColumnContent, ColumnContent("Precision", "str", False)])
63
  auto_eval_column_dict.append(["weight_dtype", ColumnContent, ColumnContent("Weight dtype", "str", False)])
64
  auto_eval_column_dict.append(["compute_dtype", ColumnContent, ColumnContent("Compute dtype", "str", False)])
65
+ auto_eval_column_dict.append(["merged", ColumnContent, ColumnContent("Merged", "bool", False, hidden=True)])
66
  auto_eval_column_dict.append(["license", ColumnContent, ColumnContent("Hub License", "str", False)])
67
  # auto_eval_column_dict.append(["params", ColumnContent, ColumnContent("#Params (B)", "number", False)])
68
  auto_eval_column_dict.append(["likes", ColumnContent, ColumnContent("Hub ❤️", "number", False)])
 
244
  return WeightDtype.Unknown
245
 
246
  class ComputeDtype(Enum):
247
+ fp16 = ModelDetails("float16")
248
  bf16 = ModelDetails("bfloat16")
249
  int8 = ModelDetails("int8")
250
  fp32 = ModelDetails("float32")
 
251
 
252
  Unknown = ModelDetails("?")
253
 
src/envs.py CHANGED
@@ -8,9 +8,9 @@ GIT_TOKEN = os.environ.get("GIT_TOKEN", None)
8
  GIT_REPO = os.environ.get("GIT_REPO", None)
9
 
10
  REPO_ID = "Intel/low-bit-leaderboard"
11
- QUEUE_REPO = "lvkaokao/ld_requests"
12
- DYNAMIC_INFO_REPO = "lvkaokao/dynamic_model_information"
13
- RESULTS_REPO = "lvkaokao/ld_results"
14
 
15
  IS_PUBLIC = bool(os.environ.get("IS_PUBLIC", True))
16
 
@@ -31,7 +31,6 @@ DYNAMIC_INFO_FILE_PATH = os.path.join(DYNAMIC_INFO_PATH, "model_infos.json")
31
  EVAL_REQUESTS_PATH_PRIVATE = "eval-queue-private"
32
  EVAL_RESULTS_PATH_PRIVATE = "eval-results-private"
33
 
34
- PATH_TO_COLLECTION = "lvkaokao/ld-best-models-66139bfb09f16e7347285dc2"
35
 
36
  # Rate limit variables
37
  RATE_LIMIT_PERIOD = 20
 
8
  GIT_REPO = os.environ.get("GIT_REPO", None)
9
 
10
  REPO_ID = "Intel/low-bit-leaderboard"
11
+ QUEUE_REPO = "Intel/ld_requests"
12
+ DYNAMIC_INFO_REPO = "Intel/dynamic_model_information"
13
+ RESULTS_REPO = "Intel/ld_results"
14
 
15
  IS_PUBLIC = bool(os.environ.get("IS_PUBLIC", True))
16
 
 
31
  EVAL_REQUESTS_PATH_PRIVATE = "eval-queue-private"
32
  EVAL_RESULTS_PATH_PRIVATE = "eval-results-private"
33
 
 
34
 
35
  # Rate limit variables
36
  RATE_LIMIT_PERIOD = 20