Skip to main content

A simple maze to test dynamic programming and tabular reinforcement learning algorithms

Project description

TabularMazeMDP:

This repository contains code to provide a simple Maze environment used as example MDP for tabular dynamic programming and reinforcement learning labs.

If you want to do the corresponding labs, you need a Google account. Then you can copy-paste the dynamic programming colab and the reinforcement learning colab.

Documentation

MDPs and mazes

Some code is provided to create mazes, transform them into MDPs and visualize them together with policies or value functions. It is contained into three files: *maze.py, mdp.py and maze_plotter.py. The following sections give an overview of this code.

Content of the maze.py file

A maze is represented as an object of the Maze class. It is defined as a grid of width x height cells, and some of these cells contain a wall.

The build_maze(width, height, walls, hit=False) function is used to create a Maze, where walls is a list of the number of the cells which contain a wall. The hit parameter has an impact on the MDP reward function: if hit is true, the agent is penalized each time it tries to move to a wall cell. Otherwise, the agent is just rewarded when it reaches terminal states. In the provided function, the list of terminal states is a singleton corresponding to the last cell that the agent can visit.

Apart from representing the two reward functions described above, the Maze class contains a constructor whose only role is to create the MDP corresponding to the maze and the maze plotter used to display simulations. A key point is that only cells where there is no wall are considered as states of the underlying MDP. To facilitate the correspondence between mazes and MDPs, each free cell (i.e. with no wall) knows the number of its corresponding MDP state.

The maze constructors also builds the action space, the initial state distribution, the transition function and the reward function of the MDP. Once all these data structures have been created, the resulting MDP is built.

A build_maze() and a create_random_maze() functions are provided to create mazes in the lab notebooks or python files.

Content of the mdp.py file

The mdp.py file contains the SimpleActionSpace class and the Mdp class.

The SimpleActionSpace class contains the list of actions and a method to sample from this list. In our maze environment, the possible actions for the agent are going north, south, east or west (resp. [0, 1, 2, 3]).

The Mdp class is designed to be compatible with the OpenAI gym interface (https://gym.openai.com/). The main methods are reset(self, uniform=False), which resets the MDP into an initial state drawn from the initial state distribution, and step(self, u, deviation=0) which is used to let the agent perform a step in the environment, sending and action and receiving the next state, the reward, and a signal telling whether a terminal state was reached. The function render(self) provides a visual rendering of the current state of the simulation.

Content of the maze_plotter.py file

The code to display the effect of the algorithms in these environments is in maze_plotter.py, in the MazePlotter class. In order to visualize the environment, you use the new_render() function to initialize the rendering, then render(V, policy, agent_pos) to refresh the maze with either the newly calculated state values and the policy, or the state-action values, and eventually the current position of the agent. There is also a render_pi(policy) function which only displays the policy (useful for policy iteration). The function save_fig(title) is used to save the last render into a file.

You can see examples of calls to these different visualizations in the functions defined in dynamic programming and reinforcement learning notebooks or python files.

Toolbox

The toolbox.py file provide a few useful functions such as egreedy(), egreedy_loc() and softmax() which are used to perform exploration in reinforcement learning algorithms.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

tabularmazemdp-0.9.6.tar.gz (18.5 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

tabularmazemdp-0.9.6-py3-none-any.whl (15.7 kB view details)

Uploaded Python 3

File details

Details for the file tabularmazemdp-0.9.6.tar.gz.

File metadata

  • Download URL: tabularmazemdp-0.9.6.tar.gz
  • Upload date:
  • Size: 18.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.9.18

File hashes

Hashes for tabularmazemdp-0.9.6.tar.gz
Algorithm Hash digest
SHA256 0f0699bd46dcf39d87c8ca1c205f1a63d80392def6afe905f3ed7f270730ae85
MD5 41399e171b888301ffc6e9dde0544416
BLAKE2b-256 c7dc86a88e921ef607df9613a5f5f5da44730ede226e006fdf6d1c7a07367cb0

See more details on using hashes here.

File details

Details for the file tabularmazemdp-0.9.6-py3-none-any.whl.

File metadata

  • Download URL: tabularmazemdp-0.9.6-py3-none-any.whl
  • Upload date:
  • Size: 15.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.9.18

File hashes

Hashes for tabularmazemdp-0.9.6-py3-none-any.whl
Algorithm Hash digest
SHA256 70f6c7928122ad305a5a17907f2e115b2b63372dd24fa79102a2fc7d88bc2024
MD5 a1825128b34ae70e247e16b6a5fe946c
BLAKE2b-256 18b947a406a7f1e16f6d0080f9f4a5d2704f5d7ca9006ed6ce68f94bca2d540b

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page