diff --git a/README.md b/README.md new file mode 100644 index 0000000000000000000000000000000000000000..5ece707c330647064530c3f59ce06eb9141f29a6 --- /dev/null +++ b/README.md @@ -0,0 +1,23 @@ +# 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