Skip to main content

A unified Python toolbox for machine learning with time series

Project description

Welcome to sktime

A unified interface for machine learning with time series

:rocket: Version 0.8.0 out now! Check out the release notes here.

sktime is a library for time series analysis in Python. It provides a unified interface for multiple time series learning tasks. Currently, this includes time series classification, regression, clustering, annotation and forecasting. It comes with time series algorithms and scikit-learn compatible tools to build, tune and validate time series models.

Overview
CI/CD github-actions !appveyor !azure-devops !codecov readthedocs
Code !pypi !conda !python-versions !black Binder
Downloads Downloads Downloads Downloads
Community !slack !discord !gitter !twitter !youtube
Citation !zenodo

:books: Documentation

Documentation
:star: Tutorials New to sktime? Here's everything you need to know!
:clipboard: Binder Notebooks Example notebooks to play with in your browser.
:woman_technologist: User Guides How to use sktime and its features.
:scissors: Extension Templates How to build your own estimator using sktime's API.
:control_knobs: API Reference The detailed reference for sktime's API.
:tv: Video Tutorial Our video tutorial from the 2020 PyData Festival.
:hammer_and_wrench: Changelog Changes and version history.
:deciduous_tree: Roadmap sktime's software and community development plan.
:pencil: Related Software A list of related software.

:speech_balloon: Where to ask questions

Questions and feedback are extremely welcome! Please understand that we won't be able to provide individual support via email. We also believe that help is much more valuable if it's shared publicly, so that more people can benefit from it.

Type Platforms
:bug: Bug Reports GitHub Issue Tracker
:sparkles: Feature Requests & Ideas GitHub Issue Tracker
:woman_technologist: Usage Questions GitHub Discussions · Stack Overflow
:speech_balloon: General Discussion GitHub Discussions · Gitter · Discord

:dizzy: Features

Our aim is to make the time series analysis ecosystem more interoperable and usable as a whole. sktime provides a unified interface for distinct but related time series learning tasks. It features dedicated time series algorithms and tools for composite model building including pipelining, ensembling, tuning and reduction that enables users to apply an algorithm for one task to another.

sktime also provides interfaces to related libraries, for example scikit-learn, statsmodels, tsfresh, PyOD and fbprophet, among others.

For deep learning, see our companion package: sktime-dl.

Module Status Links
Forecasting stable Tutorial · API Reference · Extension Template
Time Series Classification stable Tutorial · API Reference · Extension Template
Time Series Regression stable API Reference
Transformations maturing API Reference
Time Series Clustering experimental Extension Template
Time Series Distances/Kernels experimental Extension Template
Annotation experimental Extension Template

:hourglass_flowing_sand: Install sktime

For trouble shooting and detailed installation instructions, see the documentation.

  • Operating system: macOS X · Linux · Windows 8.1 or higher
  • Python version: Python 3.6, 3.7 and 3.8 (only 64 bit)
  • Package managers: pip · conda (via conda-forge)

pip

Using pip, sktime releases are available as source packages and binary wheels. You can see all available wheels here.

pip install sktime

or, with maximum dependencies,

pip install sktime[all_extras]

conda

You can also install sktime from conda via the conda-forge channel. For the feedstock including the build recipe and configuration, check out this repository.

conda install -c conda-forge sktime

or, with maximum dependencies,

conda install -c conda-forge sktime-all-extras

:zap: Quickstart

Forecasting

from sktime.datasets import load_airline
from sktime.forecasting.base import ForecastingHorizon
from sktime.forecasting.model_selection import temporal_train_test_split
from sktime.forecasting.theta import ThetaForecaster
from sktime.performance_metrics.forecasting import mean_absolute_percentage_error

y = load_airline()
y_train, y_test = temporal_train_test_split(y)
fh = ForecastingHorizon(y_test.index, is_relative=False)
forecaster = ThetaForecaster(sp=12)  # monthly seasonal periodicity
forecaster.fit(y_train)
y_pred = forecaster.predict(fh)
mean_absolute_percentage_error(y_test, y_pred)
>>> 0.08661467738190656

Time Series Classification

from sktime.classification.interval_based import TimeSeriesForestClassifier
from sktime.datasets import load_arrow_head
from sklearn.model_selection import train_test_split
from sklearn.metrics import accuracy_score

X, y = load_arrow_head(return_X_y=True)
X_train, X_test, y_train, y_test = train_test_split(X, y)
classifier = TimeSeriesForestClassifier()
classifier.fit(X_train, y_train)
y_pred = classifier.predict(X_test)
accuracy_score(y_test, y_pred)
>>> 0.8679245283018868

:wave: How to get involved

There are many ways to join the sktime community. We follow the all-contributors specification: all kinds of contributions are welcome - not just code.

Documentation
:gift_heart: Contribute How to contribute to sktime.
:school_satchel: Mentoring New to open source? Apply to our mentoring program!
:date: Meetings Join our discussions, tutorials, workshops and sprints!
:woman_mechanic: Developer Guides How to further develop sktime's code base.
:construction: Enhancement Proposals Design a new feature for sktime.
:medal_sports: Contributors A list of all contributors.
:raising_hand: Roles An overview of our core community roles.
:money_with_wings: Donate Fund sktime maintenance and development.
:classical_building: Governance How and by whom decisions are made in sktime's community.

:bulb: Project vision

  • by the community, for the community -- developed by a friendly and collaborative community.
  • the right tool for the right task -- helping users to diagnose their learning problem and suitable scientific model types.
  • embedded in state-of-art ecosystems and provider of interoperable interfaces -- interoperable with scikit-learn, statsmodels, tsfresh, and other community favourites.
  • rich model composition and reduction functionality -- build tuning and feature extraction pipelines, solve forecasting tasks with scikit-learn regressors.
  • clean, descriptive specification syntax -- based on modern object-oriented design principles for data science.
  • fair model assessment and benchmarking -- build your models, inspect your models, check your models, avoid pitfalls.
  • easily extensible -- easy extension templates to add your own algorithms compatible with sktime's API.

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

sktime-0.8.1.tar.gz (11.1 MB view details)

Uploaded Source

Built Distributions

sktime-0.8.1-cp39-cp39-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (6.2 MB view details)

Uploaded CPython 3.9 manylinux: glibc 2.17+ x86-64

sktime-0.8.1-cp39-cp39-macosx_10_15_x86_64.whl (4.8 MB view details)

Uploaded CPython 3.9 macOS 10.15+ x86-64

sktime-0.8.1-cp38-cp38-win_amd64.whl (4.8 MB view details)

Uploaded CPython 3.8 Windows x86-64

sktime-0.8.1-cp38-cp38-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (6.2 MB view details)

Uploaded CPython 3.8 manylinux: glibc 2.17+ x86-64

sktime-0.8.1-cp38-cp38-macosx_10_15_x86_64.whl (4.8 MB view details)

Uploaded CPython 3.8 macOS 10.15+ x86-64

sktime-0.8.1-cp37-cp37m-win_amd64.whl (4.8 MB view details)

Uploaded CPython 3.7m Windows x86-64

sktime-0.8.1-cp37-cp37m-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (6.1 MB view details)

Uploaded CPython 3.7m manylinux: glibc 2.17+ x86-64

sktime-0.8.1-cp37-cp37m-macosx_10_15_x86_64.whl (4.8 MB view details)

Uploaded CPython 3.7m macOS 10.15+ x86-64

sktime-0.8.1-cp36-cp36m-win_amd64.whl (4.8 MB view details)

Uploaded CPython 3.6m Windows x86-64

sktime-0.8.1-cp36-cp36m-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (6.1 MB view details)

Uploaded CPython 3.6m manylinux: glibc 2.17+ x86-64

sktime-0.8.1-cp36-cp36m-macosx_10_15_x86_64.whl (4.8 MB view details)

Uploaded CPython 3.6m macOS 10.15+ x86-64

File details

Details for the file sktime-0.8.1.tar.gz.

File metadata

  • Download URL: sktime-0.8.1.tar.gz
  • Upload date:
  • Size: 11.1 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.2 importlib_metadata/4.8.1 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.7.12

File hashes

Hashes for sktime-0.8.1.tar.gz
Algorithm Hash digest
SHA256 91068186335cdd19494c96de1506b826400b9d707de7cee86f4169e7018e8906
MD5 2cc44681bfb2c170df9ce6763c358795
BLAKE2b-256 143c02b40dd3133f7607421dcc3c5b44747f5bc0f6af14cc7a14e83b686f1ed1

See more details on using hashes here.

File details

Details for the file sktime-0.8.1-cp39-cp39-manylinux_2_17_x86_64.manylinux2014_x86_64.whl.

File metadata

File hashes

Hashes for sktime-0.8.1-cp39-cp39-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm Hash digest
SHA256 9c4067b8c28f64472bcb0a52d9378f9ec72dddd8cdfbace24c18188c2b662562
MD5 5425a03741aeab2c8d071e2020769e98
BLAKE2b-256 c54de3ad1c8487dbcbb587a66267542f92bf8c2bb850a3d4a497612ea1f93ae8

See more details on using hashes here.

File details

Details for the file sktime-0.8.1-cp39-cp39-macosx_10_15_x86_64.whl.

File metadata

  • Download URL: sktime-0.8.1-cp39-cp39-macosx_10_15_x86_64.whl
  • Upload date:
  • Size: 4.8 MB
  • Tags: CPython 3.9, macOS 10.15+ x86-64
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.2 importlib_metadata/4.8.1 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.9.7

File hashes

Hashes for sktime-0.8.1-cp39-cp39-macosx_10_15_x86_64.whl
Algorithm Hash digest
SHA256 0f62077a1a1acd00db60af469a15231f71fe6cdcd21311aeb866a145300960df
MD5 f616282b99e6c4b320c90d58deaad47a
BLAKE2b-256 5075a281ffbbf279a11213d500452e650da5a7d67f7f17f328d90acc450ec031

See more details on using hashes here.

File details

Details for the file sktime-0.8.1-cp38-cp38-win_amd64.whl.

File metadata

  • Download URL: sktime-0.8.1-cp38-cp38-win_amd64.whl
  • Upload date:
  • Size: 4.8 MB
  • Tags: CPython 3.8, Windows x86-64
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.2 importlib_metadata/4.8.1 pkginfo/1.7.1 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.8.10

File hashes

Hashes for sktime-0.8.1-cp38-cp38-win_amd64.whl
Algorithm Hash digest
SHA256 d7df7b2d8db373ddfaf0c7814f4b27f4f32e3b5d9d624628f09439d1cd4025cf
MD5 13549add0249b9a268b03b4a4e40ba79
BLAKE2b-256 f5b65fc83b126e8f4ad901f4584004a63b43be3dad51eaacced66fb64bca9f25

See more details on using hashes here.

File details

Details for the file sktime-0.8.1-cp38-cp38-manylinux_2_17_x86_64.manylinux2014_x86_64.whl.

File metadata

File hashes

Hashes for sktime-0.8.1-cp38-cp38-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm Hash digest
SHA256 8feb9ef97974e3d2bf57a48983e400b3f97b8473bab3d21d3f75ab115d77f4a8
MD5 47c0912b4129436bd89cc394e12c5689
BLAKE2b-256 b99eb8c46d8174148165d1713d8c87fac944670e743d891b05ceb869f3535e69

See more details on using hashes here.

File details

Details for the file sktime-0.8.1-cp38-cp38-macosx_10_15_x86_64.whl.

File metadata

  • Download URL: sktime-0.8.1-cp38-cp38-macosx_10_15_x86_64.whl
  • Upload date:
  • Size: 4.8 MB
  • Tags: CPython 3.8, macOS 10.15+ x86-64
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.2 importlib_metadata/4.8.1 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.8.12

File hashes

Hashes for sktime-0.8.1-cp38-cp38-macosx_10_15_x86_64.whl
Algorithm Hash digest
SHA256 b2efcbf4c44fb9276ddee0373ef5367b45b92a8948095e96eb104435e1190502
MD5 341a01a70ecab0fa69f89bfda3110878
BLAKE2b-256 527b27935144ead73bc10cc179686b1e47995a16f07a7bda99abc8b773075bc8

See more details on using hashes here.

File details

Details for the file sktime-0.8.1-cp37-cp37m-win_amd64.whl.

File metadata

  • Download URL: sktime-0.8.1-cp37-cp37m-win_amd64.whl
  • Upload date:
  • Size: 4.8 MB
  • Tags: CPython 3.7m, Windows x86-64
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.2 importlib_metadata/4.8.1 pkginfo/1.7.1 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.7.11

File hashes

Hashes for sktime-0.8.1-cp37-cp37m-win_amd64.whl
Algorithm Hash digest
SHA256 80c6b2dc045e893f6231818ab5dff173d84a177971f6bfad097dc3b0d4fdcbc2
MD5 61f61eabd28e28f1ab8f6288b1a54c13
BLAKE2b-256 b5aeb874a082ca360d6d134cde4968ecd78b2dd5f47588d59d062d308d9ede0b

See more details on using hashes here.

File details

Details for the file sktime-0.8.1-cp37-cp37m-manylinux_2_17_x86_64.manylinux2014_x86_64.whl.

File metadata

File hashes

Hashes for sktime-0.8.1-cp37-cp37m-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm Hash digest
SHA256 ec70c6cbe43d1c67c44469f3ba6bc018e2b8b2fb3936a15a718418519c98a6dc
MD5 abdb1bdd9b5ef712418964955811d291
BLAKE2b-256 f4337e996560d9cf274bf14c18b97766287939148c1b8648a76fd570ee494125

See more details on using hashes here.

File details

Details for the file sktime-0.8.1-cp37-cp37m-macosx_10_15_x86_64.whl.

File metadata

  • Download URL: sktime-0.8.1-cp37-cp37m-macosx_10_15_x86_64.whl
  • Upload date:
  • Size: 4.8 MB
  • Tags: CPython 3.7m, macOS 10.15+ x86-64
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.2 importlib_metadata/4.8.1 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.7.12

File hashes

Hashes for sktime-0.8.1-cp37-cp37m-macosx_10_15_x86_64.whl
Algorithm Hash digest
SHA256 40bcc9413db633e4b20db87069259751127a52f87b8f3a76056b60028d44aa44
MD5 89c675ec38f36dfb24c7ec946565b413
BLAKE2b-256 b9aa99aea42bef42d29d38fc8f7715f9e9e14e9627d055ee3f81c3d4ec7e8e0c

See more details on using hashes here.

File details

Details for the file sktime-0.8.1-cp36-cp36m-win_amd64.whl.

File metadata

  • Download URL: sktime-0.8.1-cp36-cp36m-win_amd64.whl
  • Upload date:
  • Size: 4.8 MB
  • Tags: CPython 3.6m, Windows x86-64
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.2 importlib_metadata/4.8.1 pkginfo/1.7.1 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.6.13

File hashes

Hashes for sktime-0.8.1-cp36-cp36m-win_amd64.whl
Algorithm Hash digest
SHA256 d61b9529193e53e244027971d00eb7040ce0b64402ee10fa5662fd64a31be5e1
MD5 827add1219bb307a565c521bba9293a6
BLAKE2b-256 7dacfc463bf34c2166c4e16d46e1ef3cfe44d83fb1835fbe5106f447595d13ad

See more details on using hashes here.

File details

Details for the file sktime-0.8.1-cp36-cp36m-manylinux_2_17_x86_64.manylinux2014_x86_64.whl.

File metadata

File hashes

Hashes for sktime-0.8.1-cp36-cp36m-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm Hash digest
SHA256 04544291a8765731335895ba35dd65955a1d0f15b4158da8e18b0b19ec94f2e4
MD5 ec25f2cda62f7fe48d8203fb4424a605
BLAKE2b-256 e8bd5f50e00d7bb7359077df58aea0817e90a524a3a1310f4f310407105613b0

See more details on using hashes here.

File details

Details for the file sktime-0.8.1-cp36-cp36m-macosx_10_15_x86_64.whl.

File metadata

  • Download URL: sktime-0.8.1-cp36-cp36m-macosx_10_15_x86_64.whl
  • Upload date:
  • Size: 4.8 MB
  • Tags: CPython 3.6m, macOS 10.15+ x86-64
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.2 importlib_metadata/4.8.1 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.6.15

File hashes

Hashes for sktime-0.8.1-cp36-cp36m-macosx_10_15_x86_64.whl
Algorithm Hash digest
SHA256 ab5a06aa6be08b6d54c53785e69243c9fbdfbac3954dbe9efc852b4e948473e5
MD5 2866d1d1a79848d25358f2f3e856cae8
BLAKE2b-256 cc2ac85ac142331970c8be2ac6702e303f722ee3c7a5c32965fda13c0dd1099e

See more details on using hashes here.

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