Skip to content

Commit a51b1ba

Browse files
rwiltzkellyguo11
andauthored
Updates the teleop_se3 and record_demos scripts with more helpful description for teleop_device parameter (#3642)
# Description Updates the teleop_se3 and record_demos scripts with more helpful description for teleop_device parameter. This now mentions how the teleop device is defined per task in the env config, which devices are "built-in" to the scripts, and that not all tasks will support every teleop device. <!-- 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. --> Please include a summary of the change and which issue is fixed. Please also include relevant motivation and context. List any dependencies that are required for this change. Fixes # (issue) <!-- 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 <!-- 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 --> Co-authored-by: Kelly Guo <[email protected]>
1 parent 3de863a commit a51b1ba

File tree

2 files changed

+15
-2
lines changed

2 files changed

+15
-2
lines changed

scripts/environments/teleoperation/teleop_se3_agent.py

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,11 @@
1919
"--teleop_device",
2020
type=str,
2121
default="keyboard",
22-
help="Device for interacting with environment. Examples: keyboard, spacemouse, gamepad, handtracking, manusvive",
22+
help=(
23+
"Teleop device. Set here (legacy) or via the environment config. If using the environment config, pass the"
24+
" device key/name defined under 'teleop_devices' (it can be a custom name, not necessarily 'handtracking')."
25+
" Built-ins: keyboard, spacemouse, gamepad. Not all tasks support all built-ins."
26+
),
2327
)
2428
parser.add_argument("--task", type=str, default=None, help="Name of the task.")
2529
parser.add_argument("--sensitivity", type=float, default=1.0, help="Sensitivity factor.")

scripts/tools/record_demos.py

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,16 @@
3333
# add argparse arguments
3434
parser = argparse.ArgumentParser(description="Record demonstrations for Isaac Lab environments.")
3535
parser.add_argument("--task", type=str, required=True, help="Name of the task.")
36-
parser.add_argument("--teleop_device", type=str, default="keyboard", help="Device for interacting with environment.")
36+
parser.add_argument(
37+
"--teleop_device",
38+
type=str,
39+
default="keyboard",
40+
help=(
41+
"Teleop device. Set here (legacy) or via the environment config. If using the environment config, pass the"
42+
" device key/name defined under 'teleop_devices' (it can be a custom name, not necessarily 'handtracking')."
43+
" Built-ins: keyboard, spacemouse, gamepad. Not all tasks support all built-ins."
44+
),
45+
)
3746
parser.add_argument(
3847
"--dataset_file", type=str, default="./datasets/dataset.hdf5", help="File path to export recorded demos."
3948
)

0 commit comments

Comments
 (0)