Skip to content

Remove unsupported Franka Reorient task - #8168

Merged
kellyguo11 merged 5 commits into
isaac-sim:developfrom
maxkra15:maximiliank/franka-remove-reorient
Sep 30, 2026
Merged

kellyguo11 merged 5 commits into
isaac-sim:developfrom
maxkra15:maximiliank/franka-remove-reorient

Conversation

@maxkra15

@maxkra15 maxkra15 commented Sep 29, 2026 •

Copy link
Copy Markdown
Contributor

Description

Remove the unsupported Isaac-Reorient-Franka task registration, configuration, example, and browser entry. This is the requested breaking removal; downstream users who still need it must keep a local copy or migrate to a maintained reorientation task.

This is part 1 of the split of #7829 and is independently reviewable.

Validation

  • test_lift_env_cfg.py: 12 passed
  • uv run --frozen isaaclab -f: passed
  • Generated environment browser and changelog checks: passed

Release backport

  • Backport this pull request to the active release branch after it merges into develop

@maxkra15

Copy link
Copy Markdown
Contributor Author

run-ci

@isaaclab-bot isaaclab-bot Bot added ci:run-docker Trigger the on-demand Docker and GPU CI workflow and removed ci:run-docker Trigger the on-demand Docker and GPU CI workflow labels Sep 29, 2026

@isaaclab-review-bot isaaclab-review-bot Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Isaac Lab Review Bot

The removal is internally consistent across registration, configuration, examples, browser data, changelog, and tests, but it deletes two established public entry points without the required deprecation bridge.

  • Design and architecture: The registration, config class, example list, browser row, image mapping, and associated test parametrization are removed coherently. The remaining Franka lift configuration structure is unchanged, with no supplied reference still depending on the deleted class internally.
  • API: The changed public surface includes the registered Gym ID Isaac-Reorient-Franka and the importable FrankaReorientEnvCfg config class, including its play_mode() behavior. Both are removed immediately, while the Isaac-Lift-Franka registration and FrankaLiftEnvCfg entry points remain unchanged.
  • Compatibility and deprecation: Breaking changes: the Isaac-Reorient-Franka Gym ID is removed, breaking gym.make and registry-based config loading, and FrankaReorientEnvCfg is deleted, breaking direct imports and subclasses. Neither old contract remains functional or emits a targeted deprecation warning. The .major changelog fragment provides migration guidance but does not satisfy the required deprecation transition.
  • Implementation: The producer and integration paths were traced through the Franka registration module, config module, heterogeneous-scene example, and generated environment-browser data. The deletion is mechanically complete in the supplied patch; the required correction is to retain functional compatibility shims for the task ID and config class during the deprecation window.
  • Style consistency: Module and class docstrings were updated consistently to describe only the remaining lift task. The changelog uses the package fragment structure, and the added test import follows the existing import grouping. No separate style defect was identified.
  • Test quality: Only source/isaaclab_tasks/test/core/test_lift_env_cfg.py changed. It removes the deleted config from the collision-mesh parametrization and adds a registry-level assertion that the task ID is absent. These edits reflect the proposed immediate removal, but transition coverage will be needed once the required functional deprecation bridge and warning are added.

Significant concerns. Posted 1 actionable finding inline.

Automated review; human maintainers own approval decisions.

# Register Gym environments.
##

gym.register(

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

🟡 Warning · Compatibility — Public task and config removed without deprecation

Isaac-Reorient-Franka and FrankaReorientEnvCfg are public entry points: a registered gym ID listed in the environment browser and referenced by examples/heterogeneous_scene.py, and an importable configclass. Both vanish in one step, so existing gym.make, config-loading, and import callers fail with no transition. The contribution guide requires a deprecation and migration path for public removals; a .major changelog fragment is not one. Keep both functional with the established deprecation warning for the prescribed window.

@greptile-apps

greptile-apps Bot commented Sep 29, 2026 •

Copy link
Copy Markdown
Contributor

RetriggerConfidence Score: 5/5

[Medium risk] Removes an unsupported robot task from the codebase.

The PR appears safe to merge as an intentional breaking removal.

Summary

Removes the unsupported Franka reorientation task registration and configuration, along with its example and browser entries. Updates the changelog and tests to reflect the intentional breaking removal.

Reviews (1) · Last reviewed commit: "Refresh Franka benchmark browser preset"

Comment thread source/isaaclab_tasks/test/core/test_lift_env_cfg.py Outdated
@maxkra15

Copy link
Copy Markdown
Contributor Author

run-ci

@isaaclab-bot isaaclab-bot Bot added ci:run-docker Trigger the on-demand Docker and GPU CI workflow and removed ci:run-docker Trigger the on-demand Docker and GPU CI workflow labels Sep 29, 2026
@kellyguo11
kellyguo11 merged commit a1b7e56 into isaac-sim:develop Sep 30, 2026
54 of 55 checks passed
isaaclab-bot Bot pushed a commit that referenced this pull request Sep 30, 2026
## Description

Remove the unsupported `Isaac-Reorient-Franka` task registration,
configuration, example, and browser entry. This is the requested
breaking removal; downstream users who still need it must keep a local
copy or migrate to a maintained reorientation task.

This is part 1 of the split of #7829 and is independently reviewable.

## Validation

- `test_lift_env_cfg.py`: 12 passed
- `uv run --frozen isaaclab -f`: passed
- Generated environment browser and changelog checks: passed

## Release backport

- [x] <!-- backport-active-release --> Backport this pull request to the
active release branch after it merges into `develop`

(cherry picked from commit a1b7e56)
@isaaclab-bot

isaaclab-bot Bot commented Sep 30, 2026

Copy link
Copy Markdown
Contributor

Backported to release/3.0.0 as 60e28c1.

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 isaac-lab Related to Isaac Lab team

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants