Skip to content

README.md

Latest commit

 

History

History
108 lines (72 loc) · 4.07 KB

README.md

File metadata and controls

108 lines (72 loc) · 4.07 KB
Raw

ORA documentation

Run a language model as a robot policy. ORA supplies the robot manual, observation tools, supervised actions, and a record of every episode.

Open Robot-Use Agents · Python 3.11 · OpenAI-compatible and Anthropic APIs

[Run your first episode](quickstart.md){ .md-button .md-button--primary } [Run robot tasks on one GPU](getting-started/single-gpu.md){ .md-button } [Choose a robot environment](environments/README.md){ .md-button }

Start here

  • Getting started

    Install the locked Python environment and connect your model API. The first episode uses Synthetic: no simulator, model download, or GPU.

    Installation →

  • One GPU, one command

    On a Linux machine with one NVIDIA GPU and a DeepSeek key, ora setup --env installs LIBERO, RoboTwin or RoboDojo and ora run --env … --task … runs one task in the terminal UI.

    LIBERO → · RoboTwin → · RoboDojo → · One-GPU guide →

  • Robot environments

    Set up LIBERO / LIBERO-Pro, RoboTwin, or RoboDojo in an isolated simulator environment, then compose and run one task.

    Environment guides →

  • Runs and evidence

    Inspect the plan, model calls, executed actions, official result, and seal. Browse trajectories in the local read-only viewer.

    Run and inspect →

  • Build on ORA

    Read the architecture and Python interfaces. Extend a backend, tool surface, or prompt bundle using the authoring guides.

    Architecture → · Python API →

First episode

From a source checkout, install ORA and check the environment:

uv sync --all-extras --locked
uv run --locked ora doctor

Set ORA_API_KEY in your shell, then run:

uv run --locked ora run --env synthetic

This calls a real model and saves a sealed episode under outputs/quickstart/runs/<run-id>/. Synthetic verifies the agent/runtime connection; its official_success is null.

Complete quickstart and API configuration

Terminal UI

ORA replaying a LIBERO episode in the terminal

ora watch RUN_ID follows a live run or replays a finished one as a terminal transcript; ora interactive and ora local add a task picker and let you steer the running agent. Install the front end once with npm ci --prefix ora-tui (Node.js 20+). See run and inspect, interactive sessions and run ORA on your computer.

Choose an environment

Environment Robot / simulator Guide
LIBERO / LIBERO-Pro Panda manipulation in MuJoCo Install and run
RoboTwin Dual-arm manipulation in SAPIEN Install and run
RoboDojo Isaac Sim task environments Install and run

The simulators, assets, perception weights, and GPU requirements are installed separately from ORA. Supported setups records the tested scope.

Find what you need

I want to… Read
Use a self-hosted model or Anthropic Model APIs
Fix an installation or run problem Troubleshooting
Inspect a run or export evidence User guide
Understand the action and trust boundaries Runtime lifecycle
Configure a benchmark task Configuration
Change tools or robot instructions Tool surfaces · Prompt bundles
Contribute or maintain these docs Contributing · Documentation guide