Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[MuJoCo] add render arguments to the documention #744

Merged
merged 3 commits into from
Oct 18, 2023
Merged

[MuJoCo] add render arguments to the documention #744

Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
58d8545
`mujoco.md` add render arguments
Kallinteris-Andreas Oct 17, 2023
9e00581
typo fix
Kallinteris-Andreas Oct 17, 2023
852315c
Update mujoco.md
Kallinteris-Andreas Oct 18, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 14 additions & 0 deletions docs/environments/mujoco.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,3 +42,17 @@ There are eleven Mujoco environments: Ant, HalfCheetah, Hopper, Humanoid, Humano
Among Gymnasium environments, this set of environments can be considered as more difficult ones to solve by a policy.

Environments can be configured by changing the XML files or by tweaking the parameters of their classes.

## Arguments
Kallinteris-Andreas marked this conversation as resolved.
Show resolved Hide resolved
The all MuJoCo Environments besides the general Gymnasium arguments and environment specific arguments they also take the following arguments for configuring the renderer:


| Parameter | Type | Default |Description |
|--------------------------------------------|------------|--------------|-------------------------------|
|`width` | **int** | `480` | The width of the render window. |
|`height` | **int** | `480` | The width of the render window. |
|`camera_id` |**int \| None**| `None` | The camera ID used for the render window. |
|`camera_name` |**str \| None**| `None` | The name of the camera used (mutally exclusive option with `camera_id`). |
|`default_camera_config` |**Dict[str, Union[float, int]] \| None** | `None` | The [mjvcamera](https://mujoco.readthedocs.io/en/stable/APIreference/APItypes.html?highlight=camera#mjvcamera) properties. |
|`max_geom` | **int** | `1000` | Max number of geometrical objects to render (useful for 3rd-party environments).|

Copy link
Member

Choose a reason for hiding this comment

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

Could you add an example script here to initialize an environment with some of these arguments

Loading