Skip to content

Commit dd284a7

Browse files
committed
docs: convert parameter tables to list format with param-type spans
1 parent ce06730 commit dd284a7

11 files changed

Lines changed: 247 additions & 292 deletions

File tree

InterDataEngine-docs/concepts/cameras.md

Lines changed: 9 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -79,14 +79,12 @@ cx, cy = principal point (pixels)
7979

8080
### Sensor Settings
8181

82-
| Parameter | Description | Typical Value |
83-
|-----------|-------------|---------------|
84-
| `resolution_width` | Image width in pixels | 640 - 1920 |
85-
| `resolution_height` | Image height in pixels | 480 - 1080 |
86-
| `pixel_size` | Physical pixel size (μm) | 1.4 - 3.0 |
87-
| `f_number` | Lens aperture | 1.8 - 4.0 |
88-
| `focus_distance` | Focus distance (m) | 0.3 - 1.0 |
89-
| `frequency` | Capture frequency (Hz) | 15 - 60 |
82+
- **resolution_width** (<span class="param-type">int</span>): Image width in pixels. Typical value: 640 - 1920.
83+
- **resolution_height** (<span class="param-type">int</span>): Image height in pixels. Typical value: 480 - 1080.
84+
- **pixel_size** (<span class="param-type">float</span>): Physical pixel size (μm). Typical value: 1.4 - 3.0.
85+
- **f_number** (<span class="param-type">float</span>): Lens aperture. Typical value: 1.8 - 4.0.
86+
- **focus_distance** (<span class="param-type">float</span>): Focus distance (m). Typical value: 0.3 - 1.0.
87+
- **frequency** (<span class="param-type">int</span>): Capture frequency (Hz). Typical value: 15 - 60.
9088

9189
## Camera Mounting
9290

@@ -125,11 +123,9 @@ cameras:
125123

126124
`CustomCamera.get_observations()` returns:
127125

128-
| Output | Shape | Description |
129-
|--------|-------|-------------|
130-
| `color_image` | H×W×3 | RGB image (float32) |
131-
| `camera2env_pose` | 4×4 | Camera to environment transform |
132-
| `camera_params` | 3×3 | Intrinsic matrix K |
126+
- **color_image** (<span class="param-type">ndarray</span>): RGB image with shape H×W×3 (float32).
127+
- **camera2env_pose** (<span class="param-type">ndarray</span>): Camera to environment transform matrix with shape 4×4.
128+
- **camera_params** (<span class="param-type">ndarray</span>): Intrinsic matrix K with shape 3×3.
133129

134130
## Key Files
135131

InterDataEngine-docs/concepts/robots.md

Lines changed: 30 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -289,12 +289,10 @@ lift_home: [0.46] # Lift joint default position (meters
289289

290290
### Task-Level Fields
291291

292-
| Field | Description |
293-
|-------|-------------|
294-
| `name` | Robot identifier used in skills and cameras |
295-
| `robot_config_file` | Path to robot-specific YAML configuration file |
296-
| `euler` | Initial robot orientation in degrees [roll, pitch, yaw] |
297-
| `ignore_substring` | Collision filter substrings to ignore during simulation |
292+
- **name** (<span class="param-type">str</span>): Robot identifier used in skills and cameras.
293+
- **robot_config_file** (<span class="param-type">str</span>): Path to robot-specific YAML configuration file.
294+
- **euler** (<span class="param-type">list</span>): Initial robot orientation in degrees [roll, pitch, yaw].
295+
- **ignore_substring** (<span class="param-type">list</span>): Collision filter substrings to ignore during simulation.
298296

299297
### Robot-Specific Fields
300298

@@ -437,34 +435,32 @@ fl_gripper_keypoints:
437435

438436
### Other Fields
439437

440-
| Field | Description |
441-
|-------|-------------|
442-
| `target_class` | Python class for robot wrapper (e.g., `Lift2`, `FR3`) |
443-
| `path` | USD file path relative to asset root |
444-
| `robot_file` | CuRobo kinematics config file(s) - one per arm |
445-
| `gripper_max_width` | Maximum gripper opening width (meters) |
446-
| `gripper_min_width` | Minimum gripper closing width (meters) |
447-
| `solver_position_iteration_count` | Physics solver position iterations |
448-
| `solver_velocity_iteration_count` | Physics solver velocity iterations |
449-
| `stabilization_threshold` | Physics stabilization threshold |
450-
| `left_joint_indices` | Joint indices for left arm in articulation |
451-
| `right_joint_indices` | Joint indices for right arm in articulation |
452-
| `left_gripper_indices` | Gripper joint index for left arm |
453-
| `right_gripper_indices` | Gripper joint index for right arm |
454-
| `lift_indices` | Lift joint indices (for robots with lift mechanism) |
455-
| `fl_base_path` | Left arm base prim path |
456-
| `fr_base_path` | Right arm base prim path |
457-
| `fl_filter_paths` | Collision filter prims' paths for left arm |
458-
| `fr_filter_paths` | Collision filter prims' paths for right arm |
459-
| `fl_forbid_collision_paths` | Forbidden collision prims' paths for left arm |
460-
| `fr_forbid_collision_paths` | Forbidden collision prims' paths for right arm |
461-
| `left_joint_home` | Default joint positions for left arm (radians) |
462-
| `right_joint_home` | Default joint positions for right arm (radians) |
463-
| `left_joint_home_std` | Standard deviation for randomizing left arm home position |
464-
| `right_joint_home_std` | Standard deviation for randomizing right arm home position |
465-
| `left_gripper_home` | Default gripper joint value for left gripper (Isaac) |
466-
| `right_gripper_home` | Default gripper joint value for right gripper (Isaac) |
467-
| `lift_home` | Default lift joint position (meters) |
438+
- **target_class** (<span class="param-type">str</span>): Python class for robot wrapper (e.g., `Lift2`, `FR3`).
439+
- **path** (<span class="param-type">str</span>): USD file path relative to asset root.
440+
- **robot_file** (<span class="param-type">list</span>): CuRobo kinematics config file(s) - one per arm.
441+
- **gripper_max_width** (<span class="param-type">float</span>): Maximum gripper opening width (meters).
442+
- **gripper_min_width** (<span class="param-type">float</span>): Minimum gripper closing width (meters).
443+
- **solver_position_iteration_count** (<span class="param-type">int</span>): Physics solver position iterations.
444+
- **solver_velocity_iteration_count** (<span class="param-type">int</span>): Physics solver velocity iterations.
445+
- **stabilization_threshold** (<span class="param-type">float</span>): Physics stabilization threshold.
446+
- **left_joint_indices** (<span class="param-type">list</span>): Joint indices for left arm in articulation.
447+
- **right_joint_indices** (<span class="param-type">list</span>): Joint indices for right arm in articulation.
448+
- **left_gripper_indices** (<span class="param-type">list</span>): Gripper joint index for left arm.
449+
- **right_gripper_indices** (<span class="param-type">list</span>): Gripper joint index for right arm.
450+
- **lift_indices** (<span class="param-type">list</span>): Lift joint indices (for robots with lift mechanism).
451+
- **fl_base_path** (<span class="param-type">str</span>): Left arm base prim path.
452+
- **fr_base_path** (<span class="param-type">str</span>): Right arm base prim path.
453+
- **fl_filter_paths** (<span class="param-type">list</span>): Collision filter prims' paths for left arm.
454+
- **fr_filter_paths** (<span class="param-type">list</span>): Collision filter prims' paths for right arm.
455+
- **fl_forbid_collision_paths** (<span class="param-type">list</span>): Forbidden collision prims' paths for left arm.
456+
- **fr_forbid_collision_paths** (<span class="param-type">list</span>): Forbidden collision prims' paths for right arm.
457+
- **left_joint_home** (<span class="param-type">list</span>): Default joint positions for left arm (radians).
458+
- **right_joint_home** (<span class="param-type">list</span>): Default joint positions for right arm (radians).
459+
- **left_joint_home_std** (<span class="param-type">list</span>): Standard deviation for randomizing left arm home position.
460+
- **right_joint_home_std** (<span class="param-type">list</span>): Standard deviation for randomizing right arm home position.
461+
- **left_gripper_home** (<span class="param-type">list</span>): Default gripper joint value for left gripper (Isaac).
462+
- **right_gripper_home** (<span class="param-type">list</span>): Default gripper joint value for right gripper (Isaac).
463+
- **lift_home** (<span class="param-type">list</span>): Default lift joint position (meters).
468464

469465

470466
## Robot Wrappers

InterDataEngine-docs/concepts/skills/articulation.md

Lines changed: 14 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -12,16 +12,16 @@ Articulation skills operate objects with joints, such as doors, drawers, microwa
1212
```text
1313
workflows/simbox/core/skills/
1414
├── artpreplan.py # Pre-plan for long-horizon tasks
15-
├── open.py # Open articulated objects
16-
├── close.py # Close articulated objects
15+
├── open.py # Open or pull articulated objects
16+
├── close.py # Close or push articulated objects
1717
└── rotate.py # Rotate knobs / handles
1818
```
1919

2020
| Skill | Description | Use Cases |
2121
|-------|-------------|-----------|
2222
| `artpreplan` | Pre-plan / fake-plan for long-horizon tasks | Search for reasonable layouts before actual execution |
23-
| `open` | Open articulated objects | Microwave doors, cabinet doors, laptop screens, drawers |
24-
| `close` | Close articulated objects | Push microwaves closed, fold laptops, push drawers |
23+
| `open` | Open or pull articulated objects | Microwave doors, cabinet doors, laptop screens, drawers |
24+
| `close` | Close or push articulated objects | Push microwaves closed, fold laptops, push drawers |
2525
| `rotate` | Rotate knobs or handles | Twist oven knobs, turn handles |
2626

2727
### Skill Roles
@@ -283,11 +283,9 @@ Before defining constraints, keypoints must be annotated on both the robot gripp
283283

284284
Defined in robot YAML under `fl_gripper_keypoints` / `fr_gripper_keypoints` (see [Robots](/concepts/robots/)):
285285

286-
| Keypoint | Description |
287-
|----------|-------------|
288-
| `tool_head` | TCP position (fingertip center) |
289-
| `tool_tail` | Gripper base position |
290-
| `tool_side` | Side fingertip position |
286+
- **tool_head** (<span class="param-type">list</span>): TCP position (fingertip center).
287+
- **tool_tail** (<span class="param-type">list</span>): Gripper base position.
288+
- **tool_side** (<span class="param-type">list</span>): Side fingertip position.
291289

292290
![Gripper Keypoints](/gripper_kps.jpg)
293291

@@ -397,15 +395,13 @@ This is used when the target axis is already known (e.g., the pulling direction
397395

398396
## Configuration Reference
399397

400-
| Parameter | Type | Default | Description |
401-
|-----------|------|---------|-------------|
402-
| `objects` | `list` | required | `[articulated_object_name]` |
403-
| `obj_info_path` | `string` | `None` | Path to articulation info YAML |
404-
| `planner_setting.contact_pose_index` | `int` | required | Keyframe index where gripper contacts object |
405-
| `planner_setting.success_threshold` | `float` | required | Joint displacement threshold for success |
406-
| `planner_setting.update_art_joint` | `bool` | `False` | Update articulation joint targets on success |
407-
| `planner_setting.constraint_list` | `list` | required | List of constraint definitions |
408-
| `ignore_substring` | `list` | `[]` | Collision filter substrings |
398+
- **objects** (<span class="param-type">list</span>, default: required): `[articulated_object_name]`.
399+
- **obj_info_path** (<span class="param-type">string</span>, default: `None`): Path to articulation info YAML.
400+
- **planner_setting.contact_pose_index** (<span class="param-type">int</span>, default: required): Keyframe index where gripper contacts object.
401+
- **planner_setting.success_threshold** (<span class="param-type">float</span>, default: required): Joint displacement threshold for success.
402+
- **planner_setting.update_art_joint** (<span class="param-type">bool</span>, default: `False`): Update articulation joint targets on success.
403+
- **planner_setting.constraint_list** (<span class="param-type">list</span>, default: required): List of constraint definitions.
404+
- **ignore_substring** (<span class="param-type">list</span>, default: `[]`): Collision filter substrings.
409405

410406

411407
## References

InterDataEngine-docs/concepts/skills/overview.md

Lines changed: 9 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -19,21 +19,21 @@ workflows/simbox/core/skills/
1919
├── Pick-and-Place Skills
2020
│ ├── pick.py # Standard pick operation
2121
│ ├── place.py # Standard place operation
22-
│ ├── dexpick.py # Dex-style pick with approach
22+
│ ├── dexpick.py # Dex-style pick with constraints
2323
│ ├── dexplace.py # Dex-style place with constraints
2424
│ ├── manualpick.py # Manual grasp pose specification
2525
│ ├── dynamicpick.py # Dynamic grasp selection
2626
│ └── failpick.py # Failure case pick
2727
2828
├── Articulation-Related Skills
29-
│ ├── open.py # Open gripper/articulation
30-
│ ├── close.py # Close gripper/articulation
29+
│ ├── open.py # Open or pull articulation
30+
│ ├── close.py # Close or push articulation
3131
│ ├── rotate.py # Rotate articulation joint
3232
│ └── artpreplan.py # Articulation pre-planning
3333
3434
├── Heuristic Skills
3535
│ ├── goto_pose.py # Move to target pose
36-
│ ├── gripper_action.py # Generic gripper action
36+
│ ├── gripper_action.py # Generic gripper action (Open, Close)
3737
│ ├── heuristic_skill.py # Configurable heuristic actions
3838
│ ├── joint_ctrl.py # Joint-level control
3939
│ └── wait.py # Wait for duration
@@ -44,7 +44,7 @@ workflows/simbox/core/skills/
4444
├── approach_rotate.py # Approach with rotation
4545
├── flip.py # Flip object
4646
├── scan.py # Scan motion
47-
└── pour_water_succ.py # Pouring action
47+
└── pour_water_succ.py # Pouring metric
4848
```
4949

5050
## Skill Template
@@ -105,12 +105,10 @@ manip_list = [
105105

106106
**Command tuple structure:**
107107

108-
| Component | Type | Description |
109-
|-----------|------|-------------|
110-
| `p_base_ee_tgt` | `np.ndarray (3,)` | Target end-effector position in arm base frame |
111-
| `q_base_ee_tgt` | `np.ndarray (4,)` | Target end-effector quaternion `(w, x, y, z)` |
112-
| `function_name` | `str` | Action function to execute |
113-
| `params` | `dict` | Parameters for the action function |
108+
- **p_base_ee_tgt** (<span class="param-type">np.ndarray</span>): Target end-effector position in arm base frame, shape `(3,)`.
109+
- **q_base_ee_tgt** (<span class="param-type">np.ndarray</span>): Target end-effector quaternion `(w, x, y, z)` in arm base frame, shape `(4,)`.
110+
- **function_name** (<span class="param-type">str</span>): Action function to execute.
111+
- **params** (<span class="param-type">dict</span>): Parameters for the action function.
114112

115113
**Common action functions:**
116114

0 commit comments

Comments
 (0)