API Reference¶
Auto-generated reference for pikit's public API, powered by mkdocstrings.
| Module | What it covers |
|---|---|
| Base Classes | Attack, Defense, Channel abstract base classes |
| Attacks | pikit.attacks — registry and all attack classes |
| Defenses | pikit.defenses — registry and all defense classes |
| Channels | pikit.channels — registry and all channel classes |
| Targets | pikit.targets — Target, get_target, data structures |
| Agent | pikit.agent — Agent, Trace, DefenseHooks, Tool |
| craft() | pikit.craft — craft(), CraftResult |
| Registry | pikit.registry — Registry class |
Quick lookup¶
# Top-level imports
from pikit import (
attacks, channels, defenses, # registries
Attack, Channel, Defense, # base classes
Target, get_target, # model backends
craft, CraftResult, # unified entry point
)
# Agent subsystem
from pikit.agent import (
get_agent, DefenseHooks, # agent factory + defense hooks
Agent, Trace, TraceStep, # base class + trace types
Tool, tool, # tool wrapper + decorator
)