Behnamm commited on
Commit
34b4f04
1 Parent(s): 5db1e00

Update src/about.py

Browse files
Files changed (1) hide show
  1. src/about.py +46 -15
src/about.py CHANGED
@@ -46,11 +46,45 @@ Note: **We plan to release an evaluation framework soon in which the details and
46
 
47
  # Which evaluations are you running? how can people reproduce what you have?
48
  LLM_BENCHMARKS_TEXT = f"""
49
- ## How it works
50
-
51
- ## Reproducibility
52
- To reproduce our results, here is the commands you can run:
53
-
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
54
  """
55
 
56
  EVALUATION_QUEUE_TEXT = """
@@ -58,7 +92,7 @@ EVALUATION_QUEUE_TEXT = """
58
  ## Important Notes
59
 
60
  - Right now, the models added **are not automatically evaluated**. - We may support automatic evaluation in the future on our own clusters.
61
- An evaluation framework will be available in the future to help reproduce the results.
62
  - We only support models with **a causal language modeling head** for now.
63
 
64
  ## Don't forget to read the FAQ and the About tabs for more information!
@@ -76,23 +110,20 @@ If this step fails, follow the error messages to debug your model before submitt
76
 
77
  Note: make sure your model is public!
78
 
79
- ### 2) Convert your model weights to [safetensors](https://huggingface.co/docs/safetensors/index)
80
- It's a new format for storing weights which is safer and faster to load and use. It will also allow us to add the number of parameters of your model to the `Extended Viewer`!
81
-
82
- ### 3) Make sure your model has an open license!
83
  This is a leaderboard for Open LLMs, and we'd love for as many people as possible to know they can use your model 🤗
84
 
85
- ### 4) Fill up your model card
86
  When we add extra information about models to the leaderboard, it will be automatically taken from the model card
87
 
 
 
 
 
88
  ## In case of model failure
89
  If your model is displayed in the `FAILED` category, its execution stopped.
90
  Make sure you have followed the above steps first.
91
 
92
- ### 5) Select the correct precision
93
- 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).
94
-
95
-
96
  """
97
 
98
  CITATION_BUTTON_LABEL = "Copy the following snippet to cite these results"
 
46
 
47
  # Which evaluations are you running? how can people reproduce what you have?
48
  LLM_BENCHMARKS_TEXT = f"""
49
+ ## ABOUT
50
+ 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.
51
+ 🤗 Submit a model for automated evaluation on the 🤗 GPU cluster on the "Submit" page!
52
+ The leaderboard's backend runs the great [Eleuther AI Language Model Evaluation Harness](https://github.com/EleutherAI/lm-evaluation-harness) - read more details below!
53
+ ### Tasks
54
+ 📈 We evaluate models on 6 key benchmarks using the <a href="https://github.com/EleutherAI/lm-evaluation-harness" target="_blank"> Eleuther AI Language Model Evaluation Harness </a>, a unified framework to test generative language models on a large number of different evaluation tasks.
55
+ - <a href="https://arxiv.org/abs/1803.05457" target="_blank"> AI2 Reasoning Challenge </a> (25-shot) - a set of grade-school science questions.
56
+ - <a href="https://arxiv.org/abs/1905.07830" target="_blank"> HellaSwag </a> (10-shot) - a test of commonsense inference, which is easy for humans (~95%) but challenging for SOTA models.
57
+ - <a href="https://arxiv.org/abs/2009.03300" target="_blank"> MMLU </a> (5-shot) - a test to measure a text model's multitask accuracy. The test covers 57 tasks including elementary mathematics, US history, computer science, law, and more.
58
+ - <a href="https://arxiv.org/abs/2109.07958" target="_blank"> TruthfulQA </a> (0-shot) - a test to measure a model's propensity to reproduce falsehoods commonly found online. Note: TruthfulQA is technically a 6-shot task in the Harness because each example is prepended with 6 Q/A pairs, even in the 0-shot setting.
59
+ - <a href="https://arxiv.org/abs/1907.10641" target="_blank"> Winogrande </a> (5-shot) - an adversarial and difficult Winograd benchmark at scale, for commonsense reasoning.
60
+ - <a href="https://arxiv.org/abs/2110.14168" target="_blank"> GSM8k </a> (5-shot) - diverse grade school math word problems to measure a model's ability to solve multi-step mathematical reasoning problems.
61
+ For all these evaluations, a higher score is a better score.
62
+ We chose these benchmarks as they test a variety of reasoning and general knowledge across a wide variety of fields in 0-shot and few-shot settings.
63
+
64
+ ## REPRODUCIBILITY
65
+ To reproduce our results, here are the commands you can run, using [this version](https://github.com/EleutherAI/lm-evaluation-harness/tree/b281b0921b636bc36ad05c0b0b0763bd6dd43463) of the Eleuther AI Harness:
66
+ `python main.py --model=hf-causal-experimental --model_args="pretrained=<your_model>,use_accelerate=True,revision=<your_model_revision>"`
67
+ ` --tasks=<task_list> --num_fewshot=<n_few_shot> --batch_size=1 --output_path=<output_path>`
68
+ ```
69
+ python main.py --model=hf-causal-experimental \
70
+ --model_args="pretrained=<your_model>,use_accelerate=True,revision=<your_model_revision>" \
71
+ --tasks=<task_list> \
72
+ --num_fewshot=<n_few_shot> \
73
+ --batch_size=1 \
74
+ --output_path=<output_path>
75
+ ```
76
+ **Note:** We evaluate all models on a single node of 8 H100s, so the global batch size is 8 for each evaluation. If you don't use parallelism, adapt your batch size to fit.
77
+ *You can expect results to vary slightly for different batch sizes because of padding.*
78
+ The tasks and few shots parameters are:
79
+ - ARC: 25-shot, *arc-challenge* (`acc_norm`)
80
+ - HellaSwag: 10-shot, *hellaswag* (`acc_norm`)
81
+ - TruthfulQA: 0-shot, *truthfulqa-mc* (`mc2`)
82
+ - MMLU: 5-shot, *hendrycksTest-abstract_algebra,hendrycksTest-anatomy,hendrycksTest-astronomy,hendrycksTest-business_ethics,hendrycksTest-clinical_knowledge,hendrycksTest-college_biology,hendrycksTest-college_chemistry,hendrycksTest-college_computer_science,hendrycksTest-college_mathematics,hendrycksTest-college_medicine,hendrycksTest-college_physics,hendrycksTest-computer_security,hendrycksTest-conceptual_physics,hendrycksTest-econometrics,hendrycksTest-electrical_engineering,hendrycksTest-elementary_mathematics,hendrycksTest-formal_logic,hendrycksTest-global_facts,hendrycksTest-high_school_biology,hendrycksTest-high_school_chemistry,hendrycksTest-high_school_computer_science,hendrycksTest-high_school_european_history,hendrycksTest-high_school_geography,hendrycksTest-high_school_government_and_politics,hendrycksTest-high_school_macroeconomics,hendrycksTest-high_school_mathematics,hendrycksTest-high_school_microeconomics,hendrycksTest-high_school_physics,hendrycksTest-high_school_psychology,hendrycksTest-high_school_statistics,hendrycksTest-high_school_us_history,hendrycksTest-high_school_world_history,hendrycksTest-human_aging,hendrycksTest-human_sexuality,hendrycksTest-international_law,hendrycksTest-jurisprudence,hendrycksTest-logical_fallacies,hendrycksTest-machine_learning,hendrycksTest-management,hendrycksTest-marketing,hendrycksTest-medical_genetics,hendrycksTest-miscellaneous,hendrycksTest-moral_disputes,hendrycksTest-moral_scenarios,hendrycksTest-nutrition,hendrycksTest-philosophy,hendrycksTest-prehistory,hendrycksTest-professional_accounting,hendrycksTest-professional_law,hendrycksTest-professional_medicine,hendrycksTest-professional_psychology,hendrycksTest-public_relations,hendrycksTest-security_studies,hendrycksTest-sociology,hendrycksTest-us_foreign_policy,hendrycksTest-virology,hendrycksTest-world_religions* (average of all the results `acc`)
83
+ - Winogrande: 5-shot, *winogrande* (`acc`)
84
+ - GSM8k: 5-shot, *gsm8k* (`acc`)
85
+ Side note on the baseline scores:
86
+ - for log-likelihood evaluation, we select the random baseline
87
+ - for GSM8K, we select the score obtained in the paper after finetuning a 6B model on the full GSM8K training set for 50 epochs
88
  """
89
 
90
  EVALUATION_QUEUE_TEXT = """
 
92
  ## Important Notes
93
 
94
  - Right now, the models added **are not automatically evaluated**. - We may support automatic evaluation in the future on our own clusters.
95
+ - An evaluation framework will be available in the future to help everyone reproduce the results.
96
  - We only support models with **a causal language modeling head** for now.
97
 
98
  ## Don't forget to read the FAQ and the About tabs for more information!
 
110
 
111
  Note: make sure your model is public!
112
 
113
+ ### 2) Make sure your model has an open license!
 
 
 
114
  This is a leaderboard for Open LLMs, and we'd love for as many people as possible to know they can use your model 🤗
115
 
116
+ ### 3) Fill up your model card
117
  When we add extra information about models to the leaderboard, it will be automatically taken from the model card
118
 
119
+ ### 4) Select the correct precision
120
+ 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).
121
+
122
+
123
  ## In case of model failure
124
  If your model is displayed in the `FAILED` category, its execution stopped.
125
  Make sure you have followed the above steps first.
126
 
 
 
 
 
127
  """
128
 
129
  CITATION_BUTTON_LABEL = "Copy the following snippet to cite these results"