Skip to content
Snippets Groups Projects
Commit e3a76198 authored by Blaß, Michael's avatar Blaß, Michael :speech_balloon:
Browse files

Updated readme.

parent 5aae0145
No related branches found
No related tags found
No related merge requests found
......@@ -11,3 +11,4 @@ tests/playground
.vimrc
src/
dist/
__pycache__
# ChainsAddiction
ChainsAddiction is a tool for simple training discrete-time Hidden Markov
Models. It is written in `C` and features a `numpy`-based Python extension
module.
## Installation
Clone this repository, change to its root directory and issue
pip install .
## Working with the C API
## Working with the Python interpreter
Calling Chains_addiction from `Python` is simple as pie. You just need to import
it:
import chains_addiction as ca
ca.hmm_poisson_fit_em(x, m, init_means, init_tpm, int_sd, max_iter=1000, tol=1e-5)
## Notes
- Currently only Poisson-distributed HMM are implemented.
- ChainsAddiction does not support Python 2. Specifically, it requires `Python >= 3.5` and `numpy >= 1.16`.
\ No newline at end of file
=======================================
ChainsAddiction
=======================================
ChainsAddiction is a tool for simple training discrete-time Hidden Markov
Models. It is written in C and features a numpy-based Python extension
module.
Installation
=======================================
Clone this repository, change to its root directory and issue
.. code-block:: bash
pip install .
Working with chainsaddiction
=======================================
Calling chainsaddiction from Python is simple as pie. You just need to import
it:
.. code-block:: python
import chainsaddiction as ca
ca.hmm_poisson_fit_em(trainig_data, m_states, init_means, init_tpm,
int_sd, max_iter=1000, tol=1e-5)
Notes
---------------------------------------
* Currently only algorithms for Poisson-distributed HMMs are implemented.
* ChainsAddiction does not support Python 2. Specifically, it requires `Python >= 3.7` and `numpy >= 1.16`.
[metadata]
name = chainsaddiction
version = 0.1
version = 0.1.1
description = Discrete time, finit state space, stationary Hidden Markov Model.
long_description = file: README.md
license = BSD 3-Clause License
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment