Schemas / Simulation

rig.sim.episode

v1.0.0 · stable maturity: draft 5 fields 0 required

Fields

FieldTypeMeaning
clip entity optional Optional. rig.anim.clip of the take. Absent = outcome only
task string optional Optional. Host task name, the same idea as an rig.ai.behavior action
success bool optional Optional. Whether the task finished. Absent = not judged
actions array<entity> optional Optional. rig.anim.track entities commanded as actions. Absent = none
observations array<entity> optional Optional. Tracks recorded as observations. Absent = none

One recorded attempt. Format when present. At least one field.

When clip is set, every track in actions and observations has that clip. Images stay on their own entities (rig.pixel.source, rig.media.asset_ref). Policy weights stay in the host.

success absent is not a failure. An unknown task name still records; the host may ignore it.

A policy that trains or is scored on this attempt is rig.ai.policy. Fields redrawn at reset are rig.sim.domain.

JSON Schema

Resolves at https://rig.works/schemas/rig.sim.episode.schema.json — raw file.

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://rig.works/schemas/rig.sim.episode.schema.json",
  "title": "rig.sim.episode",
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "clip": {
      "$ref": "./_defs.schema.json#/$defs/entity"
    },
    "task": {
      "$ref": "./_defs.schema.json#/$defs/string"
    },
    "success": {
      "$ref": "./_defs.schema.json#/$defs/bool"
    },
    "actions": {
      "type": "array",
      "items": {
        "$ref": "./_defs.schema.json#/$defs/entity"
      }
    },
    "observations": {
      "type": "array",
      "items": {
        "$ref": "./_defs.schema.json#/$defs/entity"
      }
    }
  },
  "minProperties": 1,
  "x-rig-maturity": "draft"
}

Seen in

robot-lab.json · robot-lesson.json