> ## Documentation Index
> Fetch the complete documentation index at: https://docs.withwhile.com/llms.txt
> Use this file to discover all available pages before exploring further.

> ## Agent Instructions
> Install with `pip install whileai`; import as `import whileai as wai`.
> Run the offline path first (`simulator=False`, `wai.seeded_agent`, a callable judge); no key is needed for it.
> Report every pass rate with its interval and n, as `scored.pass_at` prints it.

# API reference

> Every public name in whileai and whileai.simulations, with its signature and docstring, generated from the package.

These pages are generated from the installed package on every change, so a
signature here is the signature the interpreter sees. Each name shows the
signature with its defaults, the file that defines it, and its docstring.
When to use which call, in the order a run happens, is on
[the five calls](/reference/five-calls); every knob with its default is on
[parameters](/reference/parameters); how a page is laid out is on
[design](/reference/design).

| Page                            | Names | What it holds                                                           |
| ------------------------------- | ----- | ----------------------------------------------------------------------- |
| [whileai](/api/whileai)         | 29    | The platform client: sign in, push traces, read the account.            |
| [data](/api/data)               | 6     | SimulationData: the object simulate() returns, and what it can do next. |
| [score](/api/score)             | 99    | Grading, judge checks, pass\@k, selection for SFT and RL, hack scans.   |
| [generate](/api/generate)       | 18    | Situation writers, coverage axes, agent adapters, model backends.       |
| [world](/api/world)             | 2     | The mock world that answers tool calls and fails on schedule.           |
| [verify](/api/verify)           | 3     | Verifiable rewards: programmatic checks a judge cannot game.            |
| [constants](/api/constants)     | 7     | Module-level constants and their defaults.                              |
| [environment](/api/environment) | 3     | A verifiers environment for on-policy trainers.                         |
| [export](/api/export)           | 7     | JSONL, preference pairs, and RL environments out of graded rows.        |
| [ingest](/api/ingest)           | 39    | Platform calls: datasets, traces, cuts, training runs, hosted models.   |
| [monitor](/api/monitor)         | 2     | Watch a live training run for reward hacking.                           |
| [run](/api/run)                 | 1     | The search loop that spends the budget.                                 |
| [schema](/api/schema)           | 10    | The typed row schema and its conversions.                               |
| [simulation](/api/simulation)   | 1     | simulate(): the entry point, and every argument it takes.               |
| [training](/api/training)       | 14    | Training runs, trainer callbacks, TRL export.                           |