Skip to content

Commit 47ec518

Browse files
peterd-NVashwinvkNV
authored andcommitted
Adds warning in Mimic docs for TypeError (#341)
# Description <!-- Thank you for your interest in sending a pull request. Please make sure to check the contribution guidelines. Link: https://isaac-sim.github.io/IsaacLab/main/source/refs/contributing.html --> 1. Adds a warning that XR TypeError seen during Isaac Sim bootup can be ignored and will be fixed in the next released patch of Isaac Sim. 2. Clean up Mimic docs by changing "note" tabs to "tips" and "important" tabs where appropriate ## Type of change <!-- As you go through the list, delete the ones that are not applicable. --> - Documentation update ## Screenshots Please attach before and after screenshots of the change if applicable. <!-- Example: | Before | After | | ------ | ----- | | _gif/png before_ | _gif/png after_ | To upload images to a PR -- simply drag and drop an image while in edit mode and it should upload the image directly. You can then paste that source into the above before/after sections. --> ## Checklist - [x] I have run the [`pre-commit` checks](https://pre-commit.com/) with `./isaaclab.sh --format` - [x] I have made corresponding changes to the documentation - [x] My changes generate no new warnings - [ ] I have added tests that prove my fix is effective or that my feature works - [ ] I have updated the changelog and the corresponding version in the extension's `config/extension.toml` file - [ ] I have added my name to the `CONTRIBUTORS.md` or my name already exists there <!-- As you go through the checklist above, you can mark something as done by putting an x character in it For example, - [x] I have done this task - [ ] I have not done this task --> --------- Co-authored-by: Ashwin Varghese Kuruttukulam <[email protected]>
1 parent 5ecd53b commit 47ec518

File tree

1 file changed

+13
-5
lines changed

1 file changed

+13
-5
lines changed

docs/source/overview/teleop_imitation.rst

Lines changed: 13 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -115,7 +115,7 @@ To collect demonstrations with teleoperation for the environment ``Isaac-Stack-C
115115

116116
The order of the stacked cubes should be blue (bottom), red (middle), green (top).
117117

118-
.. note::
118+
.. tip::
119119

120120
When using the ``handtracking`` device, we suggest collecting demonstrations with the ``Isaac-Stack-Cube-Frank-IK-Abs-v0`` version of the task, which controls the end effector using the absolute position of the hand.
121121

@@ -152,7 +152,7 @@ Isaac Lab Mimic is a feature in Isaac Lab that allows generation of additional d
152152
In the following example, we will show how to use Isaac Lab Mimic to generate additional demonstrations that can be used to train either a state-based policy
153153
(using the ``Isaac-Stack-Cube-Franka-IK-Rel-Mimic-v0`` environment) or visuomotor policy (using the ``Isaac-Stack-Cube-Franka-IK-Rel-Visuomotor-Mimic-v0`` environment).
154154

155-
.. note::
155+
.. important::
156156

157157
All commands in the following sections must keep a consistent policy type. For example, if choosing to use a state-based policy, then all commands used should be from the "State-based policy" tab.
158158

@@ -328,7 +328,7 @@ Optional: Collect and annotate demonstrations
328328
an Apple Vision Pro, you may skip this step and continue on to the next step: `Generate the dataset`_.
329329
A pre-recorded annotated dataset is provided in the next step .
330330

331-
.. note::
331+
.. tip::
332332
The GR1 scene utilizes the wrist poses from the Apple Vision Pro (AVP) as setpoints for a differential IK controller (Pink-IK).
333333
The differential IK controller requires the user's wrist pose to be close to the robot's initial or current pose for optimal performance.
334334
Rapid movements of the user's wrist may cause it to deviate significantly from the goal state, which could prevent the IK controller from finding the optimal solution.
@@ -357,10 +357,18 @@ We recommend 10 successful demonstrations for good data generation results.
357357
--dataset_file ./datasets/dataset_gr1.hdf5 \
358358
--num_demos 10 --enable_pinocchio
359359
360-
.. note::
360+
.. tip::
361361
If a demo fails during data collection, the environment can be reset using the teleoperation controls panel in the XR teleop client
362362
on the Apple Vision Pro or via voice control by saying "reset". See :ref:`teleoperate-apple-vision-pro` for more details.
363363

364+
The robot uses simplified collision meshes for physics calculations that differ from the detailed visual meshes displayed in the simulation. Due to this difference, you may occasionally observe visual artifacts where parts of the robot appear to penetrate other objects or itself, even though proper collision handling is occurring in the physics simulation.
365+
366+
.. warning::
367+
When first starting the simulation window, you may encounter the following ``Gf.Matrix4d`` error:
368+
``TypeError: No registered converter was able to produce a C++ rvalue of type std::vector<double, std::allocator<double> > from this Python object of type tuple``.
369+
This error can be ignored and will not affect the data collection process.
370+
The error will be patched in a future release of Isaac Sim.
371+
364372
You can replay the collected demonstrations by running the following command:
365373

366374
.. code:: bash
@@ -402,7 +410,7 @@ move towards the target object. Annotate the demonstrations by running the follo
402410
Press "S" to annotate subtask signals.
403411
Press "Q" to skip the episode.
404412
405-
.. note::
413+
.. tip::
406414

407415
If the object does not get placed in the bin during annotation, you can press "N" to replay the episode and annotate again. Or you can press "Q" to skip the episode and annotate the next one.
408416

0 commit comments

Comments
 (0)