开源项目opro使用教程

开源项目opro使用教程

opro official code for "Large Language Models as Optimizers" 项目地址: https://gitcode.com/gh_mirrors/op/opro

1. 项目目录结构及介绍

开源项目opro的目录结构如下所示：

opro/
├── data/
│   └── ... # 数据文件
├── img/
│   └── ... # 图片文件
├── misc/
│   ├── prompt_history/
│   └── ... # 杂项文件
├── opro/
│   ├── optimization/
│   │   ├── optimize_instructions.py
│   │   ├── optimize_linear_regression.py
│   │   └── optimize_tsp.py
│   ├── evaluation/
│   │   └── evaluate_instructions.py
│   ├── prompt_utils.py
│   └── ... # 其他相关脚本和模块
├── .gitignore
├── CONTRIBUTING.md
├── LICENSE
└── README.md

• data/：存放项目所需的数据文件。
• img/：存放项目相关的图片文件。
• misc/：包含一些杂项文件，如历史提示记录等。
• opro/：项目的主要目录，包含各种脚本和模块。
  • optimization/：包含用于优化提示的脚本。
  • evaluation/：包含用于评估提示的脚本。
  • prompt_utils.py：提供了一些用于提示的API和工具。
• .gitignore：指定git忽略的文件和目录。
• CONTRIBUTING.md：提供了贡献指南。
• LICENSE：项目的开源协议文件。
• README.md：项目说明文件。

2. 项目的启动文件介绍

项目的启动文件主要集中在opro/目录下的脚本中，以下是一些主要的启动文件及其用途：

• optimize_instructions.py：用于优化提示的脚本，可以通过命令行参数配置优化器、评分器、指令位置等。
• evaluate_instructions.py：用于评估提示的脚本，可以通过命令行参数配置评分器、数据集、任务等。
• optimize_linear_regression.py：用于线性回归优化的脚本。
• optimize_tsp.py：用于解决旅行商问题的脚本。

以optimize_instructions.py为例，可以使用以下命令启动：

python optimize_instructions.py --optimizer="gpt-3.5-turbo" --scorer="text-bison" --instruction_pos="Q_begin" --dataset="gsm8k" --task="train" --palm_api_key="<your_palm_api_key>" --openai_api_key="<your_openai_api_key>"

3. 项目的配置文件介绍

项目的配置主要通过命令行参数进行，没有专门的配置文件。每个脚本在执行时都可以通过不同的参数来定制化运行行为。例如：

• --optimizer：指定使用的优化器模型。
• --scorer：指定使用的评分器模型。
• --instruction_pos：指定指令的位置。
• --dataset：指定使用的数据集。
• --task：指定执行的任务类型。

具体的参数配置可以参考各个脚本的命令行帮助信息或脚本顶部的注释说明。在运行脚本之前，确保已经设置了所需的API密钥，例如<your_palm_api_key>和<your_openai_api_key>，这些需要替换为实际的API密钥才能正常使用相关服务。

opro official code for "Large Language Models as Optimizers" 项目地址: https://gitcode.com/gh_mirrors/op/opro