Skip to content

API Reference

This section is a curated reference for the project entrypoints that notebooks and downstream scripts are most likely to use. It is intentionally not a dump of every helper under src/.

The public surface is still research-code shaped. Prefer the higher-level experiment helpers when running benchmark suites, and treat private names that start with _ as implementation details even when they appear in source files.

Sections

  • Monitor: temporal reward monitors, wrapper config, and counterfactual replay helpers.
  • Experiments: reusable suite specs and runner entrypoints.
  • Environments: environment factories and temporal constraint wrappers.
  • Verification: satisfaction, NashConv, and AlphaRank reporting helpers.
  • Visualisation: plotting and legend export helpers used by notebooks.

Import Path

The repository is used directly from its root. API identifiers therefore start with src, for example:

from src.monitor import BoolRewardWrapper, SpecPair
from src.experiments.temporal_game_experiment import run_temporal_game_experiments