AI Red Teaming Tool and Framework
Project description
How to Install dtx
Before you begin, choose how you want to run dtx depending on your environment and requirements.
Option 1: Install dtx locally with full dependencies (torch etc.)
This is recommended if you plan to run local models (e.g., Hugging Face, Ollama) on your machine.
pip install dtx[torch]
Includes:
- Core CLI
torch,transformersfor local LLM and classifier execution- Supports all datasets and local execution
Option 2: Install dtx if torch is already installed
If your environment already has torch installed (for example, in a GPU-accelerated ML environment), you can skip extras:
pip install dtx
dtx will use your existing torch installation.
Tip: Verify torch is installed:
python -c "import torch; print(torch.__version__)"
Option 3: Use uv for fast installation in a clean environment
If you're creating a new environment and want fast dependency resolution with uv:
Install uv
curl -LsSf https://astral.sh/uv/install.sh | sh
Install dtx with full dependencies
uv pip install dtx[torch]
Option 4: Use Docker wrapper (ddtx)
If you prefer Dockerized execution (no local torch install required), you can use ddtx.
- Install
dtx(for theddtxwrapper CLI):
pip install dtx
- Use
ddtxto run inside Docker:
ddtx redteam scope "Describe your agent" output.yml
Features:
- No need to install
torchlocally - Fully containerized execution
- Automatically mounts
.envand working directories - Use Docker-managed templates and tools
Summary of Options
| Method | Use case | Install command |
|---|---|---|
| Local, full dependencies | Full feature set, local models | pip install dtx[torch] |
| Local, existing torch | You already have torch installed |
pip install dtx |
| New env, fast install | Clean, fast setup | uv pip install dtx[torch] |
| Docker (ddtx) | No local Python dependencies, isolated | pip install dtx + use ddtx CLI |
How to Get Started (Development)
Follow these steps to set up dtx for local development.
1. Clone the Repository
git clone https://github.com/YOUR-ORG/dtx.git
cd dtx
2. Install Dependencies
Run the following command:
make install
This will:
- Ensure the
poetry-plugin-exportis installed - Install all dependencies including
devandtorchgroups - Set up the
dtxpackage in editable mode
3. Activate the Virtual Environment
Run this in your shell to activate the Poetry-managed virtual environment:
eval $(poetry env activate)
Alternatively, you can run:
make venv
This will print the exact eval command you need to run manually. For example:
Note: make cannot modify your current shell environment, so you must run the eval command directly.
4. Run the CLI
Once the environment is active, you can use the CLI:
dtx --help
5. Export Requirements (Optional)
To export the current environment to a requirements.txt file (useful for pip-based tools or deployment):
make export
This will generate a requirements.txt file including development and optional dependencies like torch.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file dtx-0.20.1.tar.gz.
File metadata
- Download URL: dtx-0.20.1.tar.gz
- Upload date:
- Size: 742.6 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: poetry/2.1.3 CPython/3.11.8 Linux/6.11.0-1015-azure
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
30fb8faa596860f06ee3cefac8bfa212ce09979b7eec1b194149e7fcc91eda47
|
|
| MD5 |
1a4327d5253db92761dff45724a9976e
|
|
| BLAKE2b-256 |
96cc964569e8d678c434e4d10faf5f94e5b0507f2ef6fd4dbfa5a850b7b502f4
|
File details
Details for the file dtx-0.20.1-py3-none-any.whl.
File metadata
- Download URL: dtx-0.20.1-py3-none-any.whl
- Upload date:
- Size: 843.0 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: poetry/2.1.3 CPython/3.11.8 Linux/6.11.0-1015-azure
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
cefdf749a9ae3bebc151fd01e2d0f595e6af1974c8513cdbac90b90c31deca31
|
|
| MD5 |
ffab18e0af558c3f74a5c25c7409e10e
|
|
| BLAKE2b-256 |
778442809cfdd098dff771bb100405064f7e89eb092d0fe988f617d165525291
|