Skip to content

Commit

Permalink
Add docstring to MujocoEnv.__init__() (#522)
Browse files Browse the repository at this point in the history
  • Loading branch information
Kallinteris-Andreas authored May 25, 2023
1 parent ae5d888 commit 95f2a42
Showing 1 changed file with 16 additions and 0 deletions.
16 changes: 16 additions & 0 deletions gymnasium/envs/mujoco/mujoco_env.py
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,22 @@ def __init__(
camera_id: Optional[int] = None,
camera_name: Optional[str] = None,
):
"""Base abstract class for mujoco based environments.
Args:
model_path: Path to the MuJoCo Model.
frame_skip: Number of mujoco simulation steps per gym `step()`.
observation_space: The observation space of the environment.
render_mode: The `render_mode` used.
width: The width of the render window.
height: The height of the render window.
camera_id: The Default camera used.
camera_name: The name for the default camera.
Raises:
OSError: when the `model_path` does not exist.
error.DependencyNotInstalled: When `mujoco` is not installed.
"""
if model_path.startswith("/"):
self.fullpath = model_path
else:
Expand Down

0 comments on commit 95f2a42

Please # to comment.