From 936714ee28a8629d0e9af16d7b40b202255d5027 Mon Sep 17 00:00:00 2001 From: Edwin Onuonga Date: Tue, 27 Dec 2022 21:30:29 +0400 Subject: [PATCH] add C library compilation info --- README.md | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 2a4a87e..6fe92cc 100644 --- a/README.md +++ b/README.md @@ -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, @@ -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.