Skip to content

examples(teleop): package under isaacteleop_examples - #1047

Open
jiwenc-nv wants to merge 1 commit into
jiwenc-nv/examples-oxrfrom
jiwenc-nv/examples-teleop
Open

examples(teleop): package under isaacteleop_examples#1047
jiwenc-nv wants to merge 1 commit into
jiwenc-nv/examples-oxrfrom
jiwenc-nv/examples-teleop

Conversation

@jiwenc-nv

@jiwenc-nv jiwenc-nv commented Aug 28, 2026

Copy link
Copy Markdown
Collaborator

Description

Part of #985. Stacked on #1046.

No flat sibling imports — the eleven examples are independent — but the tree kept its pyproject.toml under python/, so it needed the same conversion for one install command to work across every example.

uv pip install -e ./examples/teleop
python -m isaacteleop_examples.teleop.gripper_retargeting_example_simple

Two things the move forces, both silent if missed:

  • config/ moves inside the package. dex_bimanual_example and full_bimanual_reordering_example resolve it from __file__, so the dex-retargeting YAML has to travel with the modules; the wheel now carries all five files.
  • Six scripts walked up four parents to reach the tree root — the install prefix for PLUGIN_ROOT_DIR, the checkout for the so101_leader build path. Three levels deeper that lands on the example's own python/ directory, so they are parents[5] now. The install tree keeps the same shape, so one depth serves both.

This example has the widest reference footprint of the series: five docs pages, src/plugins/so101_leader/README.md, and a docstring in joint_state_retargeter.py. Runnable commands became -m; prose paths that gained nothing from the full nesting were shortened to examples/teleop.

Type of change

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)
  • Documentation update

Testing

x86_64 / Ubuntu, Python 3.12. Wheel ships 11 modules and all 5 config/ files under isaacteleop_examples/teleop/, with no namespace __init__.py. parents[5] verified to land on the repo root. pre-commit clean.

Not covered: every example here needs a headset, and several need the so101_leader or synthetic-hands plugin. The parents[5] change is the part worth checking on a real run — a wrong depth shows up as a plugin that cannot be found, not as an import error.

Checklist

  • I have read and understood the contribution guidelines
  • I have run the linter and formatter with SKIP=check-copyright-year pre-commit run --all-files
  • I have made corresponding changes to the documentation
  • I have added tests that prove my fix/feature works (or explained why not)
  • I have signed off all my commits (git commit -s) per the DCO

No tests: this is a move with no import changes.

@coderabbitai

coderabbitai Bot commented Aug 28, 2026

Copy link
Copy Markdown
Contributor

Important

Review skipped

Auto reviews are disabled on base/target branches other than the default branch.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Enterprise

Run ID: 698b4800-9316-493f-89ea-9fd523657acd

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

  • 🔍 Trigger review

Comment @coderabbitai help to get the list of available commands.

@jiwenc-nv
jiwenc-nv force-pushed the jiwenc-nv/examples-teleop branch from c5248c8 to e9d92d0 Compare August 28, 2026 05:01
@jiwenc-nv
jiwenc-nv changed the base branch from jiwenc-nv/examples-deviceio-live-view to jiwenc-nv/examples-oxr August 28, 2026 05:02
@jiwenc-nv
jiwenc-nv requested a review from ivany-nv August 28, 2026 05:11
@jiwenc-nv
jiwenc-nv force-pushed the jiwenc-nv/examples-teleop branch from e9d92d0 to 554a238 Compare August 28, 2026 05:23
@jiwenc-nv
jiwenc-nv force-pushed the jiwenc-nv/examples-teleop branch from 554a238 to 5e763e5 Compare August 28, 2026 05:33
@jiwenc-nv
jiwenc-nv force-pushed the jiwenc-nv/examples-teleop branch from 5e763e5 to 862dd38 Compare August 28, 2026 05:45
@jiwenc-nv
jiwenc-nv force-pushed the jiwenc-nv/examples-teleop branch from 862dd38 to 7f4f71d Compare August 28, 2026 05:49
@jiwenc-nv
jiwenc-nv force-pushed the jiwenc-nv/examples-teleop branch from 7f4f71d to 17195ad Compare August 28, 2026 14:47
No flat sibling imports -- the eleven examples are independent -- but the tree
kept its pyproject under python/, so it needed the same conversion for one
install command to work everywhere.

config/ moves inside the package: dex_bimanual_example and
full_bimanual_reordering_example resolve it from __file__, so the dex
retargeting YAML has to travel with the modules.

Six scripts walked up four parents to reach the tree root -- the install prefix
for PLUGIN_ROOT_DIR, the checkout for the so101_leader build path. Three levels
deeper that lands on the example's python/ directory, so they are parents[5]
now. The install tree keeps the same shape, so one depth serves both.

Part of #985.

Signed-off-by: Jiwen Cai <jiwenc@nvidia.com>
@jiwenc-nv
jiwenc-nv force-pushed the jiwenc-nv/examples-teleop branch from 17195ad to 6b41763 Compare August 28, 2026 16:11
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant