Generated API reference

Sampling and control

sample	Sample locally, display diagnostics, and return PyMC inference data.
start	Begin sampling in a background thread and return a control handle.
iter_sample	Yield typed events; return `SamplingResult` as `StopIteration.value`.
SamplingHandle	Owns a background sampling run and its optional loopback dashboard.
RunControl	Thread-safe stop flag with a throttled external predicate.
SamplingResult	Generator return value: recovered inference data and its final report.

check_convergence	Assess any InferenceData against a convergence target.
read_report	The convergence report a pymc_monitor run attached, if any.
normalize_target	Resolve an `until=` value into a complete target dict (or None).
PhaseUpdate
SamplingProgress
ConvergenceUpdate
RunFinished
event_to_dict	Encode a progress event for JSON/msgpack cloud transports (wire version 1).
event_from_dict	Decode both version-1 and legacy cloud messages; skip unknown types.

Dashboard	Reusable FastAPI/uvicorn loopback service; dependencies load only on start.
DashboardState	Lock-protected reducer of local or cloud events; snapshots are JSON-safe copies.
render_dashboard_html	Render a fully self-contained, transport-independent dashboard page.
dashboard_csp	Hash the exact bundled inline assets and allow only explicit API origins.