JailbreakBench 项目使用教程
1、项目的目录结构及介绍
jailbreakbench/
├── artifacts/
│ ├── README.md
│ ├── prompts/
│ └── datasets/
├── configs/
│ ├── default.yaml
│ └── custom.yaml
├── src/
│ ├── attacks/
│ ├── defenses/
│ └── utils/
├── tests/
│ ├── test_attacks.py
│ └── test_defenses.py
├── setup.py
├── README.md
└── requirements.txt
- artifacts/: 存储 jailbreak 相关的数据集和提示。
- prompts/: 包含各种 jailbreak 提示。
- datasets/: 包含用于测试的数据集。
- configs/: 项目的配置文件。
- default.yaml: 默认配置文件。
- custom.yaml: 自定义配置文件。
- src/: 项目的主要源代码。
- attacks/: 包含各种攻击方法的实现。
- defenses/: 包含各种防御方法的实现。
- utils/: 包含一些通用的工具函数。
- tests/: 包含项目的测试代码。
- test_attacks.py: 攻击方法的测试。
- test_defenses.py: 防御方法的测试。
- setup.py: 项目的安装脚本。
- README.md: 项目说明文档。
- requirements.txt: 项目依赖文件。
2、项目的启动文件介绍
项目的启动文件是 setup.py
,通过运行以下命令可以安装项目:
pip install .
3、项目的配置文件介绍
项目的配置文件位于 configs/
目录下,主要包括 default.yaml
和 custom.yaml
。
- default.yaml: 默认配置文件,包含项目的默认设置。
- custom.yaml: 自定义配置文件,用户可以根据需要修改配置。
配置文件中包含以下主要配置项:
model:
name: "default_model"
path: "path/to/model"
attacks:
enabled: true
methods: ["method1", "method2"]
defenses:
enabled: true
methods: ["defense1", "defense2"]
- model: 配置模型的名称和路径。
- attacks: 配置是否启用攻击方法以及启用的攻击方法列表。
- defenses: 配置是否启用防御方法以及启用的防御方法列表。
通过修改配置文件,用户可以灵活地调整项目的运行参数。