# Evaluation Harness for Large Language Models

![](https://github.com/EleutherAI/lm-evaluation-harness/workflows/Build/badge.svg)
[![codecov](https://codecov.io/gh/EleutherAI/lm-evaluation-harness/branch/master/graph/badge.svg?token=JSG3O2427J)](https://codecov.io/gh/EleutherAI/lm-evaluation-harness)


**WARNING**: This project is currently under active development. Interfaces and task implementations may change rapidly and without warning. 

## Overview 

The goal of this project is to build a set of tools for evaluating LMs on typical NLU tasks, based on evaluation of GPT-3 as described in https://arxiv.org/pdf/2005.14165.pdf. Following the initial description, this repo should support 3 functions:
1. LM Evaluation
2. Removing task val/test data from LM training set
3. Adding task training data to LM training set

### Overview of Tasks

|                    Task Name                    |Train|Val|Test|Val/Test Docs|                                   Metrics                                    |
|-------------------------------------------------|-----|---|----|------------:|------------------------------------------------------------------------------|
|cola                                             |✓    |✓  |    |         1043|mcc                                                                           |
|mnli                                             |✓    |✓  |    |         9815|acc                                                                           |
|mnli_mismatched                                  |✓    |✓  |    |         9832|acc                                                                           |
|mrpc                                             |✓    |✓  |    |          408|acc, f1                                                                       |
|rte                                              |✓    |✓  |    |          277|acc                                                                           |
|qnli                                             |✓    |✓  |    |         5463|acc                                                                           |
|qqp                                              |✓    |✓  |    |        40430|acc, f1                                                                       |
|sst                                              |✓    |✓  |    |          872|acc                                                                           |
|wnli                                             |✓    |✓  |    |           71|acc                                                                           |
|boolq                                            |✓    |✓  |    |         3270|acc                                                                           |
|cb                                               |✓    |✓  |    |           56|acc, f1                                                                       |
|copa                                             |✓    |✓  |    |          100|acc                                                                           |
|multirc                                          |✓    |✓  |    |         4848|acc                                                                           |
|record                                           |✓    |✓  |    |        10000|f1, em                                                                        |
|wic                                              |✓    |✓  |    |          638|acc                                                                           |
|wsc                                              |✓    |✓  |    |          104|acc                                                                           |
|coqa                                             |✓    |✓  |    |          500|f1, em                                                                        |
|drop                                             |✓    |✓  |    |         9536|em, f1                                                                        |
|lambada                                          |     |✓  |    |         5153|ppl, acc                                                                      |
|lambada_cloze                                    |     |✓  |    |         5153|ppl, acc                                                                      |
|piqa                                             |✓    |✓  |    |         1838|acc, acc_norm                                                                 |
|pubmedqa                                         |     |   |✓   |         1000|acc                                                                           |
|sciq                                             |✓    |✓  |✓   |         1000|acc, acc_norm                                                                 |
|qa4mre_2011                                      |     |   |✓   |          120|acc, acc_norm                                                                 |
|qa4mre_2012                                      |     |   |✓   |          160|acc, acc_norm                                                                 |
|qa4mre_2013                                      |     |   |✓   |          284|acc, acc_norm                                                                 |
|arc_easy                                         |✓    |✓  |✓   |         2376|acc, acc_norm                                                                 |
|arc_challenge                                    |✓    |✓  |✓   |         1172|acc, acc_norm                                                                 |
|logiqa                                           |✓    |✓  |✓   |          651|acc, acc_norm                                                                 |
|hellaswag                                        |✓    |✓  |    |        10042|acc, acc_norm                                                                 |
|openbookqa                                       |✓    |✓  |✓   |          500|acc, acc_norm                                                                 |
|squad2                                           |✓    |✓  |    |        11873|exact, f1, HasAns_exact, HasAns_f1, NoAns_exact, NoAns_f1, best_exact, best_f1|
|race                                             |✓    |✓  |✓   |         1045|acc                                                                           |
|headqa                                           |✓    |✓  |✓   |         2742|acc, acc_norm                                                                 |
|mathqa                                           |✓    |✓  |✓   |         2985|acc, acc_norm                                                                 |
|webqs                                            |✓    |   |✓   |         2032|acc                                                                           |
|wsc273                                           |     |   |✓   |          273|acc                                                                           |
|winogrande                                       |✓    |✓  |    |         1267|acc                                                                           |
|anli_r1                                          |✓    |✓  |✓   |         1000|acc                                                                           |
|anli_r2                                          |✓    |✓  |✓   |         1000|acc                                                                           |
|anli_r3                                          |✓    |✓  |✓   |         1200|acc                                                                           |
|ethics_cm                                        |✓    |   |✓   |         3885|acc                                                                           |
|ethics_deontology                                |✓    |   |✓   |         3596|acc, em                                                                       |
|ethics_justice                                   |✓    |   |✓   |         2704|acc, em                                                                       |
|ethics_utilitarianism_original                   |     |   |✓   |         4808|acc                                                                           |
|ethics_utilitarianism                            |✓    |   |✓   |         4808|acc                                                                           |
|ethics_virtue                                    |✓    |   |✓   |         4975|acc, em                                                                       |
|math_algebra                                     |✓    |   |✓   |         1187|acc                                                                           |
|math_counting_and_prob                           |✓    |   |✓   |          474|acc                                                                           |
|math_geometry                                    |✓    |   |✓   |          479|acc                                                                           |
|math_intermediate_algebra                        |✓    |   |✓   |          903|acc                                                                           |
|math_num_theory                                  |✓    |   |✓   |          540|acc                                                                           |
|math_prealgebra                                  |✓    |   |✓   |          871|acc                                                                           |
|math_precalc                                     |✓    |   |✓   |          546|acc                                                                           |
|arithmetic_2da                                   |     |✓  |    |         2000|acc                                                                           |
|arithmetic_2ds                                   |     |✓  |    |         2000|acc                                                                           |
|arithmetic_3da                                   |     |✓  |    |         2000|acc                                                                           |
|arithmetic_3ds                                   |     |✓  |    |         2000|acc                                                                           |
|arithmetic_4da                                   |     |✓  |    |         2000|acc                                                                           |
|arithmetic_4ds                                   |     |✓  |    |         2000|acc                                                                           |
|arithmetic_5da                                   |     |✓  |    |         2000|acc                                                                           |
|arithmetic_5ds                                   |     |✓  |    |         2000|acc                                                                           |
|arithmetic_2dm                                   |     |✓  |    |         2000|acc                                                                           |
|arithmetic_1dc                                   |     |✓  |    |         2000|acc                                                                           |
|hendrycksTest-abstract_algebra                   |✓    |✓  |✓   |          100|acc, acc_norm                                                                 |
|hendrycksTest-anatomy                            |✓    |✓  |✓   |          135|acc, acc_norm                                                                 |
|hendrycksTest-astronomy                          |✓    |✓  |✓   |          152|acc, acc_norm                                                                 |
|hendrycksTest-business_ethics                    |✓    |✓  |✓   |          100|acc, acc_norm                                                                 |
|hendrycksTest-clinical_knowledge                 |✓    |✓  |✓   |          265|acc, acc_norm                                                                 |
|hendrycksTest-college_biology                    |✓    |✓  |✓   |          144|acc, acc_norm                                                                 |
|hendrycksTest-college_chemistry                  |✓    |✓  |✓   |          100|acc, acc_norm                                                                 |
|hendrycksTest-college_computer_science           |✓    |✓  |✓   |          100|acc, acc_norm                                                                 |
|hendrycksTest-college_mathematics                |✓    |✓  |✓   |          100|acc, acc_norm                                                                 |
|hendrycksTest-college_medicine                   |✓    |✓  |✓   |          173|acc, acc_norm                                                                 |
|hendrycksTest-college_physics                    |✓    |✓  |✓   |          102|acc, acc_norm                                                                 |
|hendrycksTest-computer_security                  |✓    |✓  |✓   |          100|acc, acc_norm                                                                 |
|hendrycksTest-conceptual_physics                 |✓    |✓  |✓   |          235|acc, acc_norm                                                                 |
|hendrycksTest-econometrics                       |✓    |✓  |✓   |          114|acc, acc_norm                                                                 |
|hendrycksTest-electrical_engineering             |✓    |✓  |✓   |          145|acc, acc_norm                                                                 |
|hendrycksTest-elementary_mathematics             |✓    |✓  |✓   |          378|acc, acc_norm                                                                 |
|hendrycksTest-formal_logic                       |✓    |✓  |✓   |          126|acc, acc_norm                                                                 |
|hendrycksTest-global_facts                       |✓    |✓  |✓   |          100|acc, acc_norm                                                                 |
|hendrycksTest-high_school_biology                |✓    |✓  |✓   |          310|acc, acc_norm                                                                 |
|hendrycksTest-high_school_chemistry              |✓    |✓  |✓   |          203|acc, acc_norm                                                                 |
|hendrycksTest-high_school_computer_science       |✓    |✓  |✓   |          100|acc, acc_norm                                                                 |
|hendrycksTest-high_school_european_history       |✓    |✓  |✓   |          165|acc, acc_norm                                                                 |
|hendrycksTest-high_school_geography              |✓    |✓  |✓   |          198|acc, acc_norm                                                                 |
|hendrycksTest-high_school_government_and_politics|✓    |✓  |✓   |          193|acc, acc_norm                                                                 |
|hendrycksTest-high_school_macroeconomics         |✓    |✓  |✓   |          390|acc, acc_norm                                                                 |
|hendrycksTest-high_school_mathematics            |✓    |✓  |✓   |          270|acc, acc_norm                                                                 |
|hendrycksTest-high_school_microeconomics         |✓    |✓  |✓   |          238|acc, acc_norm                                                                 |
|hendrycksTest-high_school_physics                |✓    |✓  |✓   |          151|acc, acc_norm                                                                 |
|hendrycksTest-high_school_psychology             |✓    |✓  |✓   |          545|acc, acc_norm                                                                 |
|hendrycksTest-high_school_statistics             |✓    |✓  |✓   |          216|acc, acc_norm                                                                 |
|hendrycksTest-high_school_us_history             |✓    |✓  |✓   |          204|acc, acc_norm                                                                 |
|hendrycksTest-high_school_world_history          |✓    |✓  |✓   |          237|acc, acc_norm                                                                 |
|hendrycksTest-human_aging                        |✓    |✓  |✓   |          223|acc, acc_norm                                                                 |
|hendrycksTest-human_sexuality                    |✓    |✓  |✓   |          131|acc, acc_norm                                                                 |
|hendrycksTest-international_law                  |✓    |✓  |✓   |          121|acc, acc_norm                                                                 |
|hendrycksTest-jurisprudence                      |✓    |✓  |✓   |          108|acc, acc_norm                                                                 |
|hendrycksTest-logical_fallacies                  |✓    |✓  |✓   |          163|acc, acc_norm                                                                 |
|hendrycksTest-machine_learning                   |✓    |✓  |✓   |          112|acc, acc_norm                                                                 |
|hendrycksTest-management                         |✓    |✓  |✓   |          103|acc, acc_norm                                                                 |
|hendrycksTest-marketing                          |✓    |✓  |✓   |          234|acc, acc_norm                                                                 |
|hendrycksTest-medical_genetics                   |✓    |✓  |✓   |          100|acc, acc_norm                                                                 |
|hendrycksTest-miscellaneous                      |✓    |✓  |✓   |          783|acc, acc_norm                                                                 |
|hendrycksTest-moral_disputes                     |✓    |✓  |✓   |          346|acc, acc_norm                                                                 |
|hendrycksTest-moral_scenarios                    |✓    |✓  |✓   |          895|acc, acc_norm                                                                 |
|hendrycksTest-nutrition                          |✓    |✓  |✓   |          306|acc, acc_norm                                                                 |
|hendrycksTest-philosophy                         |✓    |✓  |✓   |          311|acc, acc_norm                                                                 |
|hendrycksTest-prehistory                         |✓    |✓  |✓   |          324|acc, acc_norm                                                                 |
|hendrycksTest-professional_accounting            |✓    |✓  |✓   |          282|acc, acc_norm                                                                 |
|hendrycksTest-professional_law                   |✓    |✓  |✓   |         1534|acc, acc_norm                                                                 |
|hendrycksTest-professional_medicine              |✓    |✓  |✓   |          272|acc, acc_norm                                                                 |
|hendrycksTest-professional_psychology            |✓    |✓  |✓   |          612|acc, acc_norm                                                                 |
|hendrycksTest-public_relations                   |✓    |✓  |✓   |          110|acc, acc_norm                                                                 |
|hendrycksTest-security_studies                   |✓    |✓  |✓   |          245|acc, acc_norm                                                                 |
|hendrycksTest-sociology                          |✓    |✓  |✓   |          201|acc, acc_norm                                                                 |
|hendrycksTest-us_foreign_policy                  |✓    |✓  |✓   |          100|acc, acc_norm                                                                 |
|hendrycksTest-virology                           |✓    |✓  |✓   |          166|acc, acc_norm                                                                 |
|hendrycksTest-world_religions                    |✓    |✓  |✓   |          171|acc, acc_norm                                                                 |
|wmt14-en-fr                                      |     |   |✓   |         3003|bleu, chrf, ter                                                               |
|wmt14-fr-en                                      |     |   |✓   |         3003|bleu, chrf, ter                                                               |
|wmt16-en-ro                                      |     |   |✓   |         1999|bleu, chrf, ter                                                               |
|wmt16-ro-en                                      |     |   |✓   |         1999|bleu, chrf, ter                                                               |
|wmt16-de-en                                      |     |   |✓   |         2999|bleu, chrf, ter                                                               |
|wmt16-en-de                                      |     |   |✓   |         2999|bleu, chrf, ter                                                               |
|wmt20-cs-en                                      |     |   |✓   |          664|bleu, chrf, ter                                                               |
|wmt20-de-en                                      |     |   |✓   |          785|bleu, chrf, ter                                                               |
|wmt20-de-fr                                      |     |   |✓   |         1619|bleu, chrf, ter                                                               |
|wmt20-en-cs                                      |     |   |✓   |         1418|bleu, chrf, ter                                                               |
|wmt20-en-de                                      |     |   |✓   |         1418|bleu, chrf, ter                                                               |
|wmt20-en-iu                                      |     |   |✓   |         2971|bleu, chrf, ter                                                               |
|wmt20-en-ja                                      |     |   |✓   |         1000|bleu, chrf, ter                                                               |
|wmt20-en-km                                      |     |   |✓   |         2320|bleu, chrf, ter                                                               |
|wmt20-en-pl                                      |     |   |✓   |         1000|bleu, chrf, ter                                                               |
|wmt20-en-ps                                      |     |   |✓   |         2719|bleu, chrf, ter                                                               |
|wmt20-en-ru                                      |     |   |✓   |         2002|bleu, chrf, ter                                                               |
|wmt20-en-ta                                      |     |   |✓   |         1000|bleu, chrf, ter                                                               |
|wmt20-en-zh                                      |     |   |✓   |         1418|bleu, chrf, ter                                                               |
|wmt20-fr-de                                      |     |   |✓   |         1619|bleu, chrf, ter                                                               |
|wmt20-iu-en                                      |     |   |✓   |         2971|bleu, chrf, ter                                                               |
|wmt20-ja-en                                      |     |   |✓   |          993|bleu, chrf, ter                                                               |
|wmt20-km-en                                      |     |   |✓   |         2320|bleu, chrf, ter                                                               |
|wmt20-pl-en                                      |     |   |✓   |         1001|bleu, chrf, ter                                                               |
|wmt20-ps-en                                      |     |   |✓   |         2719|bleu, chrf, ter                                                               |
|wmt20-ru-en                                      |     |   |✓   |          991|bleu, chrf, ter                                                               |
|wmt20-ta-en                                      |     |   |✓   |          997|bleu, chrf, ter                                                               |
|wmt20-zh-en                                      |     |   |✓   |         2000|bleu, chrf, ter                                                               |
|iwslt17-en-ar                                    |     |   |✓   |         1460|bleu, chrf, ter                                                               |
|iwslt17-ar-en                                    |     |   |✓   |         1460|bleu, chrf, ter                                                               |
|anagrams1                                        |     |✓  |    |        10000|acc                                                                           |
|anagrams2                                        |     |✓  |    |        10000|acc                                                                           |
|cycle_letters                                    |     |✓  |    |        10000|acc                                                                           |
|random_insertion                                 |     |✓  |    |        10000|acc                                                                           |
|reversed_words                                   |     |✓  |    |        10000|acc                                                                           |
|pile_arxiv                                       |     |✓  |✓   |         2407|word_perplexity, byte_perplexity, bits_per_byte                               |
|pile_books3                                      |     |✓  |✓   |          269|word_perplexity, byte_perplexity, bits_per_byte                               |
|pile_bookcorpus2                                 |     |✓  |✓   |           28|word_perplexity, byte_perplexity, bits_per_byte                               |
|pile_dm-mathematics                              |     |✓  |✓   |         1922|word_perplexity, byte_perplexity, bits_per_byte                               |
|pile_enron                                       |     |✓  |✓   |         1010|word_perplexity, byte_perplexity, bits_per_byte                               |
|pile_europarl                                    |     |✓  |✓   |          157|word_perplexity, byte_perplexity, bits_per_byte                               |
|pile_freelaw                                     |     |✓  |✓   |         5101|word_perplexity, byte_perplexity, bits_per_byte                               |
|pile_github                                      |     |✓  |✓   |        18195|word_perplexity, byte_perplexity, bits_per_byte                               |
|pile_gutenberg                                   |     |✓  |✓   |           80|word_perplexity, byte_perplexity, bits_per_byte                               |
|pile_hackernews                                  |     |✓  |✓   |         1632|word_perplexity, byte_perplexity, bits_per_byte                               |
|pile_nih-exporter                                |     |✓  |✓   |         1884|word_perplexity, byte_perplexity, bits_per_byte                               |
|pile_opensubtitles                               |     |✓  |✓   |          642|word_perplexity, byte_perplexity, bits_per_byte                               |
|pile_openwebtext2                                |     |✓  |✓   |        32925|word_perplexity, byte_perplexity, bits_per_byte                               |
|pile_philpapers                                  |     |✓  |✓   |           68|word_perplexity, byte_perplexity, bits_per_byte                               |
|pile_pile-cc                                     |     |✓  |✓   |        52790|word_perplexity, byte_perplexity, bits_per_byte                               |
|pile_pubmed-abstracts                            |     |✓  |✓   |        29895|word_perplexity, byte_perplexity, bits_per_byte                               |
|pile_pubmed-central                              |     |✓  |✓   |         5911|word_perplexity, byte_perplexity, bits_per_byte                               |
|pile_stackexchange                               |     |✓  |✓   |        30378|word_perplexity, byte_perplexity, bits_per_byte                               |
|pile_uspto                                       |     |✓  |✓   |        11415|word_perplexity, byte_perplexity, bits_per_byte                               |
|pile_ubuntu-irc                                  |     |✓  |✓   |           22|word_perplexity, byte_perplexity, bits_per_byte                               |
|pile_wikipedia                                   |     |✓  |✓   |        17511|word_perplexity, byte_perplexity, bits_per_byte                               |
|pile_youtubesubtitles                            |     |✓  |✓   |          342|word_perplexity, byte_perplexity, bits_per_byte                               |



## Usage

### Evaluate a task

To evaluate a model, (e.g. GPT-2) on NLU tasks (e.g. RTE, Winograd Scheme Challenge), you can run the following command.

```bash
python main.py \
	--model gpt2 \
	--model_args device=cuda:0 \
	--tasks rte,wsc \
	--provide_description \
	--num_fewshot 2
```

If you have access to an OpenAI API key, you can also evaluate GPT-3 on various tasks with the following command:

```bash
export OPENAI_API_SECRET_KEY=YOUR_KEY_HERE
python main.py \
	--model gpt3 \
	--tasks rte,wsc \
	--provide_description \
	--num_fewshot 2
```

To inspect what the LM inputs look like, you can run the following command:

```bash
python write_out.py \
	--tasks all_tasks \
	--provide_description \
	--num_fewshot 5 \
	--num_examples 10 \
	--output_base_path /path/to/output/folder
```

This will write out one text file for each task.

### Code Structure

There are two major components of the library:

1. LMs (language models), e.g. GPT-2, GPT-3
2. Tasks, e.g. MNLI, RTE, SQuAD (coming soon)

Both LMs (`lm_eval.models`) and Tasks (`lm_eval.tasks`) are kept in a registry data structure, for easy CLI instantiation.

**If you want to extend either models or tasks, simply add a new LM or Task subclass, and decorate with the registry decorator**.

The [GPT-3 Evaluations Project](https://github.com/EleutherAI/lm_evaluation_harness/projects/1) tracks our progress implementing new tasks. Right now, we are focused on getting all the datasets loaded so that we can dedupe against the training data. Implementing the actual evaluations is nice but not necessary at the current moment.

## Description

### 1. LM Evaluation
Given an LM, we want to evaluate it on a wide range of NLU tasks. We should at least cover the set of tasks in the GPT-3 paper, and any other tasks/benchmarks that are relevant. We will follow the GPT-3 format of a) zero-shot, b) one-shot, c) few-shot evaluation.

To do this, we need 3 components:
* Data downloader (shared with later sections, potentially needs to be directly linked to the latter 2 components)
* Task formatter
* Task evaluator

The **data downloader** should download data for the relevant tasks.
* We should heavily rely on Hugging Face's NLP for this. They are already doing most of the work with handling data scripts/caching.
* Optionally, we can rely directly on HF-NLP's caching, but that makes it awkward to handle non-HF-NLP datasets. Otherwise, we can just write them out to .jsonl. My feeling is that NLU data storage will be a drop in the bucket compared to LM data.
* Where we're not using HF-NLP, we can keep the data in the raw format (.jsonl, tsv, etc) and let the other components handle transforming it.

The **task formatter** formats the task input data into an LM-usable format.
* We should potentially support multiple formats for a given task, e.g. some formats may be better or worse suited for LM evaluation. See also: prompt-engineering
* The task formatter should also support zero/one/few-shot packing of training examples into an input. This may require weird interactions with the tokenizer for dealing with max-token issues.

The **task evaluator** scores a task.
* In essence, we want to generation output predictions for all our input examples, and feed them into some function that pops out a score (or scores)
An alternative approach is to collect the output logits and score them against the expected set of outputs.
* Some tasks have weird evaluation schemes, so we should make this as general as possible.
* Will thus likely have to be closely tied with the formatter.
* Likewise, we should take advantage of HF-NLP's metrics.
We might as well provide a sufficiently general API for the model to support OpenAI API as well. This can double up as an effort to reproduce the OpenAI NLU results.

### 2. Removing val/test data from LM training set
With the data downloader in place, we simply need to (1) expose the val/test examples, and (2) remove them from the training set.

* Arguably, (2) should be handled by LM preprocessing in a more general way. There are probably non-NLU-eval cases where we want to remove some specific data from training.
* Depending on how exactly we do the val/test removal, we may want to format the same example multiple ways to ensure that they don't get leaked into the training set in a slightly tweaked format.
* Thought experiment: SQuAD is based largely on Wikipedia. What exactly would we want to remove from the LM?
* [GPT-3]: In GPT-3, they attempted to remove val/test from their LM set, but there was a bug that caused leakage. So they ended up doing the opposite: removing overlaps from the LM set from the val/test. Funky.
* [GPT-3]: See page 30 and Appendix C for details. They do some funky n-gram based search and removal. We should think about whether we want to follow their protocol exactly

### 3. Adding task training data to LM training set
This part is the easiest. I guess we just write out some text files containing the training data? We can let the usual LM preprocessing pipeline handle it from there.
