promptbench

环境要求

• Python 3.9（README 中 conda 环境指定版本）
• pip 包管理工具，用于安装 promptbench 及依赖
• conda（可选，用于创建隔离环境）
• 能够访问 GitHub 的网络环境
• 如需使用 Prompt Attacks 功能，还需额外安装 TextAttack

安装与启动步骤

1. 1pip 快速安装

   最省事的方式，直接安装官方发布的 Python 包，适合只想快速开始评估的用户。

   pip install promptbench

   复制

2. 2克隆仓库

   想使用最新特性或基于源码开发时，从 GitHub 克隆项目。

   git clone git@github.com:microsoft/promptbench.git

   复制

3. 3进入项目目录

   切换到克隆下来的仓库根目录，后续命令都在此目录执行。

   cd promptbench

   复制

4. 4创建 conda 环境

   README 指定使用 Python 3.9 创建名为 promptbench 的隔离环境。

   conda create --name promptbench python=3.9

   复制

5. 5激活环境

   激活刚创建的环境，确保依赖装在隔离环境中。

   conda activate promptbench

   复制

6. 6安装依赖包

   安装基础 Python 依赖，这一步只装基础包，不含攻击相关组件。

   pip install -r requirements.txt

   复制

7. 7验证导入

   在 Python 交互环境中导入 promptbench，确认安装成功。

   import promptbench as pb

   复制

如何确认成功

执行 import promptbench as pb 不报错，即表示基础库安装成功。

常见问题

注意事项

• pip 安装的版本可能落后于 GitHub 仓库的最新代码。
• Prompt Attacks 相关功能需要额外安装 TextAttack 才能使用。
• README 给出的克隆地址为 SSH 形式（git@github.com:...），需先配置 SSH 密钥。
• 切换环境后请确认使用的是 promptbench 这个 conda 环境，避免依赖装到全局环境。