Skip to content

Conversation

@huihuaNvidia2023
Copy link
Contributor

Description

Add a short description about the locomotion policy used in the loco-manipulation teleop demo. Added a link to the AGILE training framework since it is released.

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

@huihuaNvidia2023 huihuaNvidia2023 self-assigned this Nov 20, 2025
@github-actions github-actions bot added the documentation Improvements or additions to documentation label Nov 20, 2025
@huihuaNvidia2023 huihuaNvidia2023 force-pushed the hhz/update_mimic_readme_to_link_agile branch from 9207a88 to 74aaad0 Compare November 20, 2025 19:20
@greptile-apps
Copy link
Contributor

greptile-apps bot commented Nov 20, 2025

Greptile Overview

Greptile Summary

Added informational note about the AGILE locomotion policy training framework to the humanoid locomanipulation demo documentation. The note provides context about where the locomotion policy comes from and links to the official AGILE GitHub repository for users who want to train their own policies.

  • Added RST note directive with proper formatting after the Demo 2 introduction
  • Included valid external link to the AGILE framework repository
  • Explained that AGILE is an officially supported training pipeline for humanoid control
  • Documented that pre-trained policies are available and verified for real-world deployment

Confidence Score: 5/5

  • This PR is safe to merge with minimal risk
  • Documentation-only change with correct RST syntax, valid external link, and helpful contextual information. No code changes, no breaking changes, and the addition improves user understanding of the demo's locomotion component.
  • No files require special attention

Important Files Changed

File Analysis

Filename Score Overview
docs/source/overview/imitation-learning/teleop_imitation.rst 5/5 Added informational note about AGILE locomotion policy training framework with valid external link

Sequence Diagram

sequenceDiagram
    participant Author
    participant Docs as Documentation File
    participant Reader as Documentation Reader
    
    Author->>Docs: Add note section about AGILE
    Note over Author,Docs: Inserts note after Demo 2 introduction
    Author->>Docs: Add AGILE framework link
    Author->>Docs: Explain locomotion policy training
    Note over Docs: RST note directive with<br/>formatted content
    Reader->>Docs: Read Demo 2 documentation
    Docs->>Reader: Display locomanipulation demo info
    Docs->>Reader: Show AGILE training note
    Reader->>Reader: Click AGILE GitHub link if needed
Loading

Copy link
Contributor

@greptile-apps greptile-apps bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

1 file reviewed, no comments

Edit Code Review Agent Settings | Greptile

Copy link
Contributor

@yanchangNvidia yanchangNvidia left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks great. Added a few comments.

.. note::
**Locomotion policy training**

The locomotion policy used in this demo was trained using the `AGILE <https://github.com/nvidia-isaac/WBC-AGILE>`__ framework.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

How about replacing "demo" with this "integration example"?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

How about also adding information about the flexibility / advantage with separate lower body and upper body architecture?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done

AGILE is an officially supported humanoid control training pipeline that will also be seamlessly integrated with other evaluation
and deployment tools across Isaac products. This allows teams to rely on a single, maintained stack covering all necessary infrastructure
and tooling for policy training, with easy export to real-world deployment. The AGILE repository contains updated pre-trained policies
that have been verified in the real world and can be directly deployed. Users can also train their own locomotion policies using the AGILE framework.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

How about also highlighting "manager based environment" with flexibility for easy customization?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done

@huihuaNvidia2023 huihuaNvidia2023 force-pushed the hhz/update_mimic_readme_to_link_agile branch from 74aaad0 to 4b7f1ac Compare November 20, 2025 20:36
@kellyguo11 kellyguo11 changed the title Update the mimic teleop doc to link to the locomotion policy training Updates the mimic teleop doc to link to the locomotion policy training Nov 26, 2025
@kellyguo11 kellyguo11 merged commit 18c7c58 into isaac-sim:main Nov 26, 2025
9 of 10 checks passed
kellyguo11 pushed a commit that referenced this pull request Nov 26, 2025
#4053)

# Description
Add a short description about the locomotion policy used in the
loco-manipulation teleop demo. Added a link to the AGILE training
framework since it is released.

<!-- As a practice, it is recommended to open an issue to have
discussions on the proposed pull request.
This makes it easier for the community to keep track of what is being
developed or added, and if a given feature
is demanded by more than one party. -->

## Type of change
- 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
-->
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