Skip to content

Updates dataset instruction in teleop_imitation.rst#3462

Merged
kellyguo11 merged 2 commits into
isaac-sim:mainfrom
peterd-NV:peterd/vdr_doc_updates
Sep 17, 2025
Merged

Updates dataset instruction in teleop_imitation.rst#3462
kellyguo11 merged 2 commits into
isaac-sim:mainfrom
peterd-NV:peterd/vdr_doc_updates

Conversation

@peterd-NV

Copy link
Copy Markdown
Collaborator

Description

Updates the Isaac Lab Mimic doc tutorials according to prior reviewer feedback.
Changes:

  1. Clarify demo success criteria for Demo 2 (humanoid pouring task)
  2. Add visualization at the start of Demo 2 to clearly indicate that it is a different task from Demo 1.
  3. Document the dataset of Demo 2

Type of change

  • Documentation update

Screenshots

Please attach before and after screenshots of the change if applicable.

Checklist

  • I have read and understood the contribution guidelines
  • I have run the pre-commit checks with ./isaaclab.sh --format
  • I have made corresponding changes to the documentation
  • 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

@github-actions github-actions Bot added the documentation Improvements or additions to documentation label Sep 15, 2025
@Mayankm96

Copy link
Copy Markdown
Contributor

Thank you for the doc fixes! Minor note: Would be great to keep the PR title a little bit more precise w.r.t. to the content of the MR. Too generic PR titles makes it hard to check when going through the Git history :)

@Mayankm96 Mayankm96 changed the title Update Isaac Lab Mimic docs Updates dataset instruction in teleop_imitation.rst Sep 16, 2025
@kellyguo11 kellyguo11 merged commit 137106d into isaac-sim:main Sep 17, 2025
7 of 10 checks passed
peterd-NV added a commit to peterd-NV/IsaacLab that referenced this pull request Sep 17, 2025
<!--
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

💡 Please try to keep PRs small and focused. Large PRs are harder to
review and merge.
-->

Updates the Isaac Lab Mimic doc tutorials according to prior reviewer
feedback.
Changes:

1. Clarify demo success criteria for Demo 2 (humanoid pouring task)
2. Add visualization at the start of Demo 2 to clearly indicate that it
is a different task from Demo 1.
3. Document the dataset of Demo 2

<!-- As you go through the list, delete the ones that are not
applicable. -->

- Documentation update

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.
-->

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

(cherry picked from commit 137106d)
kellyguo11 pushed a commit that referenced this pull request Sep 18, 2025
<!--
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

💡 Please try to keep PRs small and focused. Large PRs are harder to
review and merge.
-->

Updates the Isaac Lab Mimic doc tutorials according to prior reviewer
feedback.
Changes:

1. Clarify demo success criteria for Demo 2 (humanoid pouring task)
2. Add visualization at the start of Demo 2 to clearly indicate that it
is a different task from Demo 1.
3. Document the dataset of Demo 2

<!-- As you go through the list, delete the ones that are not
applicable. -->

- Documentation update

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.
-->

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

(cherry picked from commit 137106d)
ooctipus pushed a commit to ooctipus/IsaacLab that referenced this pull request Sep 20, 2025
# 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

💡 Please try to keep PRs small and focused. Large PRs are harder to
review and merge.
-->

Updates the Isaac Lab Mimic doc tutorials according to prior reviewer
feedback.
Changes:

1. Clarify demo success criteria for Demo 2 (humanoid pouring task)
2. Add visualization at the start of Demo 2 to clearly indicate that it
is a different task from Demo 1.
3. Document the dataset of Demo 2

## 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 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 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
-->
@peterd-NV peterd-NV deleted the peterd/vdr_doc_updates branch September 22, 2025 17:03
ooctipus pushed a commit to ooctipus/IsaacLab that referenced this pull request Sep 29, 2025
# 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

💡 Please try to keep PRs small and focused. Large PRs are harder to
review and merge.
-->

Updates the Isaac Lab Mimic doc tutorials according to prior reviewer
feedback.
Changes:

1. Clarify demo success criteria for Demo 2 (humanoid pouring task)
2. Add visualization at the start of Demo 2 to clearly indicate that it
is a different task from Demo 1.
3. Document the dataset of Demo 2

## 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 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 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
-->
george-nehma pushed a commit to george-nehma/DreamLander-IsaacLab that referenced this pull request Oct 24, 2025
# 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

💡 Please try to keep PRs small and focused. Large PRs are harder to
review and merge.
-->

Updates the Isaac Lab Mimic doc tutorials according to prior reviewer
feedback.
Changes:

1. Clarify demo success criteria for Demo 2 (humanoid pouring task)
2. Add visualization at the start of Demo 2 to clearly indicate that it
is a different task from Demo 1.
3. Document the dataset of Demo 2

## 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 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 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
-->
hougantc-nvda pushed a commit to hougantc-nvda/IsaacLab that referenced this pull request Nov 10, 2025
isaac-sim#3489)

<!--
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

💡 Please try to keep PRs small and focused. Large PRs are harder to
review and merge.
-->

Updates the Isaac Lab Mimic doc tutorials according to prior reviewer
feedback.
Changes:

1. Clarify demo success criteria for Demo 2 (humanoid pouring task)
2. Add visualization at the start of Demo 2 to clearly indicate that it
is a different task from Demo 1.
3. Document the dataset of Demo 2

<!-- As you go through the list, delete the ones that are not
applicable. -->

- Documentation update

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.
-->

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

(cherry picked from commit 137106d)
hougantc-nvda pushed a commit to hougantc-nvda/IsaacLab that referenced this pull request Nov 10, 2025
isaac-sim#3489)

<!--
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

💡 Please try to keep PRs small and focused. Large PRs are harder to
review and merge.
-->

Updates the Isaac Lab Mimic doc tutorials according to prior reviewer
feedback.
Changes:

1. Clarify demo success criteria for Demo 2 (humanoid pouring task)
2. Add visualization at the start of Demo 2 to clearly indicate that it
is a different task from Demo 1.
3. Document the dataset of Demo 2

<!-- As you go through the list, delete the ones that are not
applicable. -->

- Documentation update

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.
-->

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

(cherry picked from commit 137106d)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants