From 89abbb19f56f80585c8b48c477b238ce0a12bf9b Mon Sep 17 00:00:00 2001 From: Bam4d Date: Fri, 4 Jun 2021 20:41:49 +0100 Subject: [PATCH 01/18] trying to fix docs --- docs/requirements.txt | 4 ++-- python/examples/experiments/autoregressive-cats | 2 +- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/requirements.txt b/docs/requirements.txt index 4ca71000e..1e681cee1 100644 --- a/docs/requirements.txt +++ b/docs/requirements.txt @@ -1,5 +1,5 @@ -sphinx==3.1.0 +sphinx==4.0.2 recommonmark==0.6.0 -sphinx_rtd_theme==0.4.3 +sphinx_rtd_theme==0.5.2 sphinxcontrib-images==0.9.2 sphinx-copybutton==0.3.1 \ No newline at end of file diff --git a/python/examples/experiments/autoregressive-cats b/python/examples/experiments/autoregressive-cats index d2143f8f8..6a04d167e 160000 --- a/python/examples/experiments/autoregressive-cats +++ b/python/examples/experiments/autoregressive-cats @@ -1 +1 @@ -Subproject commit d2143f8f844fe30f60dc458b5d7286e36db0d54f +Subproject commit 6a04d167ed47587e972520628c2c6fd0d876fce0 From 72a4965393bd48674bf4b7c4153b7b42c494224d Mon Sep 17 00:00:00 2001 From: Bam4d Date: Fri, 4 Jun 2021 20:45:36 +0100 Subject: [PATCH 02/18] fixing readthedocs name --- readthedocs.yml => .readthedocs.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) rename readthedocs.yml => .readthedocs.yaml (97%) diff --git a/readthedocs.yml b/.readthedocs.yaml similarity index 97% rename from readthedocs.yml rename to .readthedocs.yaml index 21a38194e..1608c0e2a 100644 --- a/readthedocs.yml +++ b/.readthedocs.yaml @@ -19,6 +19,6 @@ formats: # Optionally set the version of Python and requirements required to build your docs python: - version: 3.7 + version: 3.8 install: - requirements: docs/requirements.txt \ No newline at end of file From 6ce82ec3dd47b90540cc8c7d1f4733a24c0c47a2 Mon Sep 17 00:00:00 2001 From: Bam4d Date: Fri, 4 Jun 2021 20:50:24 +0100 Subject: [PATCH 03/18] more fixing --- .readthedocs.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.readthedocs.yaml b/.readthedocs.yaml index 1608c0e2a..060ad8bd4 100644 --- a/.readthedocs.yaml +++ b/.readthedocs.yaml @@ -11,7 +11,7 @@ sphinx: # Build documentation with MkDocs #mkdocs: -# configuration: mkdocs.yml +# configuration: mkdocs.yml # Optionally build your docs in additional formats such as PDF formats: From 3de270cae4708353f1725d6d3e88e85b8fde86ab Mon Sep 17 00:00:00 2001 From: Bam4d Date: Fri, 4 Jun 2021 20:59:18 +0100 Subject: [PATCH 04/18] fixing copy button --- docs/requirements.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/requirements.txt b/docs/requirements.txt index 1e681cee1..4ef3f775b 100644 --- a/docs/requirements.txt +++ b/docs/requirements.txt @@ -1,5 +1,5 @@ sphinx==4.0.2 recommonmark==0.6.0 sphinx_rtd_theme==0.5.2 -sphinxcontrib-images==0.9.2 +sphinxcontrib-images==0.9.3 sphinx-copybutton==0.3.1 \ No newline at end of file From 21e8c2786ca75b3224852c524a5e44cf9150f9d6 Mon Sep 17 00:00:00 2001 From: Bam4d Date: Fri, 4 Jun 2021 21:12:10 +0100 Subject: [PATCH 05/18] trying to fix static docs --- docs/conf.py | 2 +- docs/getting-started/procedural content generation/index.rst | 5 +++-- 2 files changed, 4 insertions(+), 3 deletions(-) diff --git a/docs/conf.py b/docs/conf.py index 06239da28..a3a2535d5 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -63,7 +63,7 @@ # Add any paths that contain custom static files (such as style sheets) here, # relative to this directory. They are copied after the builtin static files, # so a file named "default.css" will overwrite the builtin "default.css". -html_static_path = ['_static'] +html_static_path = '_static' master_doc = 'index' diff --git a/docs/getting-started/procedural content generation/index.rst b/docs/getting-started/procedural content generation/index.rst index f4669e043..006d8e962 100644 --- a/docs/getting-started/procedural content generation/index.rst +++ b/docs/getting-started/procedural content generation/index.rst @@ -41,14 +41,15 @@ This is a basic example and generating levels for this environment might not be Clusters Level Generator ************************ -A much more complicated example would be to use the `Clusters` game and generate new levels. The aim of the Clusters game is for the agent to push coloured blocks together to form "clusters", whilst avoiding spikes. +A much more complicated example would be to use the :ref:`Clusters ` game and generate new levels. The aim of the Clusters game is for the agent to push coloured blocks together to form "clusters", whilst avoiding spikes. The game is fully deterministic and there are only 5 levels supplied in the original GDY file. This makes it a perfect candidate for building new levels and testing if Reinforcement Learning can still solve these levels! Level Generator Class ===================== -Here's an example of a level generator for the cluster's game. +Here's an example of a level generator for the cluster's game. Levels are generated with simple configurable heuristics such as maximum number of each coloured boxes and maximum numbers of spikes. +The boxes and spikes are randomly placed in the grid to create the initial game layout. The agent is also added to the grid in a random position. The ``LevelGenerator`` class can be used as a base class. Only the ``generate`` function needs to be implemented. From 9312c57c87bcde6a452931e5f00779e762923f90 Mon Sep 17 00:00:00 2001 From: Bam4d Date: Fri, 4 Jun 2021 21:23:38 +0100 Subject: [PATCH 06/18] fixing video in docs --- docs/getting-started/action spaces/index.rst | 2 +- docs/rllib/rts/index.rst | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/getting-started/action spaces/index.rst b/docs/getting-started/action spaces/index.rst index 6353a4dce..84bb9af84 100644 --- a/docs/getting-started/action spaces/index.rst +++ b/docs/getting-started/action spaces/index.rst @@ -94,7 +94,7 @@ In order to easily support games with large action spaces such as RTS games, sev If ``mask_type == 'full'`` then a mask of dimensions (grid_height, grid_width) is returned. This mask can be used in the case where a one-hot representation of the entire grid is used for location selection. - If ``mask_type == 'reduced'`` then two masks are returned. One for ``grid_height`` and one for ``grid_width``. This mask can be used when two seperate one-hot representations are used for ``x`` and ``y`` selection. + If ``mask_type == 'reduced'`` then two masks are returned. One for ``grid_height`` and one for ``grid_width``. This mask can be used when two separate one-hot representations are used for ``x`` and ``y`` selection. .. warning:: player_id=0 is reserved for NPCs and internal actions diff --git a/docs/rllib/rts/index.rst b/docs/rllib/rts/index.rst index 9abd34afb..1a909c371 100644 --- a/docs/rllib/rts/index.rst +++ b/docs/rllib/rts/index.rst @@ -26,7 +26,7 @@ Full Example