Reference overview¶
Use reference docs when you already know what concept you need and want precise technical details.
Reference map¶
| Name | Kind | Use when | Key constraints / notes |
|---|---|---|---|
| Python API | Reference page | You want the generated API reference entry point | Best when you already know the symbol family you need |
| Root package API | Reference page | You want a category-level view of top-level exports from themis |
Pairs well with the generated API page |
| Experiment lifecycle | Reference page | You want evaluate, Experiment, compile, run, or rejudge details |
Focused on authoring and execution flow |
| Stores and inspection | Reference page | You want persistence, reporting, bundle, or inspection helpers | Best for resume, reporting, and export workflows |
| Adapters | Reference page | You want provider-backed generator adapter details | Covers OpenAI, vLLM, and LangGraph adapters |
| CLI | Reference page | You want commands, inputs, and output shapes | Best for shell-driven workflows |
| Config schema | Reference page | You want config field behavior and identity implications | Best for config-driven experiments |
| Protocols | Reference page | You want extension contract details | Best for custom components and instrumentation |
| Data models | Reference page | You want runtime or projection model details | Best for inspection and downstream tooling |
| Builtins and adapters | Reference page | You want builtin component ids and adapter-family guidance | Best for choosing shipped components |
| Benchmark catalog | Reference page | You want named shipped benchmarks plus themis.catalog.load(...) and themis.catalog.run(...) |
Best for catalog-backed evaluation workflows |