LlamaAcademy：教羊驼如何编程

使用 LLaMA、LoRA 和 Langchain 教会 GPT 阅读 API (应用编程接口) 文档。

如果 GPT 能够学习新的 API (应用编程接口)，那该多好？通过 LlamaAcademy，你可以教会 GPT 调用 Stripe、Notion 甚至你自己产品的 API (应用编程接口)。与其托管 API 文档，不如托管 API 实现！只需将 LlamaAcademy 指向你的 API 文档，运行脚本，然后——变魔术般——一个新的 LLaMA 模型就会为你生成。你可以将该模型托管在你的服务器上，用户就可以调用你定制的迷你 GPT 来编写他们的 API 胶水代码。

真的吗？

嗯，算是吧。LlamaAcademy 是实验性的——我们还没有让它稳定地生成优秀的代码（目前为止）。如果你对此感兴趣，我们非常欢迎提供帮助。

演示：一只学会了 Notion API 的羊驼

https://user-images.githubusercontent.com/51882888/232329429-c7aadc40-8251-41f3-b4bb-9ac41ac2c6f8.mp4

工作原理

LlamaAcademy 是一个结合了以下步骤的流水线 (Pipeline)：爬取 (Crawling)、使用 GPT3.5 和 GPT4 进行数据生成以及在合成数据 (Synthetic data) 上对 Vicuna-13B 进行微调 (Fine-tuning)。

安装

你需要安装 firefox 和 Elinks，然后安装所有必要的 Python 依赖项。你还需要输入一个 OPENAI_KEY。

sudo apt-get install firefox elinks
conda env create --file=environment.yaml
conda env config vars set OPENAI_API_KEY=YOUR_API_KEY

用法

LlamaAcademy 通过使用配置文件抽象每个用户超参数 (Hyper-parameters) 来提供一个简单的界面。

GENERATE: True # Turn off if you don't want to generate the data
API_DOCS: https://developers.notion.com/reference 
DEPTH_CRAWLING: 1 # 0 if your API website is long and not hierarchical (for example polygon.io). Otherwise, feel free to set, it might take much longer if your webiste has many children.
SUMMARIZE_DOCS: True
MICRO_BATCH_SIZE: 3  
BATCH_SIZE: 12
EPOCHS: 4  
LEARNING_RATE: 3e-4  
WARMUP_STEPS: 5
CUTOFF_LEN: 2048 
LORA_R: 8
LORA_ALPHA: 16
LORA_DROPOUT: 0.05
OPENAI_ENGINE: "gpt-4"
NUM_PROMPT_INSTRUCTIONS: 3
NUM_TASKS_TO_GENERATE: 200 # Recommended number of examples
DATA_PATH: "assets/"
OUTPUT_DIR: "output/lora-vicuna-api-notion"

要运行微调 (Fine-tuning) 过程，请运行：

CUDA_VISIBLE_DEVICES=0 python3 main.py --config configs/vicuna_13b.yaml

训练后，执行以下操作将 LoRA 模型导出为 HuggingFace 权重：

python3 export_hf.py --base_model jeffwan/vicuna-13b --model_folder output/lora-vicuna-api-notion

使用 LangChain 运行推理 (Inference)：

python3 inference.py --model_folder output/lora-vicuna-api-notion

硬件要求

此代码在 vast.ai 上的 1 个 RTX A6000 实例上进行了测试（约 0.6 美元/小时）。峰值显存 (VRAM) 占用为 27.8 GB，因此，任何显存 > 30GB 的 GPU (图形处理器) 都适合用于微调。使用 100 个示例进行微调需要 20 分钟，数据生成在 1 小时后完成（大部分时间花费在 GPT-4 实例生成和爬取过程中，因为网页抓取相当昂贵）。

计划

• 实现 (IA)^3 用于少样本 (Few-shot) 微调。
• 实现 flash_attention。
• 实现基于 scratch-pad 的 GPT-4 Agent (智能体) 以生成多轮规划和生成代码。

代码文件

此仓库提供以下文件夹和文件

• assets/：包含种子任务 + 用于生成数据的训练 URL（有关更多信息请参阅 self-instruct）。
  • data.json：生成的数据将保存于此以供训练。
  • generated_instructions.jsonl：用于指令微调的生成指令将保存于此。
  • training_urls.json：用于爬取和生成训练数据的通用 API（反向）。
  • seed_tasks.json：人类编写的用于 self-instruct 过程的种子任务（建议 4-10 个示例）。
  • prompt_summary.txt：GPT3.5-turbo 提取和总结爬取的 API 文档的提示词。
  • prompt_input_code.txt：GPT4 根据从向量分数查询的引用生成代码的提示词。
• configs/：配置文件所在的文件夹。
• chain.py：自定义 Langchain 流水线和智能体的文件。
• data_gen.py：使用 GPT3.5、GPT4、Bing 配合不同策略实现数据生成的文件。
• main.py：主要的推理文件，供用户自定义其 Alpaca 到 API 引用（爬取 API 引用网站、生成指令 - 代码对以及微调 Vicuna）。
• inference.py：允许用户使用与 API 相关的查询与训练好的模型进行推理（使用 Langchain + LlamaAcademy）。
• environment.yaml：依赖项的文件。
• utils.py：辅助函数的文件。
• memorizing.py：（仍在建设中）使用 记忆微调方法 强制 Vicuna 在没有预训练的情况下记忆 API 引用。
• ingest_docs.py：使用 Elinks 和 Selenium 实现 API 引用爬取。

LlamaAcademy 快速上手指南

LlamaAcademy 是一个实验性项目，旨在通过微调 LLaMA/Vicuna 模型，教会 AI 理解并调用特定 API（如 Stripe、Notion 等）。它利用 GPT-3.5/4 生成合成训练数据，结合 Langchain 实现从 API 文档到可执行代码的转化。

环境准备

在开始之前，请确保您的开发环境满足以下要求：

• 操作系统: Linux (推荐使用 Ubuntu)。
• 硬件要求:
  • 显卡显存需大于 30GB (测试环境为 RTX A6000，峰值显存约 27.8GB)。
  • 建议使用 Vast.ai 等云实例以降低成本。
• 系统依赖: 需要安装 firefox 和 elinks 浏览器工具。
• Python 环境: 推荐使用 conda 管理虚拟环境。
• API 密钥: 必须拥有有效的 OPENAI_API_KEY (用于生成训练数据)。
• 网络建议: 由于涉及 HuggingFace 模型下载及 OpenAI 服务，建议配置国内代理或镜像源。

安装步骤

1. 安装系统依赖

   sudo apt-get install firefox elinks
   

2. 创建 Conda 环境 根据提供的 environment.yaml 文件创建环境：

   conda env create --file=environment.yaml
   

3. 配置环境变量 设置您的 OpenAI API Key：

   conda env config vars set OPENAI_API_KEY=YOUR_API_KEY
   

基本使用

本项目通过配置文件抽象了大部分超参数。默认配置位于 configs/vicuna_13b.yaml。

1. 配置参数

编辑配置文件，主要关注以下字段：

• API_DOCS: 目标 API 的文档地址。
• NUM_TASKS_TO_GENERATE: 生成的任务示例数量（推荐 200）。
• OUTPUT_DIR: 微调后模型的输出目录。
• DATA_PATH: 数据存储路径。

2. 运行微调

启动训练脚本（指定 GPU 设备）：

CUDA_VISIBLE_DEVICES=0 python3 main.py --config configs/vicuna_13b.yaml

注：数据生成阶段可能耗时较长（约 1 小时），具体取决于网页爬取和 GPT-4 调用成本。

3. 导出模型

训练完成后，将 LoRA 权重转换为 HuggingFace 格式：

python3 export_hf.py --base_model jeffwan/vicuna-13b --model_folder output/lora-vicuna-api-notion

4. 进行推理

加载训练好的模型进行 API 调用测试：

python3 inference.py --model_folder output/lora-vicuna-api-notion

---

注意: 该项目目前处于实验阶段，生成的代码质量尚未完全稳定。生产使用前请充分测试。