Skip to content

Commit 09bf25e

Browse files
authored
docs: update README.md features (#265)
* update features on README.md * simplify
1 parent 0c055ef commit 09bf25e

1 file changed

Lines changed: 8 additions & 4 deletions

File tree

README.md

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -58,6 +58,8 @@ Some examples of how Sequentia can be used on sequence data include:
5858

5959
- **Simplicity and interpretability**: Sequentia offers a limited set of machine learning algorithms, chosen specifically to be more interpretable and easier to configure than more complex alternatives such as recurrent neural networks and transformers, while maintaining a high level of effectiveness.
6060
- **Familiar and user-friendly**: To fit more seamlessly into the workflow of data science practitioners, Sequentia follows the ubiquitous Scikit-Learn API, providing a familiar model development process for many, as well as enabling wider access to the rapidly growing Scikit-Learn ecosystem.
61+
- **Speed**: Some algorithms offered by Sequentia naturally have restrictive runtime scaling, such as k-nearest neighbors. However, our implementation is
62+
optimized to the point of being multiple orders of magnitude faster than similar packages — see the [Benchmarks](#benchmarks) section for more information.
6163

6264
## Build Status
6365

@@ -82,7 +84,7 @@ effective inference algorithm.
8284
- [x] Sakoe–Chiba band global warping constraint
8385
- [x] Dependent and independent feature warping (DTWD/DTWI)
8486
- [x] Custom distance-weighted predictions
85-
- [x] Multi-processed predictions
87+
- [x] Multi-processed prediction
8688

8789
#### [Hidden Markov Models](https://sequentia.readthedocs.io/en/latest/sections/models/hmm/index.html) (via [`hmmlearn`](https://github.com/hmmlearn/hmmlearn))
8890

@@ -99,7 +101,7 @@ based on the provided training sequence data.
99101
- [x] Multivariate real-valued observations (modeled with Gaussian mixture emissions)
100102
- [x] Univariate categorical observations (modeled with discrete emissions)
101103
- [x] Linear, left-right and ergodic topologies
102-
- [x] Multi-processed predictions
104+
- [x] Multi-processed training and prediction
103105

104106
### Scikit-Learn compatibility
105107

@@ -157,7 +159,7 @@ All of the above libraries support multiprocessing, and prediction was performed
157159
<img src="benchmarks/benchmark.svg" width="100%"/>
158160

159161
> **Device information**:
160-
> - Product: ThinkPad T14s (Gen 6)
162+
> - Product: Lenovo ThinkPad T14s (Gen 6)
161163
> - Processor: AMD Ryzen™ AI 7 PRO 360 (8 cores, 16 threads, 2-5GHz)
162164
> - Memory: 64 GB LPDDR5X-7500MHz
163165
> - Solid State Drive: 1 TB SSD M.2 2280 PCIe Gen4 Performance TLC Opal
@@ -175,7 +177,7 @@ pip install sequentia
175177

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

178-
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.
180+
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 using k-NN based models with `use_c=True` results in a warning.
179181

180182
You can use the following to check if the appropriate C libraries are available.
181183

@@ -184,6 +186,8 @@ from dtaidistance import dtw
184186
dtw.try_import_c()
185187
```
186188

189+
If these libraries are unavailable, Sequentia will fall back to using a Python alternative.
190+
187191
### Development
188192

189193
Please see the [contribution guidelines](/CONTRIBUTING.md) to see installation instructions for contributing to Sequentia.

0 commit comments

Comments
 (0)