Unverified Commit 6f8ec452 authored by Mayank Mittal's avatar Mayank Mittal Committed by GitHub

Adds more details about state in InteractiveScene (#2119)

# Description

It was hard to understand what the scene's state means unless you check
the code. This MR adds more docstrings to make this simpler to
understand.

## Type of change

- This change requires a documentation update

## Checklist

- [x] I have run the [`pre-commit` checks](https://pre-commit.com/) with
`./isaaclab.sh --format`
- [x] I have made corresponding changes to the documentation
- [x] My changes generate no new warnings
- [ ] I have added tests that prove my fix is effective or that my
feature works
- [ ] I have updated the changelog and the corresponding version in the
extension's `config/extension.toml` file
- [x] I have added my name to the `CONTRIBUTORS.md` or my name already
exists there
parent f8cf6bad
......@@ -319,16 +319,23 @@ class ManagerBasedEnv:
env_ids: Sequence[int] | None,
seed: int | None = None,
is_relative: bool = False,
) -> None:
"""Resets specified environments to known states.
):
"""Resets specified environments to provided states.
Note that this is different from reset() function as it resets the environments to specific states
This function resets the environments to the provided states. The state is a dictionary
containing the state of the scene entities. Please refer to :meth:`InteractiveScene.get_state`
for the format.
The function is different from the :meth:`reset` function as it resets the environments to specific states,
instead of using the randomization events for resetting the environments.
Args:
state: The state to reset the specified environments to.
state: The state to reset the specified environments to. Please refer to
:meth:`InteractiveScene.get_state` for the format.
env_ids: The environment ids to reset. Defaults to None, in which case all environments are reset.
seed: The seed to use for randomization. Defaults to None, in which case the seed is not set.
is_relative: If set to True, the state is considered relative to the environment origins. Defaults to False.
is_relative: If set to True, the state is considered relative to the environment origins.
Defaults to False.
"""
# reset all envs in the scene if env_ids is None
if env_ids is None:
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment