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.0b6-cp312-cp312-win_amd64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | c59a420830718f77a145f541a8b8f5a0795e888d3515dafaedaf0a32d664571b |
|
MD5 | f584fc6544896d3faaa274450f09e178 |
|
BLAKE2b-256 | 7a6e7b7a2444e3ea8501c735ca3a90433eeb4432d2d4f7a0f6fe46dc9bb16797 |
Hashes for wildboar-1.2.0b6-cp312-cp312-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | ef2d504de0f76c50f38480c4bdd5d534805b6a759170a3b353561791b8f332c3 |
|
MD5 | e696918f9318b17e716b7721ff661e4f |
|
BLAKE2b-256 | 6bcfbdacf1574329264bc8e00f109e8a542d3812d58fd0e3f7f7d45f97903e79 |
Hashes for wildboar-1.2.0b6-cp312-cp312-macosx_11_0_arm64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 2e00b3785e99ac267a676211cb41d9b9b978c6550466bfa35b5d77c71a1305a5 |
|
MD5 | bbe6148a75ea5d44e26d5abcc8579171 |
|
BLAKE2b-256 | fe745f43c2c7417d1074aa50bbbb934caea5019b1b878237b4026cd874167043 |
Hashes for wildboar-1.2.0b6-cp312-cp312-macosx_10_9_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 55a412dd5d7539fff3b13d58ceec85ac092c4622c7266f3cba189ba92ea14932 |
|
MD5 | b66fb8a65d7a670a157dc6fd97a7f22b |
|
BLAKE2b-256 | 3b211e100c1be8786bf28810f1d53e10bfdbc75ada9b3c72acf781bdcb50f713 |
Hashes for wildboar-1.2.0b6-cp312-cp312-macosx_10_9_universal2.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | d5f0bf7fc2862eb6b295507f3395bedaf63abe2edb6fa0b7b643014c864dd05e |
|
MD5 | bae0866aef2184908c7180f0d8211646 |
|
BLAKE2b-256 | 909372d066d48ab9005ae37f08593bf3be23e673237e6ab7ff5fdc6cce45e4a1 |
Hashes for wildboar-1.2.0b6-cp311-cp311-win_amd64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 375271e1062c10c59f5a3d6ee6550cb0ed525785295081fb7302da0fd2f5cccd |
|
MD5 | c00b6577b7933482b17e1de82a234402 |
|
BLAKE2b-256 | de890dadd045714c083d2c9cbc77fd89402060a1cc27a58ad80baac6a5a5d2f6 |
Hashes for wildboar-1.2.0b6-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 463b90d5805ef50776ccd36ecb363938a9e220dfe7b09fee7688cc8035d32ca8 |
|
MD5 | d648f72a6f57fe02c70e6caaeff20194 |
|
BLAKE2b-256 | b04bc7cf744650acafce30867191e65c8fc274a08a81f72fea42e94f678221f3 |
Hashes for wildboar-1.2.0b6-cp311-cp311-macosx_11_0_arm64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | d8dfaf796a1cb40d56c030b79ecd02203edf3bc1c7dd68b7b359902f8abd8572 |
|
MD5 | 4900a2cfd32ec7c4464dd261aab4243a |
|
BLAKE2b-256 | e8bcacc4c16963ba955fc98603d03ef82dd3253cbe9c71da86aba5d23954f30e |
Hashes for wildboar-1.2.0b6-cp311-cp311-macosx_10_9_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | a1c82a5962abf6406ff3079e8f797b236a35f4791e3fd2787157d4977a7c6adb |
|
MD5 | b1332ed4a191d8139aed88e567f94743 |
|
BLAKE2b-256 | 730d04ce596b785dbaa406e2c769b556f152e14b6f7e3fe1f2eb21b6049dc505 |
Hashes for wildboar-1.2.0b6-cp311-cp311-macosx_10_9_universal2.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 0175a11e7c111a86fe1aee0a7c26fc7bb6831fb549493b98717742af98eaca22 |
|
MD5 | d2e4c1aa71a2b8f903a45ff87aa173ec |
|
BLAKE2b-256 | d1a629363f38767af9982c40d08fa06d9583c721138c89c8845daaf51af28a8e |
Hashes for wildboar-1.2.0b6-cp310-cp310-win_amd64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 76c8a968104981900199ea63a9fe812464c611ef8dad1f982da34fb7e7ecad6f |
|
MD5 | f7713c3c9fa72369c5fdb2151e7b7b91 |
|
BLAKE2b-256 | 3e360ae321882320533fd5584941207282d16bcc21391a6d119c80a33d6c725c |
Hashes for wildboar-1.2.0b6-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 22c0f2a5cb77b7b3f297362a9fee99c0e38cbd1d15a5dc182ce94b9ac8b9889b |
|
MD5 | 92e3236eb9ed31e0baa82477c5856f8a |
|
BLAKE2b-256 | 0ad026b38ca36cc0e2dab30a5e9e931ab2b9687a1d393837a8b361b8dbf9754a |
Hashes for wildboar-1.2.0b6-cp310-cp310-macosx_11_0_arm64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 04748d5346552f5a83b7fd574cf618924822b693b937614e4ef69b8914bba349 |
|
MD5 | b09ceebc3495118dbc547970c19e31d1 |
|
BLAKE2b-256 | cfa1797d7c0942854392a851dfa5df6d40b286d9ec7105085561bb0c6d69226b |
Hashes for wildboar-1.2.0b6-cp310-cp310-macosx_10_9_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 1487f99e72ba53cbddb5e3cc6aac3c0983959ee7184c2b362082a7a3ed3f0c77 |
|
MD5 | 429fb27f3972cdd9cef52e1952c362d5 |
|
BLAKE2b-256 | c8119d3b347ec5a3bb895d7625bdc9c3109bcee97b67f8b656e2ed9d56d7840e |
Hashes for wildboar-1.2.0b6-cp310-cp310-macosx_10_9_universal2.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 1ce0853633cd0a93fa4f9789030838e9e9408d2849f12e440e437cea2542c159 |
|
MD5 | b611e28dccb1f0fac94bf6606eed65c0 |
|
BLAKE2b-256 | 914ef3e5acc8af190d48d56587fca55e7e0822959e41f5d2a1416e17cc238048 |
Hashes for wildboar-1.2.0b6-cp39-cp39-win_amd64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | a3b0f56dbc4a16f4277853681906c725ce27cf81d2a1fbbef26ab250fd8ec86b |
|
MD5 | 3dc7a3b2d63e1e124ef6bbe17e4e96fb |
|
BLAKE2b-256 | 8d6e70eda27aa953256937141ef825c3b58b3f02cfc966a7df5a6df3124df8e7 |
Hashes for wildboar-1.2.0b6-cp39-cp39-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | a962932b5bac46b83442fbcefbb9c6ece8f5a105f66bd66c39e3a05bb0ca940b |
|
MD5 | f4670fdc91943ba381cc45c03844b00a |
|
BLAKE2b-256 | 9ad017a3a48e1b22bac9f1f469caa429b7b563bb41991c31d2e9f7f942968500 |
Hashes for wildboar-1.2.0b6-cp39-cp39-macosx_11_0_arm64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 869f4e75180b24ff2a9983e645472690c4adde7ac169dbef0fe5cf9b010a70fe |
|
MD5 | 3d477718ecc2ff175f3e7adc62f4e121 |
|
BLAKE2b-256 | 895bc5c1a6a01dfac69020a8ad6112b95e79896707791d4ed662faaa240c12ac |
Hashes for wildboar-1.2.0b6-cp39-cp39-macosx_10_9_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 1d1196de4405a2bdba682ea928be69e335c9e4d04aeb07686befabca9c5fa6dd |
|
MD5 | ec8b4ac2e185fe6aaf7189c0bf89ced1 |
|
BLAKE2b-256 | 9339343190a98eca063836537d702f668e98b2ff8a1eb8828c967cfcab132920 |
Hashes for wildboar-1.2.0b6-cp39-cp39-macosx_10_9_universal2.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 89f1551e5d4ebe541f0f1b42ad52d9a2dee10731df432ccc1509e0ffbaa96f38 |
|
MD5 | 9e105b641272f18f9ecaf6271b2269c6 |
|
BLAKE2b-256 | 8437033decfffe763ac28a344bfe055d22954cd5f4a71477d0b145f663284968 |