Skip to main content

Gym for the Snake Game

Project description

1. pysnakegym

The pysnakegym project provides a gym environment for developing reinforcement

learning algorithms for the game of snake.

2. Installation

To get started, you need to have Python 3.6+ installed. The pysnakegym package

can simply be installed with pip.

pip install pysnakegym

3. How to use

Below is an example of how to use the gym. The interface is an MDP object representing

a Markov Decision Process (MDP) of the game of snake.

from pysnakegym.mdp import mdp



state, reward, done = mdp.reset()



while not done:

    state_, reward, done = mdp.step(action=choose_action(state))

    state = state_

The reset method of the mdp returns a triplet consisting of the following:

  • state (numpy array): the start state of the MDP. Depending on the state representation

the shape and size will vary.

  • reward (float): the initial reward of the MDP.

  • done (bool): whether the game is finished or not. Always returns false for the reset

method.


The step method of the mdp takes an action and returns a triplet consisting of the following:

  • state (numpy array): the state of the MDP that was observed after the step

    was taken. Depending on the state representation the shape and size will vary.

  • reward (float): the reward observed after the step has been taken.

  • done (bool): whether the game is finished or not. Returns true if state is a

final state, false if it is not.

The step method is a representation of the agent-environment interaction that

constitutes an MDP. The agent chooses an action to be taken in the environment and in return observes

a new state and a reward.

4. State Representation

The state that the snake receives as input can be represented in many different ways. When choosing

a state representation, one must make a tradeoff between keeping the state lightweight so that

the neural network is not too complex and encoding enough information so that the snake is able

to make the right decisions for the right state. Abstracting away information means that

the set of possible states the snake can find itself in becomes smaller, however it also means

that some granularity is lost. Likewise, encoding unnecessary information blows up the set of

possible states that the snake will have to learn the correct output for.

4.1 Choosing Necessary Information

When selecting the information that should be included in the state representation it is helpful to think

how you as a human would play the game. Things you would want to know are the direction the snake

is currently moving in, where the obstacles are relative to the head of the snake, and where the

food is relative to the snake's head.

4.2 Available States

There are a number of state representations available to choose from:

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

pysnakegym-0.0.9.tar.gz (13.7 kB view details)

Uploaded Source

Built Distribution

pysnakegym-0.0.9-py3-none-any.whl (16.5 kB view details)

Uploaded Python 3

File details

Details for the file pysnakegym-0.0.9.tar.gz.

File metadata

  • Download URL: pysnakegym-0.0.9.tar.gz
  • Upload date:
  • Size: 13.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.2 importlib_metadata/4.8.1 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.6.13

File hashes

Hashes for pysnakegym-0.0.9.tar.gz
Algorithm Hash digest
SHA256 24c0f3d1bae2e897b989cd952d1496dfd5d10e949a22c9a26f56b0327e349e53
MD5 fb3915e919d0bd86354a4da4a29f6e88
BLAKE2b-256 7a22464c5dc2edc0f755718b0462bcb1f470126cae4ac3a76a23c7e63dd9547f

See more details on using hashes here.

File details

Details for the file pysnakegym-0.0.9-py3-none-any.whl.

File metadata

  • Download URL: pysnakegym-0.0.9-py3-none-any.whl
  • Upload date:
  • Size: 16.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.2 importlib_metadata/4.8.1 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.6.13

File hashes

Hashes for pysnakegym-0.0.9-py3-none-any.whl
Algorithm Hash digest
SHA256 d7f89615451ef626f5e743eb2d84dd5caf02b605aa7dc8b8886e337ff254d142
MD5 b535e48e33d90c6a94b5cc47acd97c74
BLAKE2b-256 50b2f3667d955b6c1f54b737e483441219768dd825d1561cbd796bac3c1e0365

See more details on using hashes here.

Supported by

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