DeepTeam 项目启动与配置教程

DeepTeam 项目启动与配置教程

deepteam The LLM Red Teaming Framework 项目地址: https://gitcode.com/gh_mirrors/de/deepteam

1. 项目目录结构及介绍

DeepTeam 项目的目录结构如下：

deepteam/
├── .github/
├── assets/
├── deepteam-results-custom/
├── deepteam/
├── docs/
├── tests/
├── .gitignore
├── LICENSE.md
├── README.md
├── a.py
├── b.py
├── c.py
├── custom_red_team.py
├── examples.py
├── prompt.py
├── prompt2.py
├── pyproject.toml
├── red_team.py
├── uv.lock
└── yarn.lock

• .github/：存放与 GitHub 相关的配置文件，如工作流（Workflows）等。
• assets/：存放项目相关资源文件。
• deepteam-results-custom/：可能用于存储自定义红队测试的结果。
• deepteam/：项目核心代码目录，包含红队测试框架的实现。
• docs/：存放项目文档。
• tests/：存放单元测试和集成测试代码。
• .gitignore：配置 Git 忽略的文件。
• LICENSE.md：项目使用的 Apache-2.0 许可证。
• README.md：项目说明文件。
• a.py, b.py, c.py：示例 Python 文件，可能用于演示或测试。
• custom_red_team.py：自定义红队测试脚本。
• examples.py：示例代码文件。
• prompt.py 和 prompt2.py：可能用于生成或处理输入提示。
• pyproject.toml：Python 项目配置文件。
• red_team.py：红队测试主要逻辑实现。
• uv.lock 和 yarn.lock：项目依赖锁定文件。

2. 项目的启动文件介绍

项目的启动通常通过运行一个主脚本实现。在 DeepTeam 中，通常是通过执行 red_team.py 文件开始的。以下是启动文件的基本结构：

# red_team.py

def model_callback(input: str) -> str:
    # 这里应该实现对接你的语言模型系统的代码
    pass

# 导入红队模块以及其他必要的组件
from deepteam import red_team
from deepteam.vulnerabilities import Bias
from deepteam.attacks.single_turn import PromptInjection

# 设置红队测试的配置
risk_assessment = red_team(
    model_callback=model_callback,
    vulnerabilities=[Bias()],
    attacks=[PromptInjection()]
)

# 执行红队测试

在上述代码中，model_callback 是一个回调函数，用于对接你的语言模型系统。red_team 函数是启动红队测试的主要函数。

3. 项目的配置文件介绍

DeepTeam 项目的配置通常通过 Python 的 pyproject.toml 文件来管理，这个文件定义了项目的元数据和依赖项。以下是 pyproject.toml 文件的一个示例：

[build-system]
requires = ["setuptools", "wheel"]
build-backend = "setuptools.build_meta"

[tool.setuptools]
packages = find:
py_modules = find:
install-requires = []

[project]
name = "deepteam"
version = "0.1.0"
description = "A simple-to-use, open-source LLM red teaming framework."
authors = ["Confident AI"]
license = { file = "LICENSE.md" }
readme = "README.md"
requires-python = ">=3.7"
classifiers = [
    "Programming Language :: Python :: 3",
    "License :: OSI Approved :: Apache Software License",
    "Operating System :: OS Independent"
]

在 pyproject.toml 文件中，定义了项目名称、版本、描述、作者、许可证、README 文件以及其他元数据。此外，还可以指定项目依赖的 Python 版本和第三方包。

deepteam The LLM Red Teaming Framework 项目地址: https://gitcode.com/gh_mirrors/de/deepteam