README.md 1011 Bytes
Newer Older
haileyschoelkopf's avatar
haileyschoelkopf committed
1
2
# Eval Harness Documentation

lintangsutawika's avatar
lintangsutawika committed
3
Welcome to the docs for the LM Evaluation Harness!
haileyschoelkopf's avatar
haileyschoelkopf committed
4
5
6

## Table of Contents

7
* To learn about the public interface of the library, as well as how to evaluate via the commandline or as integrated into an external library, see the [Interface](https://github.com/EleutherAI/lm-evaluation-harness/blob/big-refactor/docs/user_guide.md)
haileyschoelkopf's avatar
haileyschoelkopf committed
8
9
* To learn how to add a new library, API, or model type to the library, as well as a quick explainer on the types of ways to evaluate an LM, see the [Model Guide](https://github.com/EleutherAI/lm-evaluation-harness/blob/big-refactor/docs/model_guide.md).
* For a crash course on adding new tasks to the library, see our [New Task Guide](https://github.com/EleutherAI/lm-evaluation-harness/blob/big-refactor/docs/new_task_guide.md).
Hailey Schoelkopf's avatar
Hailey Schoelkopf committed
10
* To learn more about pushing the limits of task configuration that the Eval Harness supports, see the [Task Configuration Guide](https://github.com/EleutherAI/lm-evaluation-harness/blob/big-refactor/docs/task_guide.md).