Skip to content

Commit

Permalink
Merge branch 'main' into fix/setup.py
Browse files Browse the repository at this point in the history
  • Loading branch information
sash-a authored Oct 25, 2024
2 parents 964bdbe + 33cc748 commit c0e9fa0
Show file tree
Hide file tree
Showing 4 changed files with 12 additions and 4 deletions.
8 changes: 8 additions & 0 deletions docs/api/environments/cleaner.md
Original file line number Diff line number Diff line change
@@ -1 +1,9 @@
::: jumanji.environments.routing.cleaner.env.Cleaner
selection:
members:
- __init__
- reset
- step
- observation_spec
- action_spec
- render
2 changes: 1 addition & 1 deletion docs/api/environments/connector.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
::: jumanji.environments.routing.connector.env.Connector
selection:
members:
- init
- __init__
- observation_spec
- action_spec
- reset
Expand Down
5 changes: 2 additions & 3 deletions jumanji/environments/routing/cleaner/env.py
Original file line number Diff line number Diff line change
Expand Up @@ -91,14 +91,13 @@ def __init__(
"""Instantiates a `Cleaner` environment.
Args:
num_agents: number of agents. Defaults to 3.
time_limit: max number of steps in an episode. Defaults to `num_rows * num_cols`.
generator: `Generator` whose `__call__` instantiates an environment instance.
Implemented options are [`RandomGenerator`]. Defaults to `RandomGenerator` with
`num_rows=10`, `num_cols=10` and `num_agents=3`.
time_limit: max number of steps in an episode. Defaults to `num_rows * num_cols`.
penalty_per_timestep: the penalty returned at each timestep in the reward.
viewer: `Viewer` used for rendering. Defaults to `CleanerViewer` with "human" render
mode.
penalty_per_timestep: the penalty returned at each timestep in the reward.
"""
self.generator = generator or RandomGenerator(
num_rows=10, num_cols=10, num_agents=3
Expand Down
1 change: 1 addition & 0 deletions requirements/requirements-dev.txt
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ mkdocs-git-revision-date-plugin==0.3.2
mkdocs-include-markdown-plugin==4.0.4
mkdocs-material==8.2.7
mkdocs-mermaid2-plugin==0.6.0
mkdocs_autorefs<1.0
mkdocstrings==0.18.0
mknotebooks==0.7.1
mypy==0.991
Expand Down

0 comments on commit c0e9fa0

Please sign in to comment.