evals

evals

开源框架助力大型语言模型性能评估

evals是一个开源框架,用于评估大型语言模型(LLM)及其衍生系统。该框架提供评估注册表,支持测试OpenAI模型的多个维度,同时允许用户创建自定义评估。开发者可利用私有数据构建评估,无需公开敏感信息。evals能够帮助开发者深入分析不同模型版本对特定应用场景的影响,对LLM开发过程具有重要价值。

OpenAI EvalsLLM评估API密钥评估框架Git-LFSGithub开源项目

OpenAI 评估

评估为大型语言模型(LLM)或基于LLM构建的系统提供评估框架。我们提供现有的评估注册表,用于测试OpenAI模型的不同维度,并且可以编写自定义评估以满足您关心的用例。您还可以使用自己的数据构建私有评估,这些评估代表您工作流程中常见的LLM模式,而无需公开暴露任何数据。

如果您正在使用LLM进行构建,创建高质量的评估是您可以做的最有影响力的事情之一。没有评估,很难理解不同模型版本如何影响您的用例,而且可能非常耗时。用OpenAI总裁Greg Brockman的话说:

<img width="596" alt="https://x.com/gdb/status/1733553161884127435?s=20" src="https://github.com/openai/evals/assets/35577566/ce7840ff-43a8-4d88-bb2f-6b207410333b">

设置

要运行评估,您需要设置并指定您的OpenAI API密钥。获得API密钥后,请使用OPENAI_API_KEY环境变量指定它。运行评估时,请注意使用API所产生的成本。您还可以使用Weights & Biases运行和创建评估。

最低要求版本:Python 3.9

下载评估

我们的评估注册表使用Git-LFS存储。下载并安装LFS后,您可以在本地evals仓库副本中使用以下命令获取评估:

cd evals git lfs fetch --all git lfs pull

这将填充evals/registry/data下的所有指针文件。

如果您只想获取特定评估的数据,可以通过以下方式实现:

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

创建评估

如果您要创建评估,我们建议直接从GitHub克隆此仓库,并使用以下命令安装要求:

pip install -e .

使用-e,您对评估所做的更改将立即生效,无需重新安装。

可选地,您可以安装用于预提交的格式化程序:

pip install -e .[formatters]

然后运行pre-commit install将pre-commit安装到您的git钩子中。pre-commit现在将在每次提交时运行。

如果您想手动对仓库运行所有pre-commit钩子,请运行pre-commit run --all-files。要运行单个钩子,请使用pre-commit run <hook_id>。

运行评估

如果您不想贡献新的评估,而只想在本地运行它们,可以通过pip安装evals包:

pip install evals

您可以在run-evals.md中找到运行现有评估的完整说明,在eval-templates.md中找到我们现有的评估模板。对于更高级的用例,如提示链或使用工具的代理,您可以使用我们的完成函数协议。

我们提供选项让您将评估结果记录到Snowflake数据库中,如果您有或想设置一个的话。对于此选项,您还需要指定SNOWFLAKE_ACCOUNT、SNOWFLAKE_DATABASE、SNOWFLAKE_USERNAME和SNOWFLAKE_PASSWORD环境变量。

编写评估

我们建议从以下方面入手:

  • 完成构建评估的流程:build-eval.md
  • 探索实现自定义评估逻辑的示例:custom-eval.md
  • 编写您自己的完成函数:completion-fns.md
  • 查看我们的评估编写入门指南:OpenAI Evals入门

请注意,我们目前不接受带有自定义代码的评估!虽然我们暂时要求您不要提交此类评估,但您仍可以使用自定义模型评分YAML文件提交模型评分评估。

如果您认为您有一个有趣的评估,请开启一个拉取请求提交您的贡献。OpenAI员工在考虑改进即将推出的模型时会积极审查这些评估。

常见问题

您有从头到尾构建评估的示例吗?

  • 有的!这些在examples文件夹中。我们建议您也阅读build-eval.md,以深入了解这些示例中发生的情况。

您有以多种不同方式实现的评估示例吗?

  • 有的!特别是,请参阅evals/registry/evals/coqa.yaml。我们为各种评估模板实现了CoQA数据集的小子集,以帮助说明差异。

当我运行评估时,有时在最后(最终报告之后)会卡住。这是怎么回事?

  • 这是一个已知问题,但您应该能够安全地中断它,评估应该在之后立即完成。

代码太多,我只想快速启动一个评估。有什么建议吗?或者,

我是一名世界级的提示工程师。我选择不编码。我如何贡献我的智慧?

  • 如果您遵循现有的评估模板来构建基本或模型评分评估,您根本不需要编写任何评估代码!只需以JSON格式提供数据并在YAML中指定评估参数即可。build-eval.md会引导您完成这些步骤,您可以参考examples文件夹中的Jupyter笔记本来快速入门。请记住,一个好的评估inevitably需要仔细思考和严格实验!

免责声明

通过贡献评估,您同意使您的评估逻辑和数据采用与本仓库相同的MIT许可。您必须拥有足够的权利来上传评估中使用的任何数据。OpenAI保留在未来的服务改进中使用这些数据的权利。对OpenAI评估的贡献将受我们通常的使用政策约束:https://platform.openai.com/docs/usage-policies。

编辑推荐精选

讯飞智文

讯飞智文

一键生成PPT和Word,让学习生活更轻松

讯飞智文是一个利用 AI 技术的项目,能够帮助用户生成 PPT 以及各类文档。无论是商业领域的市场分析报告、年度目标制定,还是学生群体的职业生涯规划、实习避坑指南,亦或是活动策划、旅游攻略等内容,它都能提供支持,帮助用户精准表达,轻松呈现各种信息。

AI办公办公工具AI工具讯飞智文AI在线生成PPTAI撰写助手多语种文档生成AI自动配图热门
讯飞星火

讯飞星火

深度推理能力全新升级,全面对标OpenAI o1

科大讯飞的星火大模型,支持语言理解、知识问答和文本创作等多功能,适用于多种文件和业务场景,提升办公和日常生活的效率。讯飞星火是一个提供丰富智能服务的平台,涵盖科技资讯、图像创作、写作辅助、编程解答、科研文献解读等功能,能为不同需求的用户提供便捷高效的帮助,助力用户轻松获取信息、解决问题,满足多样化使用场景。

热门AI开发模型训练AI工具讯飞星火大模型智能问答内容创作多语种支持智慧生活
Spark-TTS

Spark-TTS

一种基于大语言模型的高效单流解耦语音令牌文本到语音合成模型

Spark-TTS 是一个基于 PyTorch 的开源文本到语音合成项目,由多个知名机构联合参与。该项目提供了高效的 LLM(大语言模型)驱动的语音合成方案,支持语音克隆和语音创建功能,可通过命令行界面(CLI)和 Web UI 两种方式使用。用户可以根据需求调整语音的性别、音高、速度等参数,生成高质量的语音。该项目适用于多种场景,如有声读物制作、智能语音助手开发等。

Trae

Trae

字节跳动发布的AI编程神器IDE

Trae是一种自适应的集成开发环境(IDE),通过自动化和多元协作改变开发流程。利用Trae,团队能够更快速、精确地编写和部署代码,从而提高编程效率和项目交付速度。Trae具备上下文感知和代码自动完成功能,是提升开发效率的理想工具。

AI工具TraeAI IDE协作生产力转型热门
咔片PPT

咔片PPT

AI助力,做PPT更简单!

咔片是一款轻量化在线演示设计工具,借助 AI 技术,实现从内容生成到智能设计的一站式 PPT 制作服务。支持多种文档格式导入生成 PPT,提供海量模板、智能美化、素材替换等功能,适用于销售、教师、学生等各类人群,能高效制作出高品质 PPT,满足不同场景演示需求。

讯飞绘文

讯飞绘文

选题、配图、成文,一站式创作,让内容运营更高效

讯飞绘文,一个AI集成平台,支持写作、选题、配图、排版和发布。高效生成适用于各类媒体的定制内容,加速品牌传播,提升内容营销效果。

热门AI辅助写作AI工具讯飞绘文内容运营AI创作个性化文章多平台分发AI助手
材料星

材料星

专业的AI公文写作平台,公文写作神器

AI 材料星,专业的 AI 公文写作辅助平台,为体制内工作人员提供高效的公文写作解决方案。拥有海量公文文库、9 大核心 AI 功能,支持 30 + 文稿类型生成,助力快速完成领导讲话、工作总结、述职报告等材料,提升办公效率,是体制打工人的得力写作神器。

openai-agents-python

openai-agents-python

OpenAI Agents SDK,助力开发者便捷使用 OpenAI 相关功能。

openai-agents-python 是 OpenAI 推出的一款强大 Python SDK,它为开发者提供了与 OpenAI 模型交互的高效工具,支持工具调用、结果处理、追踪等功能,涵盖多种应用场景,如研究助手、财务研究等,能显著提升开发效率,让开发者更轻松地利用 OpenAI 的技术优势。

Hunyuan3D-2

Hunyuan3D-2

高分辨率纹理 3D 资产生成

Hunyuan3D-2 是腾讯开发的用于 3D 资产生成的强大工具,支持从文本描述、单张图片或多视角图片生成 3D 模型,具备快速形状生成能力,可生成带纹理的高质量 3D 模型,适用于多个领域,为 3D 创作提供了高效解决方案。

3FS

3FS

一个具备存储、管理和客户端操作等多种功能的分布式文件系统相关项目。

3FS 是一个功能强大的分布式文件系统项目,涵盖了存储引擎、元数据管理、客户端工具等多个模块。它支持多种文件操作,如创建文件和目录、设置布局等,同时具备高效的事件循环、节点选择和协程池管理等特性。适用于需要大规模数据存储和管理的场景,能够提高系统的性能和可靠性,是分布式存储领域的优质解决方案。

下拉加载更多