Tutorials
Use tutorials when you want a guided build rather than an API catalog. The recommended first path is:
- Getting Started
- Capture Evidence
- Artifact Handling
- Compare Runs
- Query And Diagnostics
- Common Workflows
- Batch, Sample & Deployment
Choose A Path
| Goal | Start here | What you will learn |
|---|---|---|
| Get one local workspace working | Getting Started | install, capture evidence, inspect local output |
| Decide which execution evidence to capture | Capture Evidence | metrics, events, and execution context |
| Connect produced files to a run | Artifact Handling | real outputs, hashes, and registration evidence |
| Select between candidate executions | Compare Runs | measured comparison and resulting artifacts |
| Read and investigate stored evidence | Query And Diagnostics | query, comparison, and diagnostics roles |
| Learn the daily workflow | Common Workflows | inspect, report, diagnose, trace lineage |
| Track repeated work | Batch, Sample & Deployment | batches, samples, deployments, report sections |
| Use notebooks | Notebook Surface | inline summaries, display helpers, DataFrame conversion |
| Connect external tools | Adapters | Stdout, OpenTelemetry, and MLflow sink boundaries |
| Map Contexta to real incidents | Case Studies | complete scenario-specific programs and the evidence each one needs |
Example Policy
Workflow examples should be executable by default. When a page teaches a domain workflow, examples should be presented with Docusaurus tabs for:
- Machine Learning
- Deep Learning
- LLM
Short API snippets are acceptable on reference pages, but tutorial examples should create a workspace, emit evidence, and print something visible such as a run ref, report path, comparison result, or capture file.
Workflow examples should compute evidence from the work they execute, rather than insert illustrative output values.
Prerequisites
Most tutorials assume:
- Python
>=3.14 contextainstalled in the active environment- a writable local directory
Optional framework packages belong to the tutorial that needs them. Contexta's core runtime stays local-first and does not require a cloud account.