项目预览
项目数据
项目介绍
Star 增长趋势
本站每日记录该项目 GitHub 星标变化,观测越久曲线越完整
数据来源:GitHub API 逐日快照 · 收录于 2026-08-09 · 当前星标 ★ 2138
技术标签
使用教程
环境要求
- 已安装 Poetry(用于创建虚拟环境并安装依赖)
- Python 环境(依赖由 Poetry 自动管理)
- 可用的 OpenAI API Key,示例配置使用 gpt-4 模型
- 能访问 GitHub 拉取源码(或使用 CodeSpace)
- 可选:已安装 Docker,可直接拉取官方镜像运行
安装与启动步骤
-
1安装 Poetry
按 Poetry 官方文档安装并确认 poetry 命令可用,这是后续依赖安装的前提。
-
2克隆代码仓库
把 YiVal 源码下载到本地并进入仓库目录,也可以改用 GitHub CodeSpace 跳过此步。
git clone https://github.com/YiVal/YiVal.git cd YiVal -
3安装项目依赖
在 /YiVal 目录下执行,Poetry 会创建虚拟环境并同步安装全部依赖。
poetry install --sync -
4进入源码目录
后续配置文件和运行命令都在这个目录下执行。
cd /YiVal/src/yival -
5配置 API 密钥
把 sk-xxxxxxxx 换成你自己的 OpenAI API Key,通过环境变量注入。
export OPENAI_API_KEY=sk-xxxxxxxx -
6编写配置文件
在当前目录新建 config_data_generation.yml,用来自动生成测试数据集。
description: Generate test data dataset: data_generators: openai_prompt_data_generator: chunk_size: 100000 diversify: true model_name: gpt-4 input_function: description: # Description of the function Given a tech startup business, generate a corresponding landing page headline name: headline_generation_for_business parameters: tech_startup_business: str # Parameter name and type number_of_examples: 3 output_csv_path: generated_examples.csv source_type: machine_generated -
7运行 YiVal
在 /YiVal/src/yival 目录下执行,按配置自动生成测试数据。
yival run config_data_generation.yml
关键配置
| 配置项 | 必填 | 说明 | 示例 |
|---|---|---|---|
OPENAI_API_KEY | 是 | OpenAI 调用密钥,通过环境变量导出供 YiVal 使用 | sk-xxxxxxxx |
model_name | 是 | 数据生成使用的模型名称 | gpt-4 |
number_of_examples | 是 | 生成的样本数量 | 3 |
output_csv_path | 是 | 生成数据集的输出 CSV 路径 | generated_examples.csv |
source_type | 是 | 数据集来源类型,机器生成时为 machine_generated | machine_generated |
diversify | 否 | 是否对生成样本做多样化处理 | true |
如何确认成功
命令执行结束后,在 /YiVal/src/yival/ 目录下会生成 generated_examples.csv 文件,打开可看到生成的样本数据。
常见问题
Q:Windows 上如何设置 API Key?
A:README 给出的是 powershell 命令:setx OPENAI_API_KEY $YOUR_OPENAI_API_KEY,把其中的占位符替换为真实 Key 即可。
Q:docker run --it 报错怎么办?
A:README 中写的是 --it,若 Docker 提示未知参数,可改用 -it(-i 交互 + -t 分配终端)再运行。
Q:poetry install 失败?
A:README 要求必须在 /YiVal 目录下执行该命令,请先 cd 进入仓库根目录,并确认 Poetry 已正确安装。
Q:配置文件应该放在哪里?
A:README 的示例是在 /YiVal/src/yival 目录下创建 config_data_generation.yml,并在同一目录执行 yival run。
Q:需要 GPU 或 Jupyter 环境怎么办?
A:README 提供了 GPU/Jupyter 镜像:先 docker pull yival/release:cu12_torch_jupyter,再执行 docker run --gpus all -it -p 8888:8888 yival/release:cu12_torch_jupyter。
注意事项
- Docker 与 Poetry 是 README 给出的两种并列安装方式,按需选其一即可:docker pull yival/release:latest 后 docker run --it yival/release:latest。
- Poetry 方式安装依赖时必须处于 /YiVal 目录,运行示例程序时必须处于 /YiVal/src/yival 目录。
- 还需要配置真实可用的 OpenAI API Key,示例配置使用 gpt-4 模型。
- README 推荐用带 Docker 扩展的 VSCode 运行和开发。
核心亮点
- 自动生成提示词变体,省去手动试错时间
- 内置多种评估指标,支持量化对比效果
- 支持多模型和多配置实验,便于横向比较
不足之处
- 文档/社区待观察
- 对复杂多轮对话场景支持有限
适用场景
- LLM 应用开发中的提示词调优
- 图像生成应用的 prompt 优化
- AI 产品上线前的效果评估与回归测试
替代项目
Promptimize、PromptPerfect、OpenAI Evals
同类项目推荐
sugarcane-ai
开源
像 npm 管理代码一样管理 Prompt,复用分发更高效。
npm like package ecosystem for Prompts
BuildingAI
开源
像搭积木一样,人人快速搭建自己的 AI 应用系统
AI时代的WordPress,东半球首个积木式AI应用搭建系统,人人都可免费搭建自己的AI应用系统,···
cc-safety-net
开源
给 AI 编程代理装上安全刹车,拦截破坏性命令
A pre-execution guard for AI coding agents. It blocks destructive Git and file syste···
mistral-haystack
开源
用 Mistral 模型快速搭建 RAG 管道,让 AI 应用更聪明。
Mistral + Haystack: build RAG pipelines that rock
JioNLP
开源
中文文本预处理一步到位,几十种工具开箱即用
中文 NLP 预处理、解析工具包,准确、高效、易用 A Chinese NLP Preprocessing & Parsing ···
langchainrb
开源
用 Ruby 快速构建 LLM 应用,像搭积木一样组合 AI 能力
Build LLM-powered applications in Ruby
pocketgroq
开源
一行代码接入 Groq,快速构建带推理和联网能力的智能代理。
PocketGroq is a powerful Python library that simplifies integration with the Groq AP···
LazyLLM
开源
像搭积木一样,懒人也能快速搭建多智能体 AI 应用
Easiest and laziest way for building multi-agent LLMs applications.
agentic-design-patterns
开源
29种智能体设计模式,照着选型,少走弯路
29 essential agentic design patterns for building intelligent AI systems
