Skip to content

Golden Export Catalog

Hub-loadable boundary

The Golden pack should stay import-safe: loading these exports must not require a camera, simulator, model, robot, network service, or local source-tree knowledge. This page mirrors the current [tool.retriever.module.exports] manifest.

Verify the manifest boundary
pixi run demo-golden-hub-pack

Expected result: exports load, representative payloads instantiate, and the Arrow conversion helpers round-trip a lightweight action payload.

SceneNeed current or remembered state?

Start with WorldState, RobotState, or BeliefGraph.

TaskNeed planner handoff?

Start with TaskGoal, Skill, Plan, or StructuredPlan.

ExchangeNeed lightweight conversion?

Use Action, Command, Status, and Arrow helpers.

SceneWorld and belief

WorldState, RobotState, and BeliefGraph cover current state and remembered state.

TaskGoal, skill, plan

TaskGoal, Skill, Plan, and StructuredPlan cover planner-facing intent and action structure.

ControlTrajectory and status

Trajectory and ExecutionStatus cover motion handoff and progress reporting.

InteropCore helpers

Action, Command, Status, convert_to_arrow, and convert_from_arrow cover lightweight exchange and dataset paths.

Export Source First use
WorldState retriever_typing.robotics_types:WorldState Perception, memory, planning.
RobotState retriever_typing.robotics_types:RobotState Robot wrapper, monitor, policy.
BeliefGraph retriever_typing.robotics_types:BeliefGraph Memory and grounding.
Skill retriever_typing.robotics_types:Skill Planner to controller handoff.
Plan retriever_typing.robotics_types:Plan Task planning.
StructuredPlan retriever_typing.robotics_types:StructuredPlan Typed multi-step planning.
TaskGoal retriever_typing.robotics_types:TaskGoal User intent, affordances, and success criteria.
Trajectory retriever_typing.robotics_types:Trajectory Motion planner/controller examples.
ExecutionStatus retriever_typing.robotics_types:ExecutionStatus Monitor and controller outputs.
Action retriever_typing.core_types:Action Lightweight action payloads.
Command retriever_typing.core_types:Command Runtime or robot command payloads.
Status retriever_typing.core_types:Status Status exchange and smoke demos.
convert_to_arrow retriever_typing.conversions:convert_to_arrow Dataset and event stream examples.
convert_from_arrow retriever_typing.conversions:convert_from_arrow Dataset and event stream examples.
from retriever import hub
from retriever_typing.robotics_types import WorldState

WorldStateFromHub = hub.use("openretriever/golden-retriever:WorldState")
assert WorldStateFromHub.__name__ == WorldState.__name__

Promotion rule: a Golden export is public only when this catalog, the manifest, and demo-golden-hub-pack agree. If an export needs optional simulator/model/camera dependencies, keep it source-only until it has a lightweight boundary.