AdrianLlopart commited on
Commit
e716e03
Β·
verified Β·
1 Parent(s): b646124

docs: HF model card for OpenRAL/rskill-moveit-multi-joints v0.1.0

Browse files
Files changed (1) hide show
  1. README.md +10 -12
README.md CHANGED
@@ -19,22 +19,21 @@ tags:
19
  inference: false
20
  ---
21
 
22
- # rskill-moveit-joints
23
 
24
  > **OpenRAL rSkill** β€” wraps the upstream `moveit_msgs/action/MoveGroup`
25
  > action server as an OpenRAL rSkill so the Reasoner can dispatch
26
  > collision-free joint-space motion planning through the same
27
  > `ExecuteRskill` path used by VLA skills. No model weights β€” the manifest
28
  > is the entire artefact. Renamed from `openral/rskill-moveit-plan-arm`
29
- > under [ADR-0054](../../docs/adr/0054-moveit-goal-builder-library.md).
30
 
31
- This package uses `kind: ros_action` (see
32
- [ADR-0024](../../docs/adr/0024-ros-wrapped-rskills.md)) β€” a discriminator
33
  on `RSkillManifest.kind` that selects the
34
  [`ROSActionRskill`](../../python/rskill/src/openral_rskill/ros_action_rskill.py)
35
  engine at resolve time, with `ros_integration.goal_builder: joint` selecting
36
  the [`JointGoalRskill`](../../python/rskill/src/openral_rskill/joint_goal_rskill.py)
37
- goal-lowering adapter (ADR-0054). The adapter constructs an
38
  `rclpy.action.ActionClient` on the host `RskillRunnerNode`, sends one goal
39
  built from `ros_integration.default_goal_json`, awaits the result, and replays
40
  the returned `trajectory_msgs/JointTrajectory` one waypoint per `step()` call
@@ -109,7 +108,7 @@ Packing the full trajectory as one chunk with `horizon=N` would let
109
  waypoints 1..N actuate unchecked β€” unacceptable for a planner whose
110
  job is to thread between joint-limit walls.
111
 
112
- ### GPU-accelerated planning (cuMotion, ADR-0065)
113
 
114
  On a host that clears the cuMotion GPU floor (`RobotCapabilities.supports_cumotion()`
115
  β€” Ampere+, CUDA β‰₯ 13, ~8 GB VRAM), the runner sets
@@ -168,7 +167,7 @@ MoveIt node's launch β€” the wrapped action's contract is intact.
168
 
169
  | Field | Value |
170
  | --- | --- |
171
- | `name` | `OpenRAL/rskill-moveit-joints` |
172
  | `version` | `0.1.0` |
173
  | `license` | `apache-2.0` |
174
  | `kind` | `ros_action` |
@@ -205,7 +204,7 @@ ros2 launch openral_rskill_ros skill_runner.launch.py robot:=franka_panda
205
 
206
  # 3. From the Reasoner (or by hand via the action CLI), dispatch the goal:
207
  ros2 action send_goal /openral/execute_rskill openral_msgs/action/ExecuteRskill \
208
- "{rskill_id: 'OpenRAL/rskill-moveit-joints', deadline_s: 30.0, prompt: 'move to home'}"
209
  ```
210
 
211
  ## Limitations / Roadmap
@@ -227,14 +226,13 @@ ros2 action send_goal /openral/execute_rskill openral_msgs/action/ExecuteRskill
227
  The rSkill package itself (this manifest + README) is **Apache-2.0**.
228
  The wrapped MoveIt code (`moveit_msgs` IDL, `moveit2` planners) is
229
  **BSD-3-Clause** and lives outside this repository β€” installed via
230
- `ros-${ROS_DISTRO}-moveit`. Per
231
- [ADR-0012](../../docs/adr/0012-open-core-licensing.md) both postures
232
  are commercial-use-permissive.
233
 
234
  ## See also
235
 
236
- - [ADR-0054 β€” MoveIt goal-builder library + rskill-moveit-* rename](../../docs/adr/0054-moveit-goal-builder-library.md)
237
- - [ADR-0024 β€” ROS-wrapped rSkills](../../docs/adr/0024-ros-wrapped-rskills.md)
238
  - [`openral_rskill.ros_action_rskill`](../../python/rskill/src/openral_rskill/ros_action_rskill.py) β€” engine source
239
  - [`openral_rskill.joint_goal_rskill`](../../python/rskill/src/openral_rskill/joint_goal_rskill.py) β€” goal-lowering adapter
240
  - [`rskills/rskill-moveit-eef-pose/`](../rskill-moveit-eef-pose/) β€” sibling Cartesian end-effector pose wrapper
 
19
  inference: false
20
  ---
21
 
22
+ # rskill-moveit-multi-joints
23
 
24
  > **OpenRAL rSkill** β€” wraps the upstream `moveit_msgs/action/MoveGroup`
25
  > action server as an OpenRAL rSkill so the Reasoner can dispatch
26
  > collision-free joint-space motion planning through the same
27
  > `ExecuteRskill` path used by VLA skills. No model weights β€” the manifest
28
  > is the entire artefact. Renamed from `openral/rskill-moveit-plan-arm`
29
+ > as part of the `rskill-moveit-*` rename.
30
 
31
+ This package uses `kind: ros_action` β€” a discriminator
 
32
  on `RSkillManifest.kind` that selects the
33
  [`ROSActionRskill`](../../python/rskill/src/openral_rskill/ros_action_rskill.py)
34
  engine at resolve time, with `ros_integration.goal_builder: joint` selecting
35
  the [`JointGoalRskill`](../../python/rskill/src/openral_rskill/joint_goal_rskill.py)
36
+ goal-lowering adapter. The adapter constructs an
37
  `rclpy.action.ActionClient` on the host `RskillRunnerNode`, sends one goal
38
  built from `ros_integration.default_goal_json`, awaits the result, and replays
39
  the returned `trajectory_msgs/JointTrajectory` one waypoint per `step()` call
 
108
  waypoints 1..N actuate unchecked β€” unacceptable for a planner whose
109
  job is to thread between joint-limit walls.
110
 
111
+ ### GPU-accelerated planning (cuMotion)
112
 
113
  On a host that clears the cuMotion GPU floor (`RobotCapabilities.supports_cumotion()`
114
  β€” Ampere+, CUDA β‰₯ 13, ~8 GB VRAM), the runner sets
 
167
 
168
  | Field | Value |
169
  | --- | --- |
170
+ | `name` | `OpenRAL/rskill-moveit-multi-joints` |
171
  | `version` | `0.1.0` |
172
  | `license` | `apache-2.0` |
173
  | `kind` | `ros_action` |
 
204
 
205
  # 3. From the Reasoner (or by hand via the action CLI), dispatch the goal:
206
  ros2 action send_goal /openral/execute_rskill openral_msgs/action/ExecuteRskill \
207
+ "{rskill_id: 'OpenRAL/rskill-moveit-multi-joints', deadline_s: 30.0, prompt: 'move to home'}"
208
  ```
209
 
210
  ## Limitations / Roadmap
 
226
  The rSkill package itself (this manifest + README) is **Apache-2.0**.
227
  The wrapped MoveIt code (`moveit_msgs` IDL, `moveit2` planners) is
228
  **BSD-3-Clause** and lives outside this repository β€” installed via
229
+ `ros-${ROS_DISTRO}-moveit`. Both postures
 
230
  are commercial-use-permissive.
231
 
232
  ## See also
233
 
234
+ - MoveIt goal-builder library + rskill-moveit-* rename
235
+ - ROS-wrapped rSkills
236
  - [`openral_rskill.ros_action_rskill`](../../python/rskill/src/openral_rskill/ros_action_rskill.py) β€” engine source
237
  - [`openral_rskill.joint_goal_rskill`](../../python/rskill/src/openral_rskill/joint_goal_rskill.py) β€” goal-lowering adapter
238
  - [`rskills/rskill-moveit-eef-pose/`](../rskill-moveit-eef-pose/) β€” sibling Cartesian end-effector pose wrapper