• Stars
    star
    13,483
  • Rank 2,170 (Top 0.05 %)
  • Language
    Python
  • License
    Other
  • Created over 1 year ago
  • Updated about 2 months ago

Reviews

There are no reviews yet. Be the first to send feedback to the community and the maintainers!

Repository Details

Evals is a framework for evaluating LLMs and LLM systems, and an open-source registry of benchmarks.

Evals

Evals is a framework for evaluating LLMs (large language models) or systems built using LLMs as components. It also includes an open-source registry of challenging evals.

We now support evaluating the behavior of any system including prompt chains or tool-using agents, via the Completion Function Protocol.

With Evals, we aim to make it as simple as possible to build an eval while writing as little code as possible. An "eval" is a task used to evaluate the quality of a system's behavior. To get started, we recommend that you follow these steps:

To get set up with evals, follow the setup instructions below.

Running evals

Writing evals

Important: Please note that we are currently not accepting Evals with custom code! While we ask you to not submit such evals at the moment, you can still submit modelgraded evals with custom modelgraded YAML files.

Writing CompletionFns

If you think you have an interesting eval, please open a PR with your contribution. OpenAI staff actively review these evals when considering improvements to upcoming models.


🚨 For a limited time, we will be granting GPT-4 access to those who contribute high quality evals. Please follow the instructions mentioned above and note that spam or low quality submissions will be ignored❗️

Access will be granted to the email address associated with an accepted Eval. Due to high volume, we are unable to grant access to any email other than the one used for the pull request.


Setup

To run evals, you will need to set up and specify your OpenAI API key. You can generate one at https://platform.openai.com/account/api-keys. After you obtain an API key, specify it using the OPENAI_API_KEY environment variable. Please be aware of the costs associated with using the API when running evals.

Minimum Required Version: Python 3.9

Downloading evals

Our Evals registry is stored using Git-LFS. Once you have downloaded and installed LFS, you can fetch the evals (from within your local copy of the evals repo) with:

cd evals
git lfs fetch --all
git lfs pull

This will populate all the pointer files under evals/registry/data.

You may just want to fetch data for a select eval. You can achieve this via:

git lfs fetch --include=evals/registry/data/${your eval}
git lfs pull

Making evals

If you are going to be creating evals, we suggest cloning this repo directly from GitHub and installing the requirements using the following command:

pip install -e .

Using -e, changes you make to your eval will be reflected immediately without having to reinstall.

Optionally, you can install the formatters for pre-committing with:

pip install -e .[formatters]

Running evals

If you don't want to contribute new evals, but simply want to run them locally, you can install the evals package via pip:

pip install evals

We provide the option for you to log your eval results to a Snowflake database, if you have one or wish to set one up. For this option, you will further have to specify the SNOWFLAKE_ACCOUNT, SNOWFLAKE_DATABASE, SNOWFLAKE_USERNAME, and SNOWFLAKE_PASSWORD environment variables.

FAQ

Do you have any examples of how to build an eval from start to finish?

  • Yes! These are in the examples folder. We recommend that you also read through build-eval.md in order to gain a deeper understanding of what is happening in these examples.

Do you have any examples of evals implemented in multiple different ways?

  • Yes! In particular, see evals/registry/evals/coqa.yaml. We have implemented small subsets of the CoQA dataset for various eval templates to help illustrate the differences.

When I run an eval, it sometimes hangs at the very end (after the final report). What's going on?

  • This is a known issue, but you should be able to interrupt it safely and the eval should finish immediately after.

There's a lot of code, and I just want to spin up a quick eval. Help? OR,

I am a world-class prompt engineer. I choose not to code. How can I contribute my wisdom?

  • If you follow an existing eval template to build a basic or model-graded eval, you don't need to write any evaluation code at all! Just provide your data in JSON format and specify your eval parameters in YAML. build-eval.md walks you through these steps, and you can supplement these instructions with the Jupyter notebooks in the examples folder to help you get started quickly. Keep in mind, though, that a good eval will inevitably require careful thought and rigorous experimentation!

Disclaimer

By contributing to Evals, you are agreeing to make your evaluation logic and data under the same MIT license as this repository. You must have adequate rights to upload any data used in an Eval. OpenAI reserves the right to use this data in future service improvements to our product. Contributions to OpenAI Evals will be subject to our usual Usage Policies: https://platform.openai.com/docs/usage-policies.

More Repositories

1

whisper

Robust Speech Recognition via Large-Scale Weak Supervision
Python
57,624
star
2

openai-cookbook

Examples and guides for using the OpenAI API
MDX
55,428
star
3

gym

A toolkit for developing and comparing reinforcement learning algorithms.
Python
33,715
star
4

CLIP

CLIP (Contrastive Language-Image Pretraining), Predict the most relevant text snippet given an image
Jupyter Notebook
21,231
star
5

gpt-2

Code for the paper "Language Models are Unsupervised Multitask Learners"
Python
20,844
star
6

chatgpt-retrieval-plugin

The ChatGPT Retrieval Plugin lets you easily find personal or work documents by asking questions in natural language.
Python
20,818
star
7

openai-python

The official Python library for the OpenAI API
Python
19,939
star
8

gpt-3

GPT-3: Language Models are Few-Shot Learners
15,573
star
9

baselines

OpenAI Baselines: high-quality implementations of reinforcement learning algorithms
Python
15,252
star
10

triton

Development repository for the Triton language and compiler
C++
11,038
star
11

DALL-E

PyTorch package for the discrete VAE used for DALL·E.
Python
10,672
star
12

shap-e

Generate 3D objects conditioned on text or images
Python
10,285
star
13

spinningup

An educational resource to help anyone learn deep reinforcement learning.
Python
8,587
star
14

tiktoken

tiktoken is a fast BPE tokeniser for use with OpenAI's models.
Python
8,533
star
15

universe

Universe: a software platform for measuring and training an AI's general intelligence across the world's supply of games, websites and other applications.
Python
7,385
star
16

jukebox

Code for the paper "Jukebox: A Generative Model for Music"
Python
7,326
star
17

openai-node

The official Node.js / Typescript library for the OpenAI API
TypeScript
6,824
star
18

point-e

Point cloud diffusion for 3D model synthesis
Python
5,777
star
19

consistency_models

Official repo for consistency models.
Python
5,725
star
20

guided-diffusion

Python
5,000
star
21

plugins-quickstart

Get a ChatGPT plugin up and running in under 5 minutes!
Python
4,133
star
22

transformer-debugger

Python
3,607
star
23

retro

Retro Games in Gym
C
3,289
star
24

glide-text2im

GLIDE: a diffusion-based text-conditional image synthesis model
Python
3,277
star
25

glow

Code for reproducing results in "Glow: Generative Flow with Invertible 1x1 Convolutions"
Python
3,016
star
26

mujoco-py

MuJoCo is a physics engine for detailed, efficient rigid body simulations with contacts. mujoco-py allows using MuJoCo from Python 3.
Cython
2,586
star
27

openai-quickstart-node

Node.js example app from the OpenAI API quickstart tutorial
JavaScript
2,501
star
28

weak-to-strong

Python
2,341
star
29

improved-gan

Code for the paper "Improved Techniques for Training GANs"
Python
2,218
star
30

improved-diffusion

Release for Improved Denoising Diffusion Probabilistic Models
Python
2,102
star
31

roboschool

DEPRECATED: Open-source software for robot simulation, integrated with OpenAI Gym.
Python
2,064
star
32

image-gpt

Python
1,990
star
33

consistencydecoder

Consistency Distilled Diff VAE
Python
1,933
star
34

finetune-transformer-lm

Code and model for the paper "Improving Language Understanding by Generative Pre-Training"
Python
1,929
star
35

multiagent-particle-envs

Code for a multi-agent particle environment used in the paper "Multi-Agent Actor-Critic for Mixed Cooperative-Competitive Environments"
Python
1,871
star
36

gpt-2-output-dataset

Dataset of GPT-2 outputs for research in detection, biases, and more
Python
1,865
star
37

pixel-cnn

Code for the paper "PixelCNN++: A PixelCNN Implementation with Discretized Logistic Mixture Likelihood and Other Modifications"
Python
1,856
star
38

human-eval

Code for the paper "Evaluating Large Language Models Trained on Code"
Python
1,755
star
39

requests-for-research

A living collection of deep learning problems
HTML
1,625
star
40

openai-quickstart-python

Python example app from the OpenAI API quickstart tutorial
1,608
star
41

gpt-discord-bot

Example Discord bot written in Python that uses the completions API to have conversations with the `text-davinci-003` model, and the moderations API to filter the messages.
Python
1,569
star
42

multi-agent-emergence-environments

Environment generation code for the paper "Emergent Tool Use From Multi-Agent Autocurricula"
Python
1,557
star
43

evolution-strategies-starter

Code for the paper "Evolution Strategies as a Scalable Alternative to Reinforcement Learning"
Python
1,504
star
44

generating-reviews-discovering-sentiment

Code for "Learning to Generate Reviews and Discovering Sentiment"
Python
1,491
star
45

neural-mmo

Code for the paper "Neural MMO: A Massively Multiagent Game Environment for Training and Evaluating Intelligent Agents"
Python
1,463
star
46

sparse_attention

Examples of using sparse attention, as in "Generating Long Sequences with Sparse Transformers"
Python
1,347
star
47

maddpg

Code for the MADDPG algorithm from the paper "Multi-Agent Actor-Critic for Mixed Cooperative-Competitive Environments"
Python
1,284
star
48

prm800k

800,000 step-level correctness labels on LLM solutions to MATH problems
Python
1,239
star
49

Video-Pre-Training

Video PreTraining (VPT): Learning to Act by Watching Unlabeled Online Videos
Python
1,205
star
50

following-instructions-human-feedback

1,129
star
51

universe-starter-agent

A starter agent that can solve a number of universe environments.
Python
1,086
star
52

lm-human-preferences

Code for the paper Fine-Tuning Language Models from Human Preferences
Python
1,067
star
53

dalle-2-preview

1,049
star
54

InfoGAN

Code for reproducing key results in the paper "InfoGAN: Interpretable Representation Learning by Information Maximizing Generative Adversarial Nets"
Python
1,029
star
55

procgen

Procgen Benchmark: Procedurally-Generated Game-Like Gym-Environments
C++
972
star
56

supervised-reptile

Code for the paper "On First-Order Meta-Learning Algorithms"
JavaScript
955
star
57

blocksparse

Efficient GPU kernels for block-sparse matrix multiplication and convolution
Cuda
941
star
58

openai-openapi

OpenAPI specification for the OpenAI API
917
star
59

automated-interpretability

Python
875
star
60

grade-school-math

Python
859
star
61

kubernetes-ec2-autoscaler

A batch-optimized scaling manager for Kubernetes
Python
849
star
62

random-network-distillation

Code for the paper "Exploration by Random Network Distillation"
Python
847
star
63

summarize-from-feedback

Code for "Learning to summarize from human feedback"
Python
833
star
64

large-scale-curiosity

Code for the paper "Large-Scale Study of Curiosity-Driven Learning"
Python
798
star
65

multiagent-competition

Code for the paper "Emergent Complexity via Multi-agent Competition"
Python
761
star
66

imitation

Code for the paper "Generative Adversarial Imitation Learning"
Python
643
star
67

deeptype

Code for the paper "DeepType: Multilingual Entity Linking by Neural Type System Evolution"
Python
633
star
68

mlsh

Code for the paper "Meta-Learning Shared Hierarchies"
Python
588
star
69

iaf

Code for reproducing key results in the paper "Improving Variational Inference with Inverse Autoregressive Flow"
Python
499
star
70

mujoco-worldgen

Automatic object XML generation for Mujoco
Python
475
star
71

safety-gym

Tools for accelerating safe exploration research.
Python
421
star
72

vdvae

Repository for the paper "Very Deep VAEs Generalize Autoregressive Models and Can Outperform Them on Images"
Python
407
star
73

coinrun

Code for the paper "Quantifying Transfer in Reinforcement Learning"
C++
381
star
74

robogym

Robotics Gym Environments
Python
370
star
75

weightnorm

Example code for Weight Normalization, from "Weight Normalization: A Simple Reparameterization to Accelerate Training of Deep Neural Networks"
Python
357
star
76

atari-py

A packaged and slightly-modified version of https://github.com/bbitmaster/ale_python_interface
C++
354
star
77

openai-gemm

Open single and half precision gemm implementations
C
335
star
78

vime

Code for the paper "Curiosity-driven Exploration in Deep Reinforcement Learning via Bayesian Neural Networks"
Python
331
star
79

safety-starter-agents

Basic constrained RL agents used in experiments for the "Benchmarking Safe Exploration in Deep Reinforcement Learning" paper.
Python
312
star
80

ebm_code_release

Code for Implicit Generation and Generalization with Energy Based Models
Python
311
star
81

CLIP-featurevis

code for reproducing some of the diagrams in the paper "Multimodal Neurons in Artificial Neural Networks"
Python
294
star
82

gym-http-api

API to access OpenAI Gym from other languages via HTTP
Python
291
star
83

gym-soccer

Python
289
star
84

robosumo

Code for the paper "Continuous Adaptation via Meta-Learning in Nonstationary and Competitive Environments"
Python
283
star
85

EPG

Code for the paper "Evolved Policy Gradients"
Python
240
star
86

phasic-policy-gradient

Code for the paper "Phasic Policy Gradient"
Python
240
star
87

orrb

Code for the paper "OpenAI Remote Rendering Backend"
C#
235
star
88

miniF2F

Formal to Formal Mathematics Benchmark
Objective-C++
202
star
89

web-crawl-q-and-a-example

Learn how to crawl your website and build a Q/A bot with the OpenAI API
Jupyter Notebook
199
star
90

atari-reset

Code for the blog post "Learning Montezuma’s Revenge from a Single Demonstration"
Python
183
star
91

spinningup-workshop

For educational materials related to the spinning up workshops.
TeX
181
star
92

train-procgen

Code for the paper "Leveraging Procedural Generation to Benchmark Reinforcement Learning"
Python
167
star
93

human-eval-infilling

Code for the paper "Efficient Training of Language Models to Fill in the Middle"
Python
142
star
94

dallify-discord-bot

Example code for using OpenAI’s NodeJS SDK with discord.js SDK to create a Discord Bot that uses Slash Commands.
TypeScript
139
star
95

gym3

Vectorized interface for reinforcement learning environments
Python
136
star
96

lean-gym

Lean
134
star
97

retro-baselines

Publicly releasable baselines for the Retro contest
Python
128
star
98

neural-gpu

Code for the Neural GPU model originally described in "Neural GPUs Learn Algorithms"
Python
120
star
99

baselines-results

Jupyter Notebook
117
star
100

go-vncdriver

Fast VNC driver
Go
116
star