Time series learning with Python.
Project description
wildboar
wildboar is a Python module for temporal machine learning and fast distance computations built on top of scikit-learn and numpy distributed under the BSD 3-Clause license.
It is currently maintained by Isak Samsten
Features
Data | Classification | Regression | Explainability | Metric | Unsupervised | Outlier |
---|---|---|---|---|---|---|
Repositories | ShapeletForestClassifier |
ShapeletForestRegressor |
ShapeletForestCounterfactual |
UCR-suite | ShapeletForestTransform |
IsolationShapeletForest |
Classification (wildboar/ucr ) |
ExtraShapeletTreesClassifier |
ExtraShapeletTreesRegressor |
KNearestCounterfactual |
MASS | RandomShapeletEmbedding |
|
Regression (wildboar/tsereg ) |
RocketTreeClassifier |
RocketRegressor |
PrototypeCounterfactual |
DTW | RocketTransform |
|
Outlier detection (wildboar/outlier:easy ) |
RocketClassifier |
RandomShapeletRegressor |
IntervalImportance |
DDTW | IntervalTransform |
|
RandomShapeletClassifier |
RocketTreeRegressor |
ShapeletImportance |
WDTW | FeatureTransform |
||
RocketForestClassifier |
RocketForestRegressor |
MSM | MatrixProfileTransform |
|||
IntervalTreeClassifier |
IntervalTreeRegressor |
TWE | Segmentation | |||
IntervalForestClassifier |
IntervalForestRegressor |
LCSS | Motif discovery | |||
ProximityTreeClassifier |
ERP | SAX |
||||
ProximityForestClassifier |
EDR | PAA |
||||
HydraClassifier |
ADTW | MatrixProfileTransform |
||||
KNeighborsClassifier |
HydraTransform |
|||||
ElasticEnsembleClassifier |
KMeans with (W)DTW support |
|||||
DilatedShapeletClassifier |
KMedoids |
|||||
DilatedShapeletTransform |
See the documentation for examples.
Installation
Binaries
wildboar
is available through pip
and can be installed with:
pip install wildboar
Universal binaries are compiled for Python 3.8, 3.9, 3.10 and 3.11 running on GNU/Linux, Windows and macOS.
Compilation
If you already have a working installation of numpy, scikit-learn, scipy and cython, compiling and installing wildboar is as simple as:
pip install .
To install the requirements, use:
pip install -r requirements.txt
For complete instructions see the documentation
Usage
from wildboar.ensemble import ShapeletForestClassifier
from wildboar.datasets import load_dataset
x_train, x_test, y_train, y_test = load_dataset("GunPoint", merge_train_test=False)
c = ShapeletForestClassifier()
c.fit(x_train, y_train)
c.score(x_test, y_test)
The User guide includes more detailed usage instructions.
Changelog
The changelog records a
history of notable changes to wildboar
.
Development
Contributions are welcome! The developer's guide has detailed information about contributing code and more!
In short, pull requests should:
- be well motivated
- be formatted using Black
- add relevant tests
- add relevant documentation
Source code
You can check the latest sources with the command:
git clone https://github.com/wildboar-foundation/wildboar
Documentation
- HTML documentation: https://wildboar.dev
Citation
If you use wildboar
in a scientific publication, I would appreciate
citations to the paper:
-
Karlsson, I., Papapetrou, P. Boström, H., 2016. Generalized Random Shapelet Forests. In the Data Mining and Knowledge Discovery Journal
ShapeletForestClassifier
-
Isak Samsten, 2020. isaksamsten/wildboar: wildboar. Zenodo. doi:10.5281/zenodo.4264063
-
Karlsson, I., Rebane, J., Papapetrou, P. et al. Locally and globally explainable time series tweaking. Knowl Inf Syst 62, 1671–1700 (2020)
ShapeletForestCounterfactual
KNearestCounterfactual
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distributions
Hashes for wildboar-1.2.0b5-cp312-cp312-win_amd64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 91639c45807b2f957a4e68566c35b7c2cb4b263b6f4ab63de1f8c5517463fb82 |
|
MD5 | 00cba703c6e78abac53b1fbc3f71f8e1 |
|
BLAKE2b-256 | 72a611a5faac9df60a6daff42b4eb1cf21f3452a6e47df333b536c92f27e8c48 |
Hashes for wildboar-1.2.0b5-cp312-cp312-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | fbe05ab698a34cba1476878a7c81e2820681e6d1bcb80f795839090b9883782f |
|
MD5 | 2e059364e2cd343b5425ceb291d90fcf |
|
BLAKE2b-256 | 22ebfbfbb197229be696aea20fd25589b911f52eda5be5e9a27ab33808f0f047 |
Hashes for wildboar-1.2.0b5-cp312-cp312-macosx_11_0_arm64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 79564d66da6059bfd5a9e1aba7faad08e929f15a541e63d2f2208175c721185d |
|
MD5 | 83961e4e91c83b51dfed9b13f85eeda5 |
|
BLAKE2b-256 | e20e70c53f9c80a19c8fa81fd02d7d20c515900dde6d48497436c2c27637e4d5 |
Hashes for wildboar-1.2.0b5-cp312-cp312-macosx_10_9_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | cb0503ffd21ad01adcef4fd0edbf3d2e9dc4d02205dcac7b97147c2bbab736be |
|
MD5 | 338b813f24d31c59d359fb3cc88efd74 |
|
BLAKE2b-256 | 3f1ce40122d1d8bc34996c2bc13675339d5d0f730fa740bbabf1f8eb36d45a36 |
Hashes for wildboar-1.2.0b5-cp312-cp312-macosx_10_9_universal2.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 329d82af1d9be3e70b17e6881114326727f2a7137ba835bd8d91f8b1d745e6fd |
|
MD5 | b5661683f6b222e2808fe61fe76b1023 |
|
BLAKE2b-256 | 03568cc7ed7a7f0bb3f6f84ac24e0a01c453e837bea274b53288915617e615e8 |
Hashes for wildboar-1.2.0b5-cp311-cp311-win_amd64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 827d0448ab0fcd94ed7485aa6c7d34e1edef9c29065804e6e577ba9066152726 |
|
MD5 | 1424ef5ba0dfd1b6b117760c22e12376 |
|
BLAKE2b-256 | 82da70c90047689927307fc30cf63ea944d11bb004d49a5cde85e633c657430e |
Hashes for wildboar-1.2.0b5-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 1b99a9608a11a410a3716f1692786245f804299ea07954652aa7d43dce5d2f53 |
|
MD5 | f5b23ca2578634372e46fbad86c2dda2 |
|
BLAKE2b-256 | a2612e4ccdf1eaf63d3b16c20a3c250eb3e3963cf9bb57778649369669fd35ed |
Hashes for wildboar-1.2.0b5-cp311-cp311-macosx_11_0_arm64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 71c1e5c001e800a6e6a6998a5db17f3cb458666e6d666f232dc267de657d87dc |
|
MD5 | 48bdf1f2618507de1acbe21b0c0ac25c |
|
BLAKE2b-256 | 9c1173625fcb2f7bc05985a40667f9d22087712eebf8e7f7167561a84d3792f8 |
Hashes for wildboar-1.2.0b5-cp311-cp311-macosx_10_9_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | aa280bfdf831ee33705a81293f9ed03ca3f24b46cdfe3e415357ffa48cdff898 |
|
MD5 | 9d5020295bffad6b8f2ce605bee31773 |
|
BLAKE2b-256 | 35b5f2eee9f5732b438ca118281367226ae12daeccb8d4966ed2784a38c9f011 |
Hashes for wildboar-1.2.0b5-cp311-cp311-macosx_10_9_universal2.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 1964f7313bc1d53773a2315b404bba121e9c7591f7b8222d18bd6822ab0cf48b |
|
MD5 | 556be290e7f54b1aa7b25ca97ef9384e |
|
BLAKE2b-256 | 6fcc514d463da4d25c221fea6486e82a33b72d4b454af7b4c49e8d937a5342dc |
Hashes for wildboar-1.2.0b5-cp310-cp310-win_amd64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 59e8b74be8931070e5e61994cf442bdea6fee8dfe9f78bcf810e67dc02c39da7 |
|
MD5 | 68e762ceab1d7581d4324be31eb3e8c8 |
|
BLAKE2b-256 | 15734c6dd1b2a13fbfd05442729e58f6ac55d3dc6f7ce276820dcc42fdac515e |
Hashes for wildboar-1.2.0b5-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | ff4fda74c449baf83e85b0d37db73a90141c0e2836f4150a309cffdf568b8ada |
|
MD5 | d4a4cfbba738622b5b03c838a891532f |
|
BLAKE2b-256 | d558f0f4b6e134d232c36c79f4499036bbd9a37c6108ab1657136e5a13ead281 |
Hashes for wildboar-1.2.0b5-cp310-cp310-macosx_11_0_arm64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 32ecaf5a3853e9b24e4d606c627b407dd78d76f634f0f77338512229c1573e95 |
|
MD5 | dca4a13843340570ab9c492b211a1908 |
|
BLAKE2b-256 | c019b9938fcee943665fbc98ee3ffe478f32656cb8637f588fd5036a01b94339 |
Hashes for wildboar-1.2.0b5-cp310-cp310-macosx_10_9_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 69241f51b5029e5ceba8dab63e68cf48180c3385f937567f0718befb7e89736b |
|
MD5 | 88f1dcd17da736ff034275856e3803d4 |
|
BLAKE2b-256 | 7a35cc154ddbeb26ef371bfdf3101a89e45f8508e3fef0ffface4436bea8967e |
Hashes for wildboar-1.2.0b5-cp310-cp310-macosx_10_9_universal2.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | d0de58d9aa9b2a78560a4b348f866f53d32951749f8230def0e7fc02e1cf1d37 |
|
MD5 | 67b48c225619008000d41b76002b8702 |
|
BLAKE2b-256 | 062e796f95deed8749cdb1b8aea8f6c31024047d87ccd488812443a64353c4a9 |
Hashes for wildboar-1.2.0b5-cp39-cp39-win_amd64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 4d8ce5daf0ed31edf4f52cce8c251d8bcf259350990dcd16e849dfdded669a6b |
|
MD5 | 3f53a1286e1435c5cd1e2e3160487051 |
|
BLAKE2b-256 | cc1180018bc59696ede2f6aec94a71978aace39f84f43763cfa483470243cb3b |
Hashes for wildboar-1.2.0b5-cp39-cp39-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 0f3fcb5bcdfc96c5c6caeeeb8bc182f78d240434a18ec7ec5b7e34b769a885db |
|
MD5 | 47b963ce6740cead63d2f3bdf08935c3 |
|
BLAKE2b-256 | 25d85bc23b434f653402cb6b229aecb91fdc9cc6c59275e5f42295cd9bed9401 |
Hashes for wildboar-1.2.0b5-cp39-cp39-macosx_11_0_arm64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | ca5be0665f452d53eca26c592bd98555d59c52631ce9161eb13ade68e66a611d |
|
MD5 | 1e0897bead8bc100129ce50fa28dad28 |
|
BLAKE2b-256 | 243ca32bbde46e97808a0e43817541ac0d84ec389ddc8d446c95e0b093d63d7a |
Hashes for wildboar-1.2.0b5-cp39-cp39-macosx_10_9_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 10116542a71e3f6e04e9cc7642fccbbf0623f93b59d3e6dad921c74c0ad6b159 |
|
MD5 | 04f8dae684b1941e33fe4abef6a24cae |
|
BLAKE2b-256 | d865023237ea0f33f0ce15018b339d8ed49943f3ac6a5b38b56f949cb8d92b09 |
Hashes for wildboar-1.2.0b5-cp39-cp39-macosx_10_9_universal2.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 7b22e8da63c1058433829d596b7c63706d53c02f44ade9332f52fc10189d2580 |
|
MD5 | b878c2354a79a55d27dbadea06918286 |
|
BLAKE2b-256 | b8e52b4a70926c70d8f3d14236e65b4d08da823f160a0437c200570697c956ab |