Skip to main content

Time series learning with Python.

Project description

Wildboar logo

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 WDTW FeatureTransform
RocketForestClassifier RocketForestRegressor MSM MatrixProfile
IntervalTreeClassifier IntervalTreeRegressor TWE Segmentation
IntervalForestClassifier IntervalForestRegressor LCSS Motif discovery
ProximityTreeClassifier ERP SAX
ProximityForestClassifier EDR PAA
MatrixProfileTransform

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 GNU/Linux and Python 3.8, 3.9, 3.10

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 fomatted using Black
  • add relevant tests
  • add relevant documentation

Source code

You can check the latest sources with the command:

git clone https://github.com/isaksamsten/wildboar

Documentation

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


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

wildboar-1.1.4.tar.gz (4.1 MB view hashes)

Uploaded Source

Built Distributions

wildboar-1.1.4-cp312-cp312-win_amd64.whl (1.2 MB view hashes)

Uploaded CPython 3.12 Windows x86-64

wildboar-1.1.4-cp312-cp312-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (8.0 MB view hashes)

Uploaded CPython 3.12 manylinux: glibc 2.17+ x86-64

wildboar-1.1.4-cp312-cp312-macosx_11_0_arm64.whl (3.2 MB view hashes)

Uploaded CPython 3.12 macOS 11.0+ ARM64

wildboar-1.1.4-cp312-cp312-macosx_10_9_x86_64.whl (3.3 MB view hashes)

Uploaded CPython 3.12 macOS 10.9+ x86-64

wildboar-1.1.4-cp312-cp312-macosx_10_9_universal2.whl (4.3 MB view hashes)

Uploaded CPython 3.12 macOS 10.9+ universal2 (ARM64, x86-64)

wildboar-1.1.4-cp311-cp311-win_amd64.whl (1.2 MB view hashes)

Uploaded CPython 3.11 Windows x86-64

wildboar-1.1.4-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (7.7 MB view hashes)

Uploaded CPython 3.11 manylinux: glibc 2.17+ x86-64

wildboar-1.1.4-cp311-cp311-macosx_11_0_arm64.whl (3.3 MB view hashes)

Uploaded CPython 3.11 macOS 11.0+ ARM64

wildboar-1.1.4-cp311-cp311-macosx_10_9_x86_64.whl (3.3 MB view hashes)

Uploaded CPython 3.11 macOS 10.9+ x86-64

wildboar-1.1.4-cp311-cp311-macosx_10_9_universal2.whl (4.3 MB view hashes)

Uploaded CPython 3.11 macOS 10.9+ universal2 (ARM64, x86-64)

wildboar-1.1.4-cp310-cp310-win_amd64.whl (1.2 MB view hashes)

Uploaded CPython 3.10 Windows x86-64

wildboar-1.1.4-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (7.3 MB view hashes)

Uploaded CPython 3.10 manylinux: glibc 2.17+ x86-64

wildboar-1.1.4-cp310-cp310-macosx_11_0_arm64.whl (3.3 MB view hashes)

Uploaded CPython 3.10 macOS 11.0+ ARM64

wildboar-1.1.4-cp310-cp310-macosx_10_9_x86_64.whl (3.3 MB view hashes)

Uploaded CPython 3.10 macOS 10.9+ x86-64

wildboar-1.1.4-cp310-cp310-macosx_10_9_universal2.whl (4.3 MB view hashes)

Uploaded CPython 3.10 macOS 10.9+ universal2 (ARM64, x86-64)

wildboar-1.1.4-cp39-cp39-win_amd64.whl (1.2 MB view hashes)

Uploaded CPython 3.9 Windows x86-64

wildboar-1.1.4-cp39-cp39-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (7.3 MB view hashes)

Uploaded CPython 3.9 manylinux: glibc 2.17+ x86-64

wildboar-1.1.4-cp39-cp39-macosx_11_0_arm64.whl (3.2 MB view hashes)

Uploaded CPython 3.9 macOS 11.0+ ARM64

wildboar-1.1.4-cp39-cp39-macosx_10_9_x86_64.whl (3.3 MB view hashes)

Uploaded CPython 3.9 macOS 10.9+ x86-64

wildboar-1.1.4-cp39-cp39-macosx_10_9_universal2.whl (4.3 MB view hashes)

Uploaded CPython 3.9 macOS 10.9+ universal2 (ARM64, x86-64)

wildboar-1.1.4-cp38-cp38-win_amd64.whl (1.2 MB view hashes)

Uploaded CPython 3.8 Windows x86-64

wildboar-1.1.4-cp38-cp38-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (7.5 MB view hashes)

Uploaded CPython 3.8 manylinux: glibc 2.17+ x86-64

wildboar-1.1.4-cp38-cp38-macosx_11_0_arm64.whl (3.3 MB view hashes)

Uploaded CPython 3.8 macOS 11.0+ ARM64

wildboar-1.1.4-cp38-cp38-macosx_10_9_x86_64.whl (3.3 MB view hashes)

Uploaded CPython 3.8 macOS 10.9+ x86-64

wildboar-1.1.4-cp38-cp38-macosx_10_9_universal2.whl (4.3 MB view hashes)

Uploaded CPython 3.8 macOS 10.9+ universal2 (ARM64, x86-64)

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page