Unverified Commit 5fd22637 authored by Kelly Guo's avatar Kelly Guo Committed by GitHub

Updates docs for segmentation and 50 series GPUs issues (#1943)

# Description

This is a documentation only change that adds instructions for updating
pytorch to the nightly build when running with 50 series GPUs to avoid
CUDA issues. In addition, we added the v2.0.1 release notes and an extra
note for the v2.0.0 release for a breaking change in the semantic and
instance segmentation outputs when using tiled cameras.

Fixes #1888

## Type of change

- This change requires a documentation update

## 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
- [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
-->

---------
Signed-off-by: 's avatarKelly Guo <kellyg@nvidia.com>
parent 5235c278
......@@ -4,6 +4,40 @@ Release Notes
The release notes are now available in the `Isaac Lab GitHub repository <https://github.com/isaac-sim/IsaacLab/releases>`_.
We summarize the release notes here for convenience.
v2.0.1
======
Overview
--------
This release contains a small set of fixes and improvements.
The main change was to maintain combability with the updated library name for RSL RL, which breaks the previous installation methods for Isaac Lab. This release provides the necessary fixes and updates in Isaac Lab to accommodate for the name change and maintain combability with installation for RSL RL.
**Full Changelog**: https://github.com/isaac-sim/IsaacLab/compare/v2.0.0...v2.0.1
Improvements
------------
* Switches to RSL-RL install from PyPI by @Mayankm96 in https://github.com/isaac-sim/IsaacLab/pull/1811
* Updates the script path in the document by @fan-ziqi in https://github.com/isaac-sim/IsaacLab/pull/1766
* Disables extension auto-reload when saving files by @kellyguo11 in https://github.com/isaac-sim/IsaacLab/pull/1788
* Updates documentation for v2.0.1 installation by @kellyguo11 in https://github.com/isaac-sim/IsaacLab/pull/1818
Bug Fixes
---------
* Fixes timestamp of com and link buffers when writing articulation pose to sim by @Jackkert in https://github.com/isaac-sim/IsaacLab/pull/1765
* Fixes incorrect local documentation preview path in xdg-open command by @louislelay in https://github.com/isaac-sim/IsaacLab/pull/1776
* Fixes no matching distribution found for rsl-rl (unavailable) by @samibouziri in https://github.com/isaac-sim/IsaacLab/pull/1808
* Fixes reset of sensor drift inside the RayCaster sensor by @zoctipus in https://github.com/isaac-sim/IsaacLab/pull/1821
New Contributors
----------------
* @Jackkert made their first contribution in https://github.com/isaac-sim/IsaacLab/pull/1765
v2.0.0
======
......@@ -81,6 +115,13 @@ Breaking Changes
* Restructures extension folders and removes old imitation learning scripts by @kellyguo11
* Renames default conda and venv Python environment from ``isaaclab`` to ``env_isaaclab`` by @Toni-SM
.. attention::
We have identified a breaking feature for semantic segmentation and instance segmentation when using
``TiledCamera`` with instanceable assets. Since the Isaac Sim 4.5 / Isaac Lab 2.0 release, semantic and instance
segmentation outputs only render the first tile correctly and produces blank outputs for the remaining tiles.
We will be introducing a workaround for this fix to remove scene instancing if semantic segmentation or instance
segmentation is required for ``TiledCamera`` until we receive a proper fix from Omniverse as part of the next Isaac Sim release.
Migration Guide
---------------
......
......@@ -381,6 +381,27 @@ Installation
The valid options are ``rl_games``, ``rsl_rl``, ``sb3``, ``skrl``, ``robomimic``, ``none``.
.. attention::
For 50 series GPUs, please use the latest PyTorch nightly build instead of PyTorch 2.5.1, which comes with Isaac Sim:
.. tab-set::
:sync-group: os
.. tab-item:: :icon:`fa-brands fa-linux` Linux
:sync: linux
.. code:: bash
./isaaclab.sh -p -m pip install --upgrade --pre torch --index-url https://download.pytorch.org/whl/nightly/cu128
.. tab-item:: :icon:`fa-brands fa-windows` Windows
:sync: windows
.. code:: batch
isaaclab.bat -p -m pip install --upgrade --pre torch --index-url https://download.pytorch.org/whl/nightly/cu128
Verifying the Isaac Lab installation
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
......
......@@ -94,6 +94,15 @@ To learn about how to set up your own extension project on top of Isaac Lab, vis
pip install isaaclab[isaacsim,all]==2.0.1 --extra-index-url https://pypi.nvidia.com
.. attention::
For 50 series GPUs, please use the latest PyTorch nightly build instead of PyTorch 2.5.1, which comes with Isaac Sim:
.. code:: bash
pip install --upgrade --pre torch --index-url https://download.pytorch.org/whl/nightly/cu128
Verifying the Isaac Sim installation
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
......
......@@ -298,6 +298,14 @@ Installation
The valid options are ``rl_games``, ``rsl_rl``, ``sb3``, ``skrl``, ``robomimic``, ``none``.
.. attention::
For 50 series GPUs, please use the latest PyTorch nightly build instead of PyTorch 2.5.1, which comes with Isaac Sim:
.. code:: bash
pip install --upgrade --pre torch --index-url https://download.pytorch.org/whl/nightly/cu128
Verifying the Isaac Lab installation
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
......
......@@ -207,4 +207,4 @@ following commands:
./isaaclab.sh -p scripts/tutorials/04_sensors/run_ray_caster_camera.py
# USD Camera
./isaaclab.sh -p scripts/tutorials/04_sensors/run_usd_camera.py
./isaaclab.sh -p scripts/tutorials/04_sensors/run_usd_camera.py --enable_cameras
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment