Skip to content

Commit 40ada0f

Browse files
authored
Adds note that Pink actions and envs are Linux only (#7542)
# Description Pink IK is a Linux only package. Add note in docs to indicate this. Fixes # (issue) Windows users may not have been aware that Pink actions and envs are Linux only. ## Type of change <!-- As you go through the list, delete the ones that are not applicable. --> - Bug fix (non-breaking change which fixes an issue) - Documentation update ## Release backport - [x] <!-- backport-active-release --> Backport this pull request to the active release branch after it merges into `develop` ## Checklist Docker and GPU tests run on demand. Push the commits you want tested, then comment `run-ci` on the pull request. - [x] I have read and understood the [contribution guidelines](https://isaac-sim.github.io/IsaacLab/main/source/refs/contributing.html) - [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 added a changelog fragment under `source/<pkg>/changelog.d/` for every touched package (do **not** edit `CHANGELOG.rst` or bump `extension.toml` — CI handles that) - [x] 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 -->
1 parent 94c24c0 commit 40ada0f

2 files changed

Lines changed: 8 additions & 0 deletions

File tree

docs/source/api/lab/isaaclab.envs.mdp.rst

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,11 @@ Observations
1212
Actions
1313
-------
1414

15+
.. important::
16+
17+
``PinkInverseKinematicsAction`` is supported only on Linux. Tasks configured with this action cannot run on
18+
Windows because Pink IK and its dependencies are not available there.
19+
1520
.. automodule:: isaaclab.envs.mdp.actions
1621

1722
.. automodule:: isaaclab.envs.mdp.actions.actions_cfg

docs/source/overview/imitation-learning/humanoids_imitation.rst

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,9 @@ This page covers data generation and imitation learning workflows for humanoid r
1111

1212
.. important::
1313

14+
The Isaac Lab Mimic workflows and Pink IK tasks on this page are supported only on Linux.
15+
Pink IK and its dependencies are not available on Windows.
16+
1417
Complete the tutorial in :ref:`Synthetic Data Generation and Imitation Learning with Isaac Lab Mimic <teleoperation-imitation-learning>`
1518
before proceeding with the following demonstrations to
1619
understand the data collection, annotation, and generation steps of Isaac Lab Mimic.

0 commit comments

Comments
 (0)