Metadata-Version: 2.0
Name: hmmlearn
Version: 0.2.0
Summary: Hidden Markov Models in Python with scikit-learn like API
Home-page: https://github.com/hmmlearn/hmmlearn
Author: Sergei Lebedev
Author-email: superbobry@gmail.com
License: new BSD
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: License :: OSI Approved
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Science/Research
Classifier: Topic :: Software Development
Classifier: Topic :: Scientific/Engineering
Classifier: Programming Language :: Cython
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2.6
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Provides-Extra: docs
Requires-Dist: Pillow; extra == 'docs'
Requires-Dist: Sphinx; extra == 'docs'
Requires-Dist: matplotlib; extra == 'docs'
Requires-Dist: numpydoc; extra == 'docs'
Requires-Dist: sklearn (>=0.16); extra == 'docs'
Requires-Dist: sphinx-gallery; extra == 'docs'
Provides-Extra: tests
Requires-Dist: pytest; extra == 'tests'
Requires-Dist: sklearn (>=0.16); extra == 'tests'

hmmlearn |travis| |appveyor|
========

.. |travis| image:: https://api.travis-ci.org/hmmlearn/hmmlearn.png?branch=master
   :target: https://travis-ci.org/hmmlearn/hmmlearn

.. |appveyor| image:: https://ci.appveyor.com/api/projects/status/3c70msixtdvvae20/branch/master?svg=true
   :target: https://ci.appveyor.com/project/superbobry/hmmlearn/branch/master

hmmlearn is a set of algorithms for **unsupervised** learning and inference of
Hidden Markov Models. For supervised learning learning of HMMs and similar models
see `seqlearn <https://github.com/larsmans/seqlearn>`_.

Getting the latest code
=======================

To get the latest code using git, simply type::

    $ git clone https://github.com/hmmlearn/hmmlearn.git

Installing
==========

Make sure you have all the dependencies::

    $ pip install numpy scipy scikit-learn

and then install ``hmmlearn`` by running::

    $ python setup.py install

in the source code directory.

Running the test suite
======================

To run the test suite, you need ``pytest``. Run the test suite using::

    $ python setup.py build_ext --inplace
    $ py.test --doctest-modules hmmlearn

from the root of the project.

Building the docs
=================

To build the docs you need to have the following packages installed::

    $ pip install Pillow matplotlib Sphinx sphinx-gallery sphinx_rtd_theme numpydoc

Run the command::

    $ cd doc
    $ make html

The docs are built in the ``_build/html`` directory.

Making a source tarball
=======================

To create a source tarball, eg for packaging or distributing, run the
following command::

    $ python setup.py sdist

The tarball will be created in the ``dist`` directory.

Making a release and uploading it to PyPI
=========================================

This command is only run by project manager, to make a release, and
upload in to PyPI::

    $ python setup.py sdist bdist_egg register upload


