名称: lm-evaluation-harness 描述: 评估LLM在60多个学术基准上的性能(MMLU、HumanEval、GSM8K、TruthfulQA、HellaSwag)。用于基准测试模型质量、比较模型、报告学术结果或跟踪训练进度。行业标准,被EleutherAI、HuggingFace和主要实验室使用。支持HuggingFace、vLLM、API。 版本: 1.0.0 作者: Orchestra Research 许可证: MIT 标签: [评估, LM评估套件, 基准测试, MMLU, HumanEval, GSM8K, EleutherAI, 模型质量, 学术基准, 行业标准] 依赖项: [lm-eval, transformers, vllm]
lm-evaluation-harness - LLM基准测试
快速开始
lm-evaluation-harness 使用标准化提示和指标评估LLM在60多个学术基准上的性能。
安装:
pip install lm-eval
评估任何HuggingFace模型:
lm_eval --model hf \
--model_args pretrained=meta-llama/Llama-2-7b-hf \
--tasks mmlu,gsm8k,hellaswag \
--device cuda:0 \
--batch_size 8
查看可用任务:
lm_eval --tasks list
常见工作流
工作流1: 标准基准评估
评估模型在核心基准(MMLU、GSM8K、HumanEval)上。
复制此检查清单:
基准评估:
- [ ] 步骤1: 选择基准套件
- [ ] 步骤2: 配置模型
- [ ] 步骤3: 运行评估
- [ ] 步骤4: 分析结果
步骤1: 选择基准套件
核心推理基准:
- MMLU(大规模多任务语言理解)- 57个主题,多项选择
- GSM8K - 小学数学单词问题
- HellaSwag - 常识推理
- TruthfulQA - 真实性和事实性
- ARC(AI2推理挑战)- 科学问题
代码基准:
- HumanEval - Python代码生成(164个问题)
- MBPP(基本Python问题)- Python编程
标准套件(推荐用于模型发布):
--tasks mmlu,gsm8k,hellaswag,truthfulqa,arc_challenge
步骤2: 配置模型
HuggingFace模型:
lm_eval --model hf \
--model_args pretrained=meta-llama/Llama-2-7b-hf,dtype=bfloat16 \
--tasks mmlu \
--device cuda:0 \
--batch_size auto # 自动检测最佳批量大小
量化模型(4位/8位):
lm_eval --model hf \
--model_args pretrained=meta-llama/Llama-2-7b-hf,load_in_4bit=True \
--tasks mmlu \
--device cuda:0
自定义检查点:
lm_eval --model hf \
--model_args pretrained=/path/to/my-model,tokenizer=/path/to/tokenizer \
--tasks mmlu \
--device cuda:0
步骤3: 运行评估
# 完整MMLU评估(57个主题)
lm_eval --model hf \
--model_args pretrained=meta-llama/Llama-2-7b-hf \
--tasks mmlu \
--num_fewshot 5 \ # 5-shot评估(标准)
--batch_size 8 \
--output_path results/ \
--log_samples # 保存个体预测
# 同时运行多个基准
lm_eval --model hf \
--model_args pretrained=meta-llama/Llama-2-7b-hf \
--tasks mmlu,gsm8k,hellaswag,truthfulqa,arc_challenge \
--num_fewshot 5 \
--batch_size 8 \
--output_path results/llama2-7b-eval.json
步骤4: 分析结果
结果保存到 results/llama2-7b-eval.json:
{
"results": {
"mmlu": {
"acc": 0.459,
"acc_stderr": 0.004
},
"gsm8k": {
"exact_match": 0.142,
"exact_match_stderr": 0.006
},
"hellaswag": {
"acc_norm": 0.765,
"acc_norm_stderr": 0.004
}
},
"config": {
"model": "hf",
"model_args": "pretrained=meta-llama/Llama-2-7b-hf",
"num_fewshot": 5
}
}
工作流2: 跟踪训练进度
在训练期间评估检查点。
训练进度跟踪:
- [ ] 步骤1: 设置定期评估
- [ ] 步骤2: 选择快速基准
- [ ] 步骤3: 自动化评估
- [ ] 步骤4: 绘制学习曲线
步骤1: 设置定期评估
每N个训练步骤评估一次:
#!/bin/bash
# eval_checkpoint.sh
CHECKPOINT_DIR=$1
STEP=$2
lm_eval --model hf \
--model_args pretrained=$CHECKPOINT_DIR/checkpoint-$STEP \
--tasks gsm8k,hellaswag \
--num_fewshot 0 \ # 0-shot以加速
--batch_size 16 \
--output_path results/step-$STEP.json
步骤2: 选择快速基准
用于频繁评估的快速基准:
- HellaSwag: 约10分钟在1个GPU上
- GSM8K: 约5分钟
- PIQA: 约2分钟
避免用于频繁评估(太慢):
- MMLU: 约2小时(57个主题)
- HumanEval: 需要代码执行
步骤3: 自动化评估
与训练脚本集成:
# 在训练循环中
if step % eval_interval == 0:
model.save_pretrained(f"checkpoints/step-{step}")
# 运行评估
os.system(f"./eval_checkpoint.sh checkpoints step-{step}")
或使用PyTorch Lightning回调:
from pytorch_lightning import Callback
class EvalHarnessCallback(Callback):
def on_validation_epoch_end(self, trainer, pl_module):
step = trainer.global_step
checkpoint_path = f"checkpoints/step-{step}"
# 保存检查点
trainer.save_checkpoint(checkpoint_path)
# 运行lm-eval
os.system(f"lm_eval --model hf --model_args pretrained={checkpoint_path} ...")
步骤4: 绘制学习曲线
import json
import matplotlib.pyplot as plt
# 加载所有结果
steps = []
mmlu_scores = []
for file in sorted(glob.glob("results/step-*.json")):
with open(file) as f:
data = json.load(f)
step = int(file.split("-")[1].split(".")[0])
steps.append(step)
mmlu_scores.append(data["results"]["mmlu"]["acc"])
# 绘图
plt.plot(steps, mmlu_scores)
plt.xlabel("训练步骤")
plt.ylabel("MMLU准确率")
plt.title("训练进度")
plt.savefig("training_curve.png")
工作流3: 比较多个模型
用于模型比较的基准测试套件。
模型比较:
- [ ] 步骤1: 定义模型列表
- [ ] 步骤2: 运行评估
- [ ] 步骤3: 生成比较表
步骤1: 定义模型列表
# models.txt
meta-llama/Llama-2-7b-hf
meta-llama/Llama-2-13b-hf
mistralai/Mistral-7B-v0.1
microsoft/phi-2
步骤2: 运行评估
#!/bin/bash
# eval_all_models.sh
TASKS="mmlu,gsm8k,hellaswag,truthfulqa"
while read model; do
echo "评估 $model"
# 提取模型名称用于输出文件
model_name=$(echo $model | sed 's/\//-/g')
lm_eval --model hf \
--model_args pretrained=$model,dtype=bfloat16 \
--tasks $TASKS \
--num_fewshot 5 \
--batch_size auto \
--output_path results/$model_name.json
done < models.txt
步骤3: 生成比较表
import json
import pandas as pd
models = [
"meta-llama-Llama-2-7b-hf",
"meta-llama-Llama-2-13b-hf",
"mistralai-Mistral-7B-v0.1",
"microsoft-phi-2"
]
tasks = ["mmlu", "gsm8k", "hellaswag", "truthfulqa"]
results = []
for model in models:
with open(f"results/{model}.json") as f:
data = json.load(f)
row = {"Model": model.replace("-", "/")}
for task in tasks:
# 获取每个任务的主要指标
metrics = data["results"][task]
if "acc" in metrics:
row[task.upper()] = f"{metrics['acc']:.3f}"
elif "exact_match" in metrics:
row[task.upper()] = f"{metrics['exact_match']:.3f}"
results.append(row)
df = pd.DataFrame(results)
print(df.to_markdown(index=False))
输出:
| 模型 | MMLU | GSM8K | HELLASWAG | TRUTHFULQA |
|------------------------|-------|-------|-----------|------------|
| meta-llama/Llama-2-7b | 0.459 | 0.142 | 0.765 | 0.391 |
| meta-llama/Llama-2-13b | 0.549 | 0.287 | 0.801 | 0.430 |
| mistralai/Mistral-7B | 0.626 | 0.395 | 0.812 | 0.428 |
| microsoft/phi-2 | 0.560 | 0.613 | 0.682 | 0.447 |
工作流4: 使用vLLM评估(更快推理)
使用vLLM后端进行5-10倍更快评估。
vLLM评估:
- [ ] 步骤1: 安装vLLM
- [ ] 步骤2: 配置vLLM后端
- [ ] 步骤3: 运行评估
步骤1: 安装vLLM
pip install vllm
步骤2: 配置vLLM后端
lm_eval --model vllm \
--model_args pretrained=meta-llama/Llama-2-7b-hf,tensor_parallel_size=1,dtype=auto,gpu_memory_utilization=0.8 \
--tasks mmlu \
--batch_size auto
步骤3: 运行评估
vLLM比标准HuggingFace快5-10倍:
# 标准HF:约2小时用于7B模型的MMLU
lm_eval --model hf \
--model_args pretrained=meta-llama/Llama-2-7b-hf \
--tasks mmlu \
--batch_size 8
# vLLM:约15-20分钟用于7B模型的MMLU
lm_eval --model vllm \
--model_args pretrained=meta-llama/Llama-2-7b-hf,tensor_parallel_size=2 \
--tasks mmlu \
--batch_size auto
何时使用与替代方案
使用lm-evaluation-harness当:
- 为学术论文进行基准测试模型
- 在标准任务上比较模型质量
- 跟踪训练进度
- 报告标准化指标(每个人都使用相同的提示)
- 需要可重复的评估
使用替代方案代替:
- HELM(斯坦福):更广泛的评估(公平性、效率、校准)
- AlpacaEval:使用LLM判断的指令跟随评估
- MT-Bench:对话多轮评估
- 自定义脚本:领域特定评估
常见问题
问题:评估太慢
使用vLLM后端:
lm_eval --model vllm \
--model_args pretrained=model-name,tensor_parallel_size=2
或减少fewshot示例:
--num_fewshot 0 # 而不是5
或评估MMLU子集:
--tasks mmlu_stem # 仅STEM主题
问题:内存不足
减少批量大小:
--batch_size 1 # 或 --batch_size auto
使用量化:
--model_args pretrained=model-name,load_in_8bit=True
启用CPU卸载:
--model_args pretrained=model-name,device_map=auto,offload_folder=offload
问题:结果与报告不同
检查fewshot数量:
--num_fewshot 5 # 大多数论文使用5-shot
检查确切任务名称:
--tasks mmlu # 不是mmlu_direct或mmlu_fewshot
验证模型和分词器匹配:
--model_args pretrained=model-name,tokenizer=same-model-name
问题:HumanEval不执行代码
安装执行依赖项:
pip install human-eval
启用代码执行:
lm_eval --model hf \
--model_args pretrained=model-name \
--tasks humaneval \
--allow_code_execution # HumanEval必需
高级主题
基准描述:参见references/benchmark-guide.md获取所有60多个任务的详细描述、它们测量什么以及解释。
自定义任务:参见references/custom-tasks.md创建领域特定评估任务。
API评估:参见references/api-evaluation.md评估OpenAI、Anthropic和其他API模型。
多GPU策略:参见references/distributed-eval.md获取数据并行和Tensor并行评估。
硬件要求
- GPU:NVIDIA(CUDA 11.8+),可在CPU上运行(非常慢)
- VRAM:
- 7B模型:16GB(bf16)或8GB(8位)
- 13B模型:28GB(bf16)或14GB(8位)
- 70B模型:需要多GPU或量化
- 时间(7B模型,单个A100):
- HellaSwag:10分钟
- GSM8K:5分钟
- MMLU(完整):2小时
- HumanEval:20分钟
资源
- GitHub:https://github.com/EleutherAI/lm-evaluation-harness
- 文档:https://github.com/EleutherAI/lm-evaluation-harness/tree/main/docs
- 任务库:60多个任务包括MMLU、GSM8K、HumanEval、TruthfulQA、HellaSwag、ARC、WinoGrande等。
- 排行榜:https://huggingface.co/spaces/HuggingFaceH4/open_llm_leaderboard(使用此套件)