Skip to content

[Release 3.0.0] Restore default camera image data type - #8373

Merged
kellyguo11 merged 1 commit into
isaac-sim:release/3.0.0from
kellyguo11:kellyg/fix-camera-normals-default-data-type
Oct 8, 2026
Merged

kellyguo11 merged 1 commit into
isaac-sim:release/3.0.0from
kellyguo11:kellyg/fix-camera-normals-default-data-type

Conversation

@kellyguo11

@kellyguo11 kellyguo11 commented Oct 7, 2026 •

Copy link
Copy Markdown
Contributor

Description

Restores the CameraImageBase fallback to a subclass's default_data_type when observation term parameters do not include data_type.

image_normals intentionally reads the fixed "normals" output and does not expose a public data_type argument. The strict parameter lookup introduced in #8127 therefore raises KeyError: 'data_type' when the observation manager constructs the term. Falling back in the base class keeps the existing image_normals API unchanged while preserving explicit data_type configuration for the other image terms.

Fixes NVBUG 6886551.

No new dependencies.

Type of change

  • Bug fix (non-breaking change which fixes an issue)

Release backport

Not applicable: this pull request targets release/3.0.0 directly.

Screenshots

Not applicable; this fixes an observation-term construction failure.

Validation

  • Confirmed the regression test fails before the fix with KeyError: 'data_type'.
  • Camera-image unit tests: 25 passed.
  • uv run isaaclab -f: all code and style hooks passed.
  • The changelog validator passed against the upstream/release/3.0.0 tip.

Checklist

  • I have read and understood the contribution guidelines
  • I have run the pre-commit checks with uv run isaaclab --format
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • I have validated the changed behavior with focused coverage and applied the test-audit criteria to the test change
  • I have added a changelog fragment under source/<pkg>/changelog.d/ for every touched package
  • I have added my name to the CONTRIBUTORS.md or my name already exists there

@kellyguo11
kellyguo11 requested a review from a team October 7, 2026 21:34
@github-actions github-actions Bot added bug Something isn't working isaac-lab Related to Isaac Lab team labels Oct 7, 2026
@greptile-apps

greptile-apps Bot commented Oct 7, 2026 •

Copy link
Copy Markdown
Contributor

RetriggerConfidence Score: 5/5

[Medium risk] Fixes camera observation term to use default data type.

This PR appears safe to merge; no actionable issues were found.

What we checked:

  • Normals construct without a type: The manager adds only defaults declared by the term's call. image_normals has no data_type argument, so the changed constructor uses its "normals" default.

Summary

Restores the subclass default when CameraImageBase receives no data_type.

  • Fixes construction of image_normals without changing its public arguments.
  • Keeps explicit data_type values and the existing acceptance check.
  • Adds a focused regression test and a changelog entry.

Reviews (1) · Last reviewed commit: "Restore default camera image data type" · Reviewed by Greptile

@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

All reviewed code categories look good.

  • PR description: The title and body match the three-file diff and reported validation; no measurable performance claim or material runtime-cost change requires benchmark evidence.
  • Design and architecture: Architecture looks good.
  • Scope and over-engineering: No over-engineering issues.
  • API: API changes look good.
  • Compatibility and deprecation: No breaking changes identified.
  • Implementation: Implementation looks good.
  • Style consistency: Style consistency looks good.
  • Test quality: Test quality looks good.

No blocking issues. No inline findings.

Automated review; human maintainers own approval decisions.

@kellyguo11

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 Oct 8, 2026
@kellyguo11
kellyguo11 merged commit 190bd70 into isaac-sim:release/3.0.0 Oct 8, 2026
58 checks passed
maxkra15 pushed a commit that referenced this pull request Oct 14, 2026
# Description

Adds the missing `data_type: str = "normals"` parameter to
`image_normals` and uses it to select the camera output. The new
parameter is keyword-only so the existing positional order for
`normalize`, `channel_first`, and `frame_stack` remains compatible.

Manager terms resolve callable defaults into `cfg.params` before
construction. Unlike the other per-modality image terms, `image_normals`
did not declare its data type in the callable signature, so the strict
`CameraImageBase` constructor raised `KeyError: 'data_type'`. This
change fixes the signature rather than adding a fallback to the base
class, keeping default resolution consistent with #8127.

Fixes NVBUG 6886551

No new dependencies.

## Type of change

- Bug fix (non-breaking change which fixes an issue)

## Release backport

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

The release-branch compatibility fix is already open as #8373, so an
automated duplicate backport is not requested.

## Screenshots

Not applicable; this fixes observation-term construction.

## Validation

- Confirmed the default-resolution regression test fails on the
unmodified `develop` branch with `KeyError: 'data_type'`.
- Confirmed the positional-compatibility regression test fails before
the follow-up fix with `KeyError: False` and passes once `data_type` is
keyword-only.
- Camera-image unit tests: 26 passed.
- `uv run isaaclab -f`: passed, including the changelog gate against
`upstream/develop`.
- `uv run --isolated --extra dev --extra ov -- make -C docs
current-docs`: passed without warnings.

## 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
`uv run isaaclab --format`
- [x] I have made corresponding changes to the documentation
- [x] My changes generate no new warnings
- [x] I have validated the changed behavior with focused coverage and
applied the [test-audit
criteria](https://github.com/isaac-sim/IsaacLab/blob/develop/skills/developer/test-audit/SKILL.md)
to the test change
- [x] I have added a changelog fragment under
`source/<pkg>/changelog.d/` for every touched package
- [x] I have added my name to the `CONTRIBUTORS.md` or my name already
exists there

---------

Co-authored-by: Antoine RICHARD <antoiner@nvidia.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

bug Something isn't working isaac-lab Related to Isaac Lab team

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant