-
Notifications
You must be signed in to change notification settings - Fork 2.7k
Updates the mimic teleop doc to link to the locomotion policy training #4053
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Updates the mimic teleop doc to link to the locomotion policy training #4053
Conversation
9207a88 to
74aaad0
Compare
Greptile OverviewGreptile SummaryAdded 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.
Confidence Score: 5/5
Important Files ChangedFile Analysis
Sequence DiagramsequenceDiagram
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
|
There was a problem hiding this 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
yanchangNvidia
left a comment
There was a problem hiding this 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. |
There was a problem hiding this comment.
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"?
There was a problem hiding this comment.
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?
There was a problem hiding this comment.
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. |
There was a problem hiding this comment.
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?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Done
74aaad0 to
4b7f1ac
Compare
#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 -->
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
Screenshots
Please attach before and after screenshots of the change if applicable.
Checklist
pre-commitchecks with./isaaclab.sh --formatconfig/extension.tomlfileCONTRIBUTORS.mdor my name already exists there