Metadata-Version: 2.1
Name: q2
Version: 0.1.4
Summary: A reinforcement learning framework and command line tool
Home-page: https://github.com/tdb-alcorn/q2
Author: Tom Alcorn
Author-email: tdb.alcorn@gmail.com
License: MIT
Keywords: deep reinforcement learning framework tool
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Environment :: Console
Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
Classifier: Topic :: Scientific/Engineering :: Artificial Life
Requires-Dist: numpy
Requires-Dist: tensorflow
Requires-Dist: PyYAML
Requires-Dist: gym
Requires-Dist: gym-retro

# q2

A reinforcement learning framework and command line tool.


## Get it

```
pip install q2
q2 --help
```

## Use it

Make a folder, `cd` to it, then run

```
q2 init
```

to generate a new reinforcement learning project.

## Docs

Documentation is available at https://q2.readthedocs.io/.


## Develop


0. You'll need Python >= 3.5 (this is because q2 makes use of type annotations)
1. Clone this repository
2. I recommend setting up a virtual env in which to develop: `python -m venv env`
3. `pip install -r requirements.txt`

To test out the command line tools from your working copy of q2, run

```
pip install -e .
```

then run

```
q2 --help
```

to test that it worked.


## Contributing

If you want to submit a bug fix or minor change, feel free to make a pull request.

If you want to discuss bigger improvements, send an email to tdbalcorn at gmail dot com.

