[MuJoCo] add render arguments to the documention #744
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
pseudo-rnd-thoughts
requested changes
Oct 17, 2023
docs/environments/mujoco.md
Outdated
| |`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).| | ||
|
|
There was a problem hiding this comment.
Could you add an example script here to initialize an environment with some of these arguments
pseudo-rnd-thoughts
approved these changes
Oct 18, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Adds a short description of the available arguments for changing the render properties of
MuJoCoenvironmentsI am not sure if the main page of MuJoCo is place to place the descriptions, if you have different suggestions of where to put them, i can move them
Fixes # (issue)
Type of change
Checklist:
pre-commitchecks withpre-commit run --all-files(seeCONTRIBUTING.mdinstructions to set it up)