Skip to content

Commit

Permalink
add C library compilation info
Browse files Browse the repository at this point in the history
  • Loading branch information
eonu committed Dec 27, 2022
1 parent ed42776 commit 936714e
Showing 1 changed file with 7 additions and 1 deletion.
8 changes: 7 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@

Sequentia is a Python package that provides various classification and regression algorithms for sequential data, including methods based on hidden Markov models and dynamic time warping.

Some examples of how Sequentia can be on sequence data include:
Some examples of how Sequentia can be used on sequence data include:

- determining a spoken word based on its audio signal or alternative representations such as MFCCs,
- predicting motion intent for gesture control from sEMG signals,
Expand Down Expand Up @@ -92,6 +92,12 @@ The latest stable version of Sequentia can be installed with the following comma
pip install sequentia
```

#### C library compilation

For optimal performance when using any of the k-NN based models, it is important that `dtaidistance` C libraries are compiled correctly.

Please see the [`dtaidistance` installation guide](https://dtaidistance.readthedocs.io/en/latest/usage/installation.html) for troubleshooting if you run into C compilation issues, or if setting `use_c=True` on k-NN based models results in a warning.

### Pre-release

Pre-release versions include new features which are in active development and may change unpredictably.
Expand Down

0 comments on commit 936714e

Please sign in to comment.