Metadata-Version: 2.0
Name: bonsai-gym-common
Version: 0.3.0
Summary: A library to integrate Bonsai BRAIN with OpenAI Gym environments
Home-page: http://github.com/BonsaiAI/bonsai-gym-common
Author: Bonsai Engineering
Author-email: opensource@bons.ai
License: BSD
Keywords: bonsai
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
Classifier: License :: OSI Approved :: BSD License
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Classifier: Natural Language :: English
Requires-Dist: bonsai-python (>=0.5.0)
Requires-Dist: gym (>=0.3.0)

Bonsai Gym Common
==========
A python library for integrating Bonsai BRAIN with Open AI Gym environments.

Installation
------------

Install the latest stable from PyPI:
```
$ pip install bonsai-gym-common
```

Install the latest in-development version:
```
$ pip install https://github.com/BonsaiAI/bonsai-gym-common
```

Usage
-----
Once installed, import `bonsai_gym_common` in order to access
base class `GymSimulator` and `GymImageSimulator`, which
implement all of the environment-independent Bonsai SDK
integrations necessary to train a Bonsai BRAIN to play an
OpenAI Gym simulator.

```
import gym

from bonsai_gym_common import GymSimulator

class CartPoleSimulator(GymSimulator):
    # Perform cartpole-specific integrations here.
```


