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

# Curated catalog

> Seventeen curated world-model and VLA adapter records ship with WorldFlux. Each entry names its provider, runtime, benchmark, VRAM floor, support level, and known issues.

The catalog is two artifacts that stay in sync:

* `src/worldflux/curated.py` — the Python source the CLI reads at `worldflux init --recipe <id>` and `worldflux curated *` time.
* `web/lib/catalog-data.ts` — the TypeScript copy the dashboard's Catalog tab renders.

Both files describe the same adapter set. Keep them aligned when changing the catalog; the Python source is the CLI source of truth and the TS copy is what the dashboard renders.

## Entry shape

```ts theme={null}
type CatalogAdapter = {
  id: string;
  name: string;
  description: string;
  provider: string;
  providerSlug: string;
  runtime: string;                 // e.g. "local" | "replicate" | "modal" | "nvidia-cloud"
  tier: "active" | "historical" | "demo";
  modelFamily: string;
  endpointTypes: string[];         // "rollout" | "train" | "eval" | "embed" | "predict" | "serve" | "generate"
  minimumVramGb: number | null;
  minimumCuda: string | null;
  upstreamLicense: string;
  version: string;
  smokePrompt: string;
  metricKeys: string[];
  outputArtifacts: string[];
  evalBenchId: string | null;
  knownIssues: string[];
  supportLevel: "production-backed" | "production-disabled" | "experimental-not-shipped";
  supportNote: string;
};
```

Field notes:

| Field                            | Purpose                                                                                                                                                        |
| -------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `id`                             | What you pass to `--recipe`. Matches the directory under `src/worldflux/templates/` for adapters that ship a template.                                         |
| `runtime`                        | The default runtime plugin to use. Today the catalog points at `local` or `replicate`; deployable adapters can also expose `modal` as a BYOK deploy target.    |
| `tier`                           | `active` if CI runs against it, `historical` if it loads but no longer gets fixes. The dashboard pill is green / red.                                          |
| `endpointTypes`                  | What the adapter can do. Used by the dashboard's filter + the recipe's task picker.                                                                            |
| `minimumVramGb`                  | Observed floor on a clean install. Lower works for tiny modes; do not assume.                                                                                  |
| `minimumCuda`                    | Required CUDA toolkit version, if any. `null` for CPU-friendly adapters.                                                                                       |
| `evalBenchId`                    | The eval bridge wired in for this adapter (`libero`, `robocasa`, `vjepa_embed`, `minecraft_offline`).                                                          |
| `metricKeys`                     | The metric names the adapter writes into `manifest.metrics`. Used by `worldflux compare` to know what to diff.                                                 |
| `outputArtifacts`                | Filenames the adapter promises to commit. The manifest writer rejects runs that miss them.                                                                     |
| `deploy_targets` (Python source) | Explicit remote serving surfaces available from `worldflux curated deploy`; entries are not production-backed runtime support unless adapter metadata says so. |
| `smokePrompt`                    | The prompt or seed used by the smoke test.                                                                                                                     |
| `knownIssues`                    | Short notes the dashboard surfaces in a yellow callout.                                                                                                        |
| `supportLevel` (dashboard copy)  | Public support claim shown to users. Catalog visibility is not the same as production-backed execution.                                                        |

## What ships today

| `id`                                       | Tier       | Runtime        | Bench                  | Public support           |
| ------------------------------------------ | ---------- | -------------- | ---------------------- | ------------------------ |
| `cosmos_predict25`                         | active     | `replicate`    | `robocasa`             | production-disabled      |
| `dreamer4`                                 | active     | `local`        | `minecraft_offline`    | experimental-not-shipped |
| `internvla_m1`                             | active     | `local`        | `libero`               | experimental-not-shipped |
| `openpi`                                   | active     | `local`        | `libero`               | production-disabled      |
| `smolvla_450m`                             | active     | `local`        | `lerobot`              | experimental-not-shipped |
| `gr00t_n1_7`                               | active     | `local`        | `libero`               | production-disabled      |
| `pi07`                                     | active     | `local`        | `libero`               | experimental-not-shipped |
| `vjepa2`                                   | active     | `local`        | `vjepa_embed`          | experimental-not-shipped |
| `openvla-libero-pro-lighting`              | demo       | `modal`        | `libero-pro`           | production-disabled      |
| `openvla-libero-pro-object_pose`           | demo       | `modal`        | `libero-pro`           | production-disabled      |
| `gr00t-n17-isaac-lab-25task`               | demo       | `nvidia-cloud` | `gr00t-isaac-lab`      | production-disabled      |
| `cosmos-predict-25-isaac-sim-drift-5frame` | demo       | `modal`        | `cosmos-predict-drift` | production-disabled      |
| `diamond`                                  | historical | `local`        | (not wired)            | experimental-not-shipped |
| `dreamerv3`                                | historical | `local`        | (not wired)            | experimental-not-shipped |
| `storm`                                    | historical | `local`        | (not wired)            | experimental-not-shipped |
| `tdmpc2`                                   | historical | `local`        | (not wired)            | experimental-not-shipped |
| `vjepa2_vitl`                              | historical | `local`        | `vjepa_embed`          | experimental-not-shipped |

## Templates and deploy targets

Serving templates live under `src/worldflux/templates/` for the adapters that
support BYOK deploy or dry-run demo flows:

* `cosmos_predict25/`
* `openpi/`
* `openvla_libero_pro/`
* `vjepa2_vitl/`

These templates power BYOK deploy/run-remote flows:

```bash theme={null}
worldflux curated deploy cosmos_predict25 --runtime modal
worldflux curated run-remote cosmos_predict25 generate
worldflux curated status cosmos_predict25
worldflux curated undeploy cosmos_predict25
```

For local installed adapters, use `worldflux use <id>` followed by the `env` tree:

```bash theme={null}
worldflux use openpi
worldflux env build openpi
worldflux curated run openpi rollout
```

## Browsing

```bash theme={null}
worldflux curated list
worldflux curated inspect cosmos_predict25
```

`inspect` prints the full record, including known issues. The dashboard's Catalog tab renders the same data with search and runtime/tier filters.

## Adding an adapter

<Steps>
  <Step title="Add to curated.py">
    Append a `CuratedAdapter(...)` entry to `src/worldflux/curated_registry.py` through the `src/worldflux/curated.py` compatibility facade. Fill every field; the dashboard treats `null` as "unknown" and renders accordingly.
  </Step>

  <Step title="Update the dashboard copy">
    Mirror the user-facing fields in `web/lib/catalog-data.ts` so the Catalog tab stays in sync with the CLI source.
  </Step>

  <Step title="Run it once">
    The cutoff for `tier: active` is one passing CI run plus a documented benchmark id. Until then, set `tier: "historical"` and `evalBenchId: null`.
  </Step>

  <Step title="Drop a template (optional)">
    If the adapter has a non-trivial `run.py`, add it under `src/worldflux/templates/<id>/`. The init command picks it up automatically.
  </Step>
</Steps>
