DeepInception 项目使用教程

DeepInception 项目使用教程

DeepInception[arXiv:2311.03191] "DeepInception: Hypnotize Large Language Model to Be Jailbreaker"项目地址:https://gitcode.com/gh_mirrors/de/DeepInception

1. 项目的目录结构及介绍

DeepInception 项目的目录结构如下：

DeepInception/
├── main.py
├── config.yaml
├── README.md
├── results/
│   └── example_results.json
├── models/
│   ├── vicuna.py
│   ├── llama2.py
│   └── falcon.py
└── utils/
    ├── data_loader.py
    └── helper_functions.py

目录结构介绍

• main.py: 项目的启动文件，用于运行实验。
• config.yaml: 项目的配置文件，包含实验参数和模型配置。
• README.md: 项目说明文档，包含项目介绍和使用指南。
• results/: 存储实验结果的目录。
• models/: 包含不同模型的实现文件。
• utils/: 包含辅助函数和数据加载器的实现文件。

2. 项目的启动文件介绍

main.py 是 DeepInception 项目的启动文件，主要用于运行实验。以下是 main.py 的基本结构和功能介绍：

import argparse
import yaml
from models import vicuna, llama2, falcon
from utils import data_loader, helper_functions

def main(args):
    # 加载配置文件
    with open(args.config, 'r') as f:
        config = yaml.safe_load(f)
    
    # 根据配置文件初始化模型
    if args.target_model == 'vicuna':
        model = vicuna.VicunaModel(config)
    elif args.target_model == 'llama2':
        model = llama2.Llama2Model(config)
    elif args.target_model == 'falcon':
        model = falcon.FalconModel(config)
    else:
        raise ValueError("Unsupported target model")
    
    # 运行实验
    results = model.run_experiment(args.exp_name, args.defense)
    
    # 保存结果
    helper_functions.save_results(results, args.exp_name, args.defense)

if __name__ == "__main__":
    parser = argparse.ArgumentParser(description="DeepInception Experiment Runner")
    parser.add_argument("--target-model", type=str, required=True, help="Target model to run experiment on")
    parser.add_argument("--exp_name", type=str, required=True, help="Name of the experiment")
    parser.add_argument("--defense", type=str, default="none", help="Type of defense to apply")
    parser.add_argument("--config", type=str, default="config.yaml", help="Path to configuration file")
    args = parser.parse_args()
    main(args)

功能介绍

• 加载配置文件：通过 yaml.safe_load 方法加载配置文件。
• 初始化模型：根据命令行参数选择不同的模型进行初始化。
• 运行实验：调用模型的 run_experiment 方法运行实验。
• 保存结果：使用 helper_functions.save_results 方法保存实验结果。

3. 项目的配置文件介绍

config.yaml 是 DeepInception 项目的配置文件，包含实验参数和模型配置。以下是一个示例配置文件的内容：

target_model: vicuna
exp_name: main
defense: none
max_tokens: 512
cuda_device: 0
data_path: "data/dataset.csv"

配置项介绍

• target_model: 目标模型，可以是 vicuna, llama2, 或 falcon。
• exp_name: 实验名称，用于标识不同的实验。
• defense: 防御类型，可以是 none, basic, 或 advanced。
• max_tokens: 最大令牌数，用于控制模型输出的长度。
• cuda_device: CUDA 设备编号，用于指定 GPU 设备。
• data_path: 数据集路径，用于指定实验使用的数据集。

通过以上配置文件，可以灵活地调整实验参数和模型配置，以适应不同的实验需求。

DeepInception[arXiv:2311.03191] "DeepInception: Hypnotize Large Language Model to Be Jailbreaker"项目地址:https://gitcode.com/gh_mirrors/de/DeepInception