YiVal开源项目使用与启动教程

YiVal开源项目使用与启动教程

YiVal Your Automatic Prompt Engineering Assistant for GenAI Applications 项目地址: https://gitcode.com/gh_mirrors/yi/YiVal

1. 项目介绍

YiVal是一个自动提示工程助手，专为生成AI应用而设计。它能够帮助用户优化生成AI应用的提示（prompts）和配置（configs），通过数据驱动和评估中心的方法，实现手动调整的自动化，从而确保最佳的提示，精确的RAG配置和微调的模型参数。使用YiVal，应用可以获得增强的结果，减少延迟，并最小化推理成本。

2. 项目快速启动

环境准备

• 确保安装了Python 3.10或更高版本。
• 获取OpenAI API密钥，并将其设置为名为OPENAI_API_KEY的环境变量。

安装方法

使用pip（推荐用户使用）

直接使用pip安装yival包：

pip install yival

使用Poetry（开发环境设置）

如果你打算贡献代码或设置开发环境：

• 安装Poetry。
• 克隆仓库：

git clone https://github.com/YiVal/YiVal.git
cd YiVal

• 使用Poetry初始化Python虚拟环境并安装依赖：

poetry install --sync

运行示例

在设置完环境后，可以生成随机技术创业公司业务名称的数据集来快速开始使用YiVal。

步骤

1. 切换到yival目录：

cd YiVal/src/yival

2. 设置OpenAI API Key：

对于macOS或Linux系统：

export OPENAI_API_KEY=$YOUR_OPENAI_API_KEY

对于Windows系统：

setx OPENAI_API_KEY $YOUR_OPENAI_API_KEY

3. 定义YiVal配置：

创建一个名为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: Given a tech startup business, generate a corresponding landing page headline
    name: headline_generation_for_business
    parameters:
      tech_startup_business: str
    number_of_examples: 3
    output_csv_path: generated_examples.csv
    source_type: machine_generated

4. 执行YiVal：

在/YiVal/src/yival目录下运行以下命令：

yival run config_data_generation.yml

5. 检查生成的数据集：

生成的测试数据集将保存在generated_examples.csv中。

3. 应用案例和最佳实践

以下是一些YiVal的应用案例和最佳实践：

• 多模态支持：设计一个同时支持文本和图像的AI驱动故事。
• 模型性能评估：使用自定义的Q&A测试数据集来评估和比较模型性能。
• 启动公司标题生成：自动化测试数据创建、提示编写、结果评估和性能提升。
• 个性化旅行指南：利用自动提示，基于旅行社区的热门建议构建旅行指南。
• 成本效益翻译：使用GPT-3.5训练Llama2创建成本更低的翻译机器人。

4. 典型生态项目

YiVal可以与多个开源项目配合使用，形成生态系统，例如：

• GitHub Copilot：编写更好的代码，通过AI提供代码建议。
• Actions：自动化任何工作流程。
• Codespaces：提供即时开发环境。
• Issues：规划和跟踪工作。
• Code Review：管理代码更改。

通过这些项目和工具的组合，开发者可以构建更加强大和高效的应用程序。

YiVal Your Automatic Prompt Engineering Assistant for GenAI Applications 项目地址: https://gitcode.com/gh_mirrors/yi/YiVal