Skip to content

Fix streaming_gt_types docstring and polish visualization docs hero videos - #7588

Open
matthewtrepte wants to merge 3 commits into
isaac-sim:developfrom
matthewtrepte:mtrepte/fix-viz-docs-review-feedback
Open

Fix streaming_gt_types docstring and polish visualization docs hero videos#7588
matthewtrepte wants to merge 3 commits into
isaac-sim:developfrom
matthewtrepte:mtrepte/fix-viz-docs-review-feedback

Conversation

@matthewtrepte

Copy link
Copy Markdown
Contributor

Summary

  • Closes the last outstanding review feedback from Update Visualization Docs #7054 (Update Visualization Docs): the streaming_gt_types docstring in VisualizerCfg was missing the already-supported "normals" value, and used British spelling (initialisation) in two places. Both fixed, matching SUPPORTED_GT_TYPES and the docs page which already advertised normals support.
  • Polishes the visualization.rst hero video presentation:
    • Crops more off the top/bottom of the 2x2 hero tile grid (Viser/Newton RTX/Rerun/Kit), with an extra top-only crop on the top row (Viser/Newton RTX)
    • Crops more off the top of the standalone Newton GL hero clip
    • Restacks the Streaming Camera View's two videos vertically (previously side-by-side), centered at 65% width with natural aspect ratio, captions beneath each

Test plan

  • uv run isaaclab -f (ruff, ruff format, rst checks, changelog fragment check) — all passed
  • uv run python tools/changelog/cli.py check develop — passed
  • Verified against develop TOT: SUPPORTED_GT_TYPES includes "normals", the docs page advertises normals support, and the feature-support table correctly separates markers/live plots and shows RTX video support without contradicting Rerun/Viser's lack of --video support
  • Built the docs locally (uv run --extra test make current-docs in docs/) and visually inspected the rendered visualization.html for the CSS changes

…edback

Documents the already-supported 'normals' streaming GT type and switches to
American spelling (initialisation -> initialization) in two VisualizerCfg
docstrings, closing the last outstanding items from review on isaac-sim#7054's
visualization docs restructure.

Also reworks the visualization.rst hero video CSS: crops more off the top
and bottom of the 2x2 hero tile grid, adds an extra top-only crop for the
top row (Viser/Newton RTX), crops more off the top of the standalone Newton
GL hero clip, and restacks the Streaming Camera View videos vertically,
centered at 65% width with natural aspect ratio.
@matthewtrepte
matthewtrepte requested a review from a team September 4, 2026 22:24
@github-actions github-actions Bot added bug Something isn't working documentation Improvements or additions to documentation isaac-lab Related to Isaac Lab team labels Sep 4, 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 patch aligns the VisualizerCfg.streaming_gt_types documentation with existing "normals" support, standardizes spelling, adds the appropriate package changelog fragment, and updates the visualization page’s video presentation without changing runtime behavior.

  • Design and architecture: The presentation changes remain scoped to the page-local CSS and markup. The new .viz-stack-centered layout replaces the prior streaming-video grid consumer, while .viz-hero-row-top adds a targeted override without altering unrelated hero rows.
  • API: The public field name, type, default, validation path, and accepted runtime values are unchanged. The docstring now accurately reflects SUPPORTED_GT_TYPES, and the changelog fragment records the user-visible documentation correction without requiring migration guidance.
  • Implementation: The hero-tile dimensions and offsets are internally consistent with the documented crop calculations. The former .viz-grid-natural streaming-video consumer is updated alongside removal of its rules, and the replacement preserves centered videos with natural aspect ratios and captions.

No blocking issues. No inline issue met the actionable-evidence threshold; the assessment above records the review feedback.

Automated review; human maintainers own approval decisions.

@greptile-apps

greptile-apps Bot commented Sep 4, 2026

Copy link
Copy Markdown
Contributor

Greptile Summary

This PR corrects VisualizerCfg documentation to include the already-supported "normals" streaming ground-truth type, standardizes spelling, adds a changelog fragment, and adjusts visualization-document video cropping and layout.

  • Documents "normals" consistently with runtime support.
  • Refines hero-video cropping for the Newton and visualization-backend examples.
  • Restacks streaming-camera videos vertically at a centered width.
  • Leaves one contradictory CSS comment about whether all hero-grid rows have equal heights.

Confidence Score: 4/5

The PR appears safe to merge, with only a non-blocking contradictory CSS maintenance comment to clarify.

The runtime documentation matches the supported ground-truth types, and the new layout selectors correctly target the intended markup; the sole concern is an inaccurate explanatory comment that could confuse later maintenance.

Files Needing Attention: docs/source/concepts/visualization.rst

Important Files Changed

Filename Overview
docs/source/concepts/visualization.rst Updates hero-video cropping and streaming-video layout correctly, but the revised height comment contradicts the new top-row override.
source/isaaclab/isaaclab/visualizers/visualizer_cfg.py Accurately documents "normals" support and standardizes “initialization” spelling.
source/isaaclab/changelog.d/fix-streaming-gt-types-normals-docstring.rst Accurately records the corrected streaming_gt_types documentation.

Reviews (1): Last reviewed commit: "Fix streaming_gt_types docstring and add..." | Re-trigger Greptile

Comment thread docs/source/concepts/visualization.rst Outdated
Comment on lines 41 to 46
/* Trims pixels off each hero tile on top of whatever object-position crop is already
applied, so the tile itself is shorter rather than just repositioning the existing crop.
Both classes crop to the same final 241px height so the 2x2 tile grid stays even, split
differently per tile: Kit/Rerun/Newton RTX crop 35px off the top and 10px off the bottom;
Viser crops 25px off the top and 20px off the bottom (its object-position framing already
Both classes crop to the same final 221px height so the 2x2 tile grid stays even, split
differently per tile: Kit/Rerun/Newton RTX crop 45px off the top and 20px off the bottom;
Viser crops 35px off the top and 30px off the bottom (its object-position framing already
leaves more headroom at the bottom, so it can take a heavier bottom crop). */

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.

P2 Contradictory hero grid comment

This comment says both crop classes keep the 2x2 tile grid even at 221px, but the new top-row rules override those tiles to 206px. The contradiction could make future crop adjustments error-prone; clarify that tiles within each row have equal heights while the two rows intentionally differ.

Suggested change
/* Trims pixels off each hero tile on top of whatever object-position crop is already
applied, so the tile itself is shorter rather than just repositioning the existing crop.
Both classes crop to the same final 241px height so the 2x2 tile grid stays even, split
differently per tile: Kit/Rerun/Newton RTX crop 35px off the top and 10px off the bottom;
Viser crops 25px off the top and 20px off the bottom (its object-position framing already
Both classes crop to the same final 221px height so the 2x2 tile grid stays even, split
differently per tile: Kit/Rerun/Newton RTX crop 45px off the top and 20px off the bottom;
Viser crops 35px off the top and 30px off the bottom (its object-position framing already
leaves more headroom at the bottom, so it can take a heavier bottom crop). */
/* Trims pixels off each hero tile on top of whatever object-position crop is already
applied, so the tile itself is shorter rather than just repositioning the existing crop.
Both classes initially crop to the same 221px height, keeping tiles within each row even.
Kit/Rerun/Newton RTX crop 45px off the top and 20px off the bottom; Viser crops 35px off
the top and 30px off the bottom (its object-position framing already leaves more headroom
at the bottom, so it can take a heavier bottom crop). */

Note: If this suggestion doesn't match your team's coding style, reply to this and let me know. I'll remember it for next time!

The comment claimed both crop classes always produce a 221px tile, but the
top-row override added afterward shrinks Viser/Newton RTX to 206px, leaving
the two rows' heights undocumented and contradicting each other. Split the
comment so it states tiles are only even within each row, and documents the
top row's override separately.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

bug Something isn't working 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.

1 participant