PyAI

A set of open source frameworks for Artificial Intelligence (mostly machine learning and optimization).

Note:

This project is still in beta stage, so the API is not finalized yet.

Contents:

Introduction

Copyright (c) 2014,2015,2016,2017 Jeremie DECOCK (http://www.jdhp.org)

Description

This is a set of open source frameworks for Artificial Intelligence (mostly machine learning and optimization).

This contains (among others):

  • a blackbox non linear noisy optimization framework;
  • a machine learning framework;
  • a multistage optimization and Markov Decision Process framework (Markov Decision Processes).

Note:

This project is still in beta stage, so the API is not finalized yet.

Dependencies

  • Python >= 3.0
  • Numpy
  • Matplotlib

Installation

Gnu/Linux

You can install, upgrade, uninstall PyAI with these commands (in a terminal):

pip install --pre jdhp-pyai
pip install --upgrade jdhp-pyai
pip uninstall jdhp-pyai

Or, if you have downloaded the PyAI source code:

python3 setup.py install

Windows

You can install, upgrade, uninstall PyAI with these commands (in a command prompt):

py -m pip install --pre jdhp-pyai
py -m pip install --upgrade jdhp-pyai
py -m pip uninstall jdhp-pyai

Or, if you have downloaded the PyAI source code:

py setup.py install

MacOSX

You can install, upgrade, uninstall PyAI with these commands (in a terminal):

pip install --pre jdhp-pyai
pip install --upgrade jdhp-pyai
pip uninstall jdhp-pyai

Or, if you have downloaded the PyAI source code:

python3 setup.py install

Documentation

Example usage

TODO

Bug reports

To search for bugs or report them, please use the PyAI Bug Tracker at:

License

This project is provided under the terms and conditions of the MIT License.

Indices and tables

API

The library provides classes which are usable by third party tools.

Note

This project is still in beta stage, so the API is not finalized yet.

Modules:

TODO_PYTHON_PACKAGE_NAME.TODO_PACKAGE_NAME

Developer’s notes

Source code

The source code is currently available on GitHub under the terms and conditions of the MIT license. Fork away!

Bug reports

To search for bugs or report them, please use the Bug Tracker at:

Contribute

This project is written for Python 3.x. Python 2.x is not supported.

The TODO.md file contains the TODO list.

All contributions should at least comply with the following PEPs:

  • PEP8 “Python’s good practices”
  • PEP257 “Docstring Conventions”
  • PEP287 “reStructuredText Docstring Format”

All contribution should be properly documented and tested with unittest and/or doctest.

pylint, pep8 and pyflakes should also be used to check the quality of each module.

Docstrings should be compatible with the Sphinx “napoleon” extension and follow the Numpy style:

Changes

0.1 (????-??-??)

Initial version

0.2 (????-??-??)

Changes:

  • switch to Python 3
  • update the docstrings
  • change the package name (pyai)
  • miscellaneous updates and bug fixes

Packaging:

  • write the setup.py file
  • write a script to automatically build the Debian package

Indices and tables

Credits

Jérémie DECOCK <jd.jdhp@gmail.com> (www.jdhp.org)

License

The MIT License

Copyright (c) 2014,2015,2016,2017 Jérémie DECOCK <jd.jdhp@gmail.com> (www.jdhp.org)

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.