From 33cc748516455d871bbfd081f5b4b60b937fe140 Mon Sep 17 00:00:00 2001 From: Sasha Abramowitz Date: Fri, 25 Oct 2024 15:12:26 +0200 Subject: [PATCH] fix: remove num agents from cleaner init in docs (#249) Also fix mkdocs plugin versopm --- docs/api/environments/cleaner.md | 8 ++++++++ docs/api/environments/connector.md | 2 +- jumanji/environments/routing/cleaner/env.py | 5 ++--- requirements/requirements-dev.txt | 1 + 4 files changed, 12 insertions(+), 4 deletions(-) diff --git a/docs/api/environments/cleaner.md b/docs/api/environments/cleaner.md index de35798ae..146233a30 100644 --- a/docs/api/environments/cleaner.md +++ b/docs/api/environments/cleaner.md @@ -1 +1,9 @@ ::: jumanji.environments.routing.cleaner.env.Cleaner + selection: + members: + - __init__ + - reset + - step + - observation_spec + - action_spec + - render diff --git a/docs/api/environments/connector.md b/docs/api/environments/connector.md index 0afc61243..c7688a1f0 100644 --- a/docs/api/environments/connector.md +++ b/docs/api/environments/connector.md @@ -1,7 +1,7 @@ ::: jumanji.environments.routing.connector.env.Connector selection: members: - - init + - __init__ - observation_spec - action_spec - reset diff --git a/jumanji/environments/routing/cleaner/env.py b/jumanji/environments/routing/cleaner/env.py index 7dd8c6423..28dbe9761 100644 --- a/jumanji/environments/routing/cleaner/env.py +++ b/jumanji/environments/routing/cleaner/env.py @@ -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 diff --git a/requirements/requirements-dev.txt b/requirements/requirements-dev.txt index 58afa9227..e2a0aadd2 100644 --- a/requirements/requirements-dev.txt +++ b/requirements/requirements-dev.txt @@ -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