.. -- mode: rst --

.. image:: https://github.com/arthurpaulino/miraiml/raw/master/docs/img/MiraiML.svg?sanitize=true

....

|license|_ |travis|_ |codacy|_ |docs|_ |pypi|_ |pepy|_

.. |license| image:: https://img.shields.io/badge/License-MIT-yellow.svg .. _license: https://opensource.org/licenses/MIT

.. |travis| image:: https://travis-ci.org/arthurpaulino/miraiml.svg .. _travis: https://travis-ci.org/arthurpaulino/miraiml

.. |codacy| image:: https://api.codacy.com/project/badge/Grade/983bcf3973094f20ba4f516d6891c5f7 .. _codacy: https://www.codacy.com/app/arthurpaulino/miraiml

.. |docs| image:: https://readthedocs.org/projects/miraiml/badge/?version=latest .. _docs: https://readthedocs.org/projects/miraiml/

.. |pypi| image:: https://badge.fury.io/py/MiraiML.svg .. _pypi: https://pypi.org/project/MiraiML/

.. |pepy| image:: https://pepy.tech/badge/miraiml .. _pepy: https://pepy.tech/project/miraiml

MiraiML

Mirai: `future` in japanese.

MiraiML is an asynchronous engine for continuous & autonomous machine learning, built for real-time usage.

Usage

1. Install: $ pip install miraiml
2. Now, inside a Python environment, you can import the main components:

from miraiml import SearchSpace, Config, Engine

You might want to Read the Docs_ for a better understanding of MiraiML.

Contributing

Please, follow the guidelines_ if you want to be part of this project.

.. _examples: https://github.com/arthurpaulino/miraiml/tree/master/examples .. _Read the Docs: https://miraiml.readthedocs.io/en/latest/ .. _guidelines: https://github.com/arthurpaulino/miraiml/blob/master/CONTRIBUTING.md