API Reference¶

These pages are generated from Python docstrings with mkdocstrings.

The API reference is intentionally curated. It focuses on reusable project surfaces that are useful when writing notebooks, experiments, and follow-on tooling. It is not a complete listing of every private helper in the source tree.

The import paths use the current package style:

from src.shield import TransitionShield
from src.opponent_model import ImaginedOpponent

Some symbols have sparse docstrings. They are included when their signatures and names are still useful lookup points.

Sections¶

• Core Utilities
• Environments
• Joint Graphs
• World Model
• Opponent Model
• Shielding
• RL
• Visualisation

The pages favor stable constructors, data contracts, persistence helpers, and notebook-facing functions. Implementation-private helpers remain discoverable in source but are intentionally omitted.