diff --git a/docs/src/index.rst b/docs/src/index.rst index 412a0602..5c2bf198 100644 --- a/docs/src/index.rst +++ b/docs/src/index.rst @@ -27,14 +27,11 @@ for pre-existing projects to prototype RL as a potential solution. release overview gridworld - simulations/simulations featured_usage/featured_usage install tutorials/tutorials api -.. TODO: Move featured usage to the top? - Citation -------- diff --git a/docs/src/release.rst b/docs/src/release.rst index 6ec43eb3..39b75eea 100644 --- a/docs/src/release.rst +++ b/docs/src/release.rst @@ -52,16 +52,6 @@ it is facing. We foresee many applications of this type of movement, including usage in our new :ref:`pacman game `. -Simulations ------------ - -.. # TODO: Need to fill this out -* :ref:`Traffic corridor ` simulates agents navigating - a tight corridor. They must cooperate by taking turns in order for all of them - to make it through. -* :ref:`Pacman ` variation simulates the Pacman arcade game. - - Miscellaneous ------------- @@ -81,6 +71,11 @@ Other Features * :ref:`Ranomize placement order ` parameter for randomly iterating through dictionary of agents when initially placing them in the grid. * Gridworld agents have customizable ``render_size``, which defaults to 200. +* :ref:`Traffic corridor ` simulates agents navigating + a tight corridor. They must cooperate by taking turns in order for all of them + to make it through. +* :ref:`Pacman ` variation simulates the Pacman arcade game, + with support for training the "baddie" agents too. Bug fixes ````````` diff --git a/docs/src/simulations/simulations.rst b/docs/src/simulations/simulations.rst deleted file mode 100644 index 4473fdc8..00000000 --- a/docs/src/simulations/simulations.rst +++ /dev/null @@ -1,20 +0,0 @@ -.. Abmarl built in simulations. - -Simulations -=========== - -Abmarl provides several built-in simulations to help you get started with agent-based -simulation and reinforcement learning. Below is an index of those simulations, and -each page contains descriptive information on the simulation and examples of running -them. - -.. toctree:: - :maxdepth: 1 - :caption: Built-in Simulations - - multi_corridor - maze - team_battle - traffic_corridor - pacman - ...