# InstantML Docs

InstantML is hosted training observability for small ML teams: log runs from
your Python training loop, then sort, chart, and compare them in the dashboard.
Start with the quickstart to go from API key to a charted run in about five
minutes, or jump straight to the area you need below.

- [Quickstart](/docs/quickstart.md): Go from API key to your first charted run in five minutes.
- [Install the SDK](/docs/sdk/installation-auth.md): Install the Python package and authenticate.
- [Log from Python](/docs/sdk/logging.md): Create runs, log metrics, and attach configs and tags.
- [Compare runs](/docs/dashboard/compare-runs.md): Chart runs side by side and sort by metric summaries.
- [Dashboard tour](/docs/dashboard/tour.md): Walk through the main product surfaces with screenshots.
- [Workspaces](/docs/dashboard/organizations-workspaces.md): Manage members, roles, billing scope, and workspace switching.
- [Reports](/docs/dashboard/reports.md): Write experiment reports with live panels and share links.
- [API reference](/docs/api-reference.md): Browse the public REST API reference.
- [Examples](/docs/guides/examples.md): Run the bundled supervised, RL, checkpoint, and distributed examples.
- [Usage and limits](/docs/guides/export-usage-limits.md): Understand exports, usage counters, and plan limits.
- [Pricing](/docs/pricing.md): Compare Free, Pro, and Premium plans and what each includes.

## Log your first run

Log a complete run with a project, config, tags, and three metric series:

```python
import instantml as im

run = im.init(
    project="cartpole",
    name="ppo-seed-42",
    config={"seed": 42, "algorithm": "ppo", "learning_rate": 3e-4},
    tags=["ppo", "baseline"],
    notes="First PPO baseline.",
)

for step in range(100):
    run.log(
        {
            "train/reward": step * 1.5,
            "train/loss": 1.0 / (step + 1),
            "eval/accuracy": min(1.0, 0.5 + step / 200),
        },
        step=step,
    )

run.finish()
```

Open the dashboard when the script finishes. The project appears in the
project selector, the run appears in the run list, config values appear in Run
Detail and Compare, and every metric key becomes a chartable series.

![The Runs workspace charting logged metric series across runs](/docs/assets/images/product/dashboard-runs.png)

Ready to run it yourself? The [quickstart](/docs/quickstart.md) walks through the API
key, install, and first run end to end, and [Core concepts](/docs/concepts/core-concepts.md)
explains the workspace, project, run, and metric model behind it.

## Agent navigation

- [Docs index](/llms.txt)
- [Full docs bundle](/llms-full.txt)

### Get Started

- [Overview](/docs/index.md) (current page)
- [Quickstart](/docs/quickstart.md)
- [Core Concepts](/docs/concepts/core-concepts.md)
- [Pricing](/docs/pricing.md)
- [Benchmarks](/docs/benchmarks.md)
- [Examples](/docs/guides/examples.md)
- [Troubleshooting](/docs/troubleshooting.md)

### SDK

- [Installation Auth](/docs/sdk/installation-auth.md)
- [Logging](/docs/sdk/logging.md)
- [Tracing](/docs/sdk/tracing.md)
- [Metrics Steps](/docs/sdk/metrics-steps.md)
- [Config Tags Notes](/docs/sdk/config-tags-notes.md)
- [Artifacts Checkpoints](/docs/sdk/artifacts-checkpoints.md)
- [Rich Objects](/docs/sdk/rich-objects.md)
- [Distributed Training](/docs/sdk/distributed-training.md)
- [Console System Integrations](/docs/sdk/console-system-integrations.md)
- [Reliability](/docs/sdk/reliability.md)
- [Cli Login](/docs/sdk/cli-login.md)
- [Querying Data](/docs/sdk/querying-data.md)
- [Agent Mcp](/docs/sdk/agent-mcp.md)
- [Examples Patterns](/docs/sdk/examples-patterns.md)

### Integrations

- [Overview](/docs/integrations/overview.md)
- [Pytorch Lightning](/docs/integrations/pytorch-lightning.md)
- [Huggingface Transformers](/docs/integrations/huggingface-transformers.md)
- [Keras](/docs/integrations/keras.md)
- [Wandb](/docs/integrations/wandb.md)

### Dashboard

- [Tour](/docs/dashboard/tour.md)
- [Organizations Workspaces](/docs/dashboard/organizations-workspaces.md)
- [Runs Workspace](/docs/dashboard/runs-workspace.md)
- [Metrics Charts](/docs/dashboard/metrics-charts.md)
- [Run Detail](/docs/dashboard/run-detail.md)
- [Traces](/docs/dashboard/traces.md)
- [Compare Runs](/docs/dashboard/compare-runs.md)
- [Research Dashboards](/docs/dashboard/research-dashboards.md)
- [Artifacts Files](/docs/dashboard/artifacts-files.md)
- [Run Health](/docs/dashboard/alerts.md)
- [Datasets](/docs/dashboard/datasets.md)
- [Checkpoints](/docs/dashboard/checkpoints.md)
- [Reports](/docs/dashboard/reports.md)
- [Settings Api Keys](/docs/dashboard/settings-api-keys.md)
- [Api Tab](/docs/dashboard/api-tab.md)
- [Onboarding Team Billing](/docs/dashboard/onboarding-team-billing.md)

### Data

- [Imports](/docs/guides/imports.md)
- [W&B alternative](/docs/guides/wandb-alternative.md)
- [InstantML vs MLflow](/docs/guides/instantml-vs-mlflow.md)
- [W&B import guide](/docs/guides/wandb-import-guide.md)
- [W&B and Neptune imports](/docs/guides/wandb-neptune-imports.md)
- [Export Usage Limits](/docs/guides/export-usage-limits.md)
- [Pricing Limits Billing](/docs/guides/pricing-limits-billing.md)
- [Auth Billing Storage](/docs/guides/auth-billing-storage.md)
- [Customer Owned Clickhouse](/docs/guides/customer-owned-clickhouse.md)
- [Observability](/docs/guides/observability.md)

### API

**Practical API guides**

- [Authentication](/docs/api/authentication.md)
- [Errors And Limits](/docs/api/errors-and-limits.md)
- [Health Observability](/docs/api/health-observability.md)
- [Projects Runs](/docs/api/projects-runs.md)
- [Metrics Series](/docs/api/metrics-series.md)
- [Attributes Objects](/docs/api/attributes-objects.md)
- [Artifacts](/docs/api/artifacts.md)
- [Reports](/docs/api/reports.md)
- [Iframe Embeds](/docs/api/iframe-embeds.md)
- [Import Export Usage](/docs/api/import-export-usage.md)
- [Dashboard Control State](/docs/api/dashboard-control-state.md)
**Architecture**

- [System Overview](/docs/architecture/system-overview.md)
- [Service Planes](/docs/architecture/service-planes.md)
- [Storage Model](/docs/architecture/storage-model.md)
- [Google Clickhouse](/docs/architecture/google-clickhouse.md)
- [Auth Tenancy](/docs/architecture/auth-tenancy.md)
- [Schema Reference](/docs/architecture/schema-reference.md)

### API Reference

- [API Reference](/docs/api-reference.md)
