AdrianLlopart commited on
Commit
12acba0
Β·
verified Β·
1 Parent(s): b0356b6

docs: HF model card for OpenRAL/rskill-playbook-find_object v0.1.0

Browse files
Files changed (1) hide show
  1. README.md +98 -0
README.md ADDED
@@ -0,0 +1,98 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ ---
2
+ language:
3
+ - en
4
+ license: apache-2.0
5
+ pipeline_tag: robotics
6
+ tags:
7
+ - OpenRAL
8
+ - rskill
9
+ - any
10
+ inference: false
11
+ ---
12
+
13
+ # rskill-playbook-find_object
14
+
15
+ A `kind: playbook` rSkill: a symbolic S2 **decision procedure** the
16
+ Reasoner reads, not a neural policy. It carries no weights β€” the authored
17
+ [`PLAYBOOK.md`](./PLAYBOOK.md) *is* its runtime.
18
+
19
+ ## What this skill does
20
+
21
+ Locates a named object the request didn't give a pose for. It recalls the object
22
+ from spatial memory; on a miss it runs a **bounded commonsense active search**
23
+ (rank likely rooms/containers β†’ navigate β†’ open β†’ look) and, if the search
24
+ budget is exhausted, escalates to a human. Concrete walkthrough: the water-bottle
25
+ example in [`PLAYBOOK.md`](./PLAYBOOK.md).
26
+
27
+ ## How it works
28
+
29
+ This playbook is **content, not code**. When installed, the reasoner injects
30
+ `PLAYBOOK.md` into its system prompt and follows the SOP, composing tools it
31
+ already has (`recall_object`, `resolve_place`, `locate_in_view`,
32
+ `execute_rskill`, `memory_search`). It is `role: s2` and is **never** dispatched
33
+ through `ExecuteSkill`. Every motion it triggers is an `execute_rskill` β†’ Action
34
+ chunk β†’ C++ safety kernel β€” the playbook holds no actuation authority (CLAUDE.md
35
+ Β§1.1).
36
+
37
+ ### Observation β†’ action contract
38
+
39
+ None. A playbook emits no `Action` chunks and requires no actuators
40
+ (`actuators_required: []`, `chunk_size: 1`). Its "output" is the sequence of
41
+ tool calls the reasoner makes while following the SOP, bounded by
42
+ `playbook.max_steps`.
43
+
44
+ ## How it was authored / Upstream provenance
45
+
46
+ N/A β€” a playbook is **hand-authored**, not trained: it has no weights and no
47
+ upstream model. Its provenance is the authoring decision record
48
+ (also linked via `paper_url`). To change behaviour, edit `PLAYBOOK.md` and bump
49
+ `version`.
50
+
51
+ ## Supported robots
52
+
53
+ Embodiment-agnostic β€” declares the explicit wildcard `embodiment_tags: ["any"]`
54
+ (never an empty list). Gated by `capabilities_required`
55
+ (`has_vision: true` β€” a real `RobotCapabilities` flag): the loader filters it out
56
+ on robots without a camera. Navigation / container-opening are gated at runtime by
57
+ the composed tools, not by this playbook's flags.
58
+
59
+ ## Sensors required
60
+
61
+ None directly. The tools it composes declare their own sensor needs.
62
+
63
+ ## Manifest summary
64
+
65
+ - `kind: playbook`, `role: s2`, `actions: [plan]`, `chunk_size: 1`.
66
+ - `playbook.trigger`: the goal names an object whose location is not given.
67
+ - `playbook.done_predicate`: the target object is confirmed in view at a known pose.
68
+ - `playbook.max_steps`: 12.
69
+
70
+ ## Quick start
71
+
72
+ ```python
73
+ from openral_core.schemas import RSkillManifest
74
+
75
+ m = RSkillManifest.from_yaml("rskills/find-object/rskill.yaml")
76
+ assert m.kind == "playbook" and m.playbook is not None
77
+ print(m.playbook.trigger)
78
+ ```
79
+
80
+ ## Reproduction
81
+
82
+ Packaging-only: the manifest + SOP are validated by
83
+ `tests/unit/test_playbook_rskill_manifest.py`. There is no benchmark number to
84
+ reproduce; the playbook's behaviour is exercised by the reasoner integration
85
+ tests in later phases.
86
+
87
+ ## Evaluation
88
+
89
+ N/A β€” no `eval/*.json`; a playbook produces no benchmarkable policy output.
90
+
91
+ ## License
92
+
93
+ - **Code / content:** Apache-2.0.
94
+ - **Weights:** none.
95
+
96
+ ## See also
97
+
98
+ - [`PLAYBOOK.md`](./PLAYBOOK.md) β€” the decision procedure itself.