GoldenRetriever Example Catalog
GoldenRetriever examples are the applied continuation of the core Retriever quickstart.
Each one is a real Pipeline of typed Flows you can run, step in-process, and
render. Start with the mock-safe commands below, confirm the output, then opt
into camera, simulator, or model-backed lanes.
First Verified Commands
Section titled “First Verified Commands”Every command runs with no robot, camera, model, or network. Run one, match the first line of output, then open its page for the code and the full run.
| Command | What it proves | Page |
|---|---|---|
demo-golden-hub-pack |
GoldenRetriever extends Retriever through a Hub manifest: exports load, registry resolves, Arrow round-trips. | Hub proof |
demo-composable-pipelines |
A registered pipeline can be extended and wrapped as a Flow, payloads staying typed. | Composition |
demo-robosuite-mock |
Environment-as-Flow and policy-as-Flow close a feedback loop with no simulator install. | Simulation |
demo-pipeline-html-viz |
The runtime IR validates and renders to ASCII plus an inspectable HTML graph. | Visualization |
Choose By Goal
Section titled “Choose By Goal”Once a proof runs, walk the perception → memory → language → composition ladder on deterministic payloads before adding heavier inputs.
- Perception and memory — synthetic detections, belief tracking, and pointing over standard
retriever.types.perceptionpayloads. - Language and grounding — captions and grounded references turned into primitive plans, no LLM required.
- Pipeline composition — registry-backed graphs you can extend and nest.
- Simulation and visualization — mock-safe robosuite, optional Rerun lanes, and HTML graph rendering.
- Robot payloads — world state, belief, plans, trajectories, and dataset/export profiles reused across examples.
Walkthrough Order
Section titled “Walkthrough Order”- Run the Hub proof so you know GoldenRetriever loads without optional robot dependencies.
- Run one deterministic perception or memory demo and recognize its typed output before adding heavier inputs.
- Render the graph with
demo-pipeline-html-vizwhen wiring is unclear — inspect ports, clocks, and feedback edges first. - Only then opt into camera, model-backed perception, real simulator, or dataset-export lanes.
Runtime Bridge
Section titled “Runtime Bridge”These pages assume the Flow, Pipeline, clock, and sync mental model from the core Retriever docs. GoldenRetriever focuses on robot-facing examples, typed payloads, and Hub pack candidates built on that runtime.
Maturity Levels
Section titled “Maturity Levels”| Level | Meaning | User expectation |
|---|---|---|
| Hub-loadable pack | Declared by the Hub manifest and loaded by Retriever Hub. | Safe to import and reuse as a pack boundary. |
| Promoted demo | Named Pixi task, docs page, expected output, and smoke coverage. | Safe for first-run docs and CI checks. |
| Source reference | Useful implementation pattern, not yet a public launch point. | Read the source after the promoted path works. |
| Optional integration | Requires camera, model, simulator, GPU, robot, or external service. | Use only when the dependency story is explicit. |
