自动提示工程师（Automatic Prompt Engineer）项目指南

自动提示工程师（Automatic Prompt Engineer）项目指南

automatic_prompt_engineer 项目地址: https://gitcode.com/gh_mirrors/au/automatic_prompt_engineer

该项目地址位于 GitHub，由 Yongchao Zhou 等人开发，旨在自动生成任务指令，减少对人工精心设计提示的依赖。以下是对该开源项目的快速入门指南，分为三个主要部分：目录结构、启动文件以及配置文件介绍。

1. 项目目录结构及介绍

自动提示工程师（APE）的项目结构组织如下：

automatic_prompt_engineer/
├── data                     # 数据存放目录，包含实验所需的数据集。
├── experiments              # 实验相关文件或脚本。
├── tests                    # 单元测试和示例代码。
├── .gitignore               # Git忽略文件列表。
├── LICENSE                  # 许可证文件，遵循MIT协议。
├── README.md                # 项目的主要说明文件。
├── demo.ipynb               # Jupyter Notebook演示文件，展示如何使用APE。
├── demo.py                  # Python脚本形式的简单演示。
└── setup.py                 # 项目安装脚本。

• data: 包含用于训练和评估模型的任务数据。
• experiments: 提供了进行特定实验的设置和脚本。
• tests: 用于确保项目代码质量的测试案例。
• .gitignore: 指定了不应被Git版本控制的文件类型或文件夹。
• LICENSE: 项目使用的许可证文档。
• README.md: 项目概述，包括安装步骤、基本概念等。
• demo.*: 示例文件，帮助用户快速理解如何使用项目。

2. 项目启动文件介绍

在automatic_prompt_engineer中，并没有一个明确标记为“启动文件”的单一文件。然而，用户通常从setup.py开始，用于安装项目依赖。实际操作和执行AEP功能通常通过调用Python脚本或Jupyter Notebook中的示例代码完成，如demo.py或者demo.ipynb。运行这些示例是探索项目功能的起点。

安装与快速启动

首先，需要通过pip安装项目，使用下面的命令：

pip install -e .

随后，你可以通过运行提供的Jupyter Notebook demo.ipynb或Python脚本demo.py来体验自动提示生成的功能。

3. 项目的配置文件介绍

配置选项主要是通过字典conf传递给项目的关键函数，例如find_prompts。尽管项目根目录下没有直接列出传统的.cfg或.json配置文件，配置信息主要分布在特定的Python代码中或通过指定的配置路径（如'configs/default.yaml', 'configs/bandits.yaml'）读取。这些配置文件定义了评价模板、演示模板、候选提示生成方式等关键参数。

• 默认配置 (default.yaml)：使用似然性作为评估标准。
• 带宽选择算法配置 (bandits.yaml)：资源高效，利用上界置信度算法（UCB），基于似然性进行基础评价。

用户可以通过修改或提供自定义的 YAML 配置文件来调整 APE 的行为，以适应不同的场景和需求。

总之，自动提示工程师项目通过一套灵活的机制和配置，实现了自动化地为大型语言模型生成高效提示，极大简化了人工智能应用中手动优化提示的过程。通过上述目录结构、启动步骤和配置了解，开发者可以快速上手并应用于自己的研究或产品中。

automatic_prompt_engineer 项目地址: https://gitcode.com/gh_mirrors/au/automatic_prompt_engineer