orbit
orbit copied to clipboard
[Proposal] Add a deprecation warning for `render_interval`'s predecessor `SimulationCfg.decimation`
Proposal
Add in a deprecation warning when a user tries to set sim_cfg.decimation
. Also update migration guide to explain the update to the parameter.
Motivation
Recently render_interval
was introduced as a way of handling the # of frames between rendering. Previously this was handle via sim_cfg.decimation
. For users using the old parameter, rendering will occur each physics step which likely causes a big performance hit.
Checklist
- [x] I have checked that there is no similar issue in the repo (required)
Acceptance Criteria
Add the criteria for which this task is considered done. If not known at issue creation time, you can add this once the issue is assigned.
- [ ] Deprecation warning added for
SimulationCfg.decimation
- [ ] Isaac Lab migration guide from Orbit updated to include new parameter