{"author":"Romain Tavenard","author_email":"romain.tavenard@univ-rennes2.fr","bugtrack_url":null,"classifiers":["License :: OSI Approved :: BSD License"],"description":"\n

tslearn

\n\n\n

\n The machine learning toolkit for time series analysis in Python\n

\n\n\n

\n \n $\"PyPI\"$ \n \n \n $\"Documentation\"$ \n \n \n $\"Build$ \n \n \n $\"Codecov\"$ \n \n \n $\"Downloads\"$ \n \n

\n\n\n

\n\n\n\n| Section | Description |\n|-|-|\n| [Installation](#installation) | Installing the dependencies and tslearn |\n| [Getting started](#getting-started) | A quick introduction on how to use tslearn |\n| [Available features](#available-features) | An extensive overview of tslearn's functionalities |\n| [Documentation](#documentation) | A link to our API reference and a gallery of examples |\n| [Contributing](#contributing) | A guide for heroes willing to contribute |\n| [Citation](#referencing-tslearn) | A citation for tslearn for scholarly articles |\n\n## Installation\nThere are different alternatives to install tslearn:\n* PyPi: `python -m pip install tslearn`\n* Conda: `conda install -c conda-forge tslearn`\n* Git: `python -m pip install https://github.com/tslearn-team/tslearn/archive/main.zip`\n\nIn order for the installation to be successful, the required dependencies must be installed. For a more detailed guide on how to install tslearn, please see the [Documentation](https://tslearn.readthedocs.io/en/stable/?badge=stable#installation).\n\n## Getting started\n\n### 1. Getting the data in the right format\ntslearn expects a time series dataset to be formatted as a 3D `numpy` array. The three dimensions correspond to the number of time series, the number of measurements per time series and the number of dimensions respectively (`n_ts, max_sz, d`). In order to get the data in the right format, different solutions exist:\n* [You can use the utility functions such as `to_time_series_dataset`.](https://tslearn.readthedocs.io/en/stable/gen_modules/tslearn.utils.html#module-tslearn.utils)\n* [You can convert from other popular time series toolkits in Python.](https://tslearn.readthedocs.io/en/stable/integration_other_software.html)\n* [You can load any of the UCR datasets in the required format.](https://tslearn.readthedocs.io/en/stable/gen_modules/tslearn.datasets.html#module-tslearn.datasets)\n* [You can generate synthetic data using the `generators` module.](https://tslearn.readthedocs.io/en/stable/gen_modules/tslearn.generators.html#module-tslearn.generators)\n\nIt should further be noted that tslearn [supports variable-length timeseries](https://tslearn.readthedocs.io/en/stable/variablelength.html).\n\n```python3\n>>> from tslearn.utils import to_time_series_dataset\n>>> my_first_time_series = [1, 3, 4, 2]\n>>> my_second_time_series = [1, 2, 4, 2]\n>>> my_third_time_series = [1, 2, 4, 2, 2]\n>>> X = to_time_series_dataset([my_first_time_series,\n my_second_time_series,\n my_third_time_series])\n>>> y = [0, 1, 1]\n```\n\n### 2. Data preprocessing and transformations\nOptionally, tslearn has several utilities to preprocess the data. In order to facilitate the convergence of different algorithms, you can [scale time series](https://tslearn.readthedocs.io/en/stable/gen_modules/tslearn.preprocessing.html#module-tslearn.preprocessing). Alternatively, in order to speed up training times, one can [resample](https://tslearn.readthedocs.io/en/stable/gen_modules/preprocessing/tslearn.preprocessing.TimeSeriesResampler.html#tslearn.preprocessing.TimeSeriesResampler) the data or apply a [piece-wise transformation](https://tslearn.readthedocs.io/en/stable/gen_modules/tslearn.piecewise.html#module-tslearn.piecewise).\n\n```python3\n>>> from tslearn.preprocessing import TimeSeriesScalerMinMax\n>>> X_scaled = TimeSeriesScalerMinMax().fit_transform(X)\n>>> print(X_scaled)\n[[[0.] [0.667] [1.] [0.333] [nan]]\n [[0.] [0.333] [1.] [0.333] [nan]]\n [[0.] [0.333] [1.] [0.333] [0.333]]]\n```\n\n### 3. Training a model\n\nAfter getting the data in the right format, a model can be trained. Depending on the use case, tslearn supports different tasks: classification, clustering and regression. For an extensive overview of possibilities, check out our [gallery of examples](https://tslearn.readthedocs.io/en/stable/auto_examples/index.html).\n\n```python3\n>>> from tslearn.neighbors import KNeighborsTimeSeriesClassifier\n>>> knn = KNeighborsTimeSeriesClassifier(n_neighbors=1)\n>>> knn.fit(X_scaled, y)\n>>> print(knn.predict(X_scaled))\n[0 1 1]\n```\n\nAs can be seen, the models in tslearn follow the same API as those of the well-known scikit-learn. Moreover, they are fully compatible with it, allowing to use different scikit-learn utilities such as [hyper-parameter tuning and pipelines](https://tslearn.readthedocs.io/en/stable/auto_examples/neighbors/plot_knnts_sklearn.html).\n\n### 4. More analyses\n\ntslearn further allows to perform all different types of analysis. Examples include [calculating barycenters](https://tslearn.readthedocs.io/en/stable/gen_modules/tslearn.barycenters.html#module-tslearn.barycenters) of a group of time series or calculate the distances between time series using a [variety of distance metrics](https://tslearn.readthedocs.io/en/stable/gen_modules/tslearn.metrics.html#module-tslearn.metrics).\n\n## Available features\n\n| data | processing | clustering | classification | regression | metrics |\n|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------|\n| [UCR Datasets](https://tslearn.readthedocs.io/en/stable/gen_modules/tslearn.datasets.html#module-tslearn.datasets) | [Scaling](https://tslearn.readthedocs.io/en/stable/gen_modules/tslearn.preprocessing.html#module-tslearn.preprocessing) | [TimeSeriesKMeans](https://tslearn.readthedocs.io/en/stable/gen_modules/clustering/tslearn.clustering.TimeSeriesKMeans.html#tslearn.clustering.TimeSeriesKMeans) | [KNN Classifier](https://tslearn.readthedocs.io/en/stable/gen_modules/neighbors/tslearn.neighbors.KNeighborsTimeSeriesClassifier.html#tslearn.neighbors.KNeighborsTimeSeriesClassifier) | [KNN Regressor](https://tslearn.readthedocs.io/en/stable/gen_modules/neighbors/tslearn.neighbors.KNeighborsTimeSeriesRegressor.html#tslearn.neighbors.KNeighborsTimeSeriesRegressor) | [Dynamic Time Warping](https://tslearn.readthedocs.io/en/stable/gen_modules/metrics/tslearn.metrics.dtw.html#tslearn.metrics.dtw) |\n| [Generators](https://tslearn.readthedocs.io/en/stable/gen_modules/tslearn.generators.html#module-tslearn.generators) | [Piecewise](https://tslearn.readthedocs.io/en/stable/gen_modules/tslearn.piecewise.html#module-tslearn.piecewise) | [KShape](https://tslearn.readthedocs.io/en/stable/gen_modules/clustering/tslearn.clustering.KShape.html#tslearn.clustering.KShape) | [TimeSeriesSVC](https://tslearn.readthedocs.io/en/stable/gen_modules/svm/tslearn.svm.TimeSeriesSVC.html#tslearn.svm.TimeSeriesSVC) | [TimeSeriesSVR](https://tslearn.readthedocs.io/en/stable/gen_modules/svm/tslearn.svm.TimeSeriesSVR.html#tslearn.svm.TimeSeriesSVR) | [Global Alignment Kernel](https://tslearn.readthedocs.io/en/stable/gen_modules/metrics/tslearn.metrics.gak.html#tslearn.metrics.gak) |\n| Conversion([1](https://tslearn.readthedocs.io/en/stable/gen_modules/tslearn.utils.html#module-tslearn.utils), [2](https://tslearn.readthedocs.io/en/stable/integration_other_software.html)) | | [KernelKmeans](https://tslearn.readthedocs.io/en/stable/gen_modules/clustering/tslearn.clustering.KernelKMeans.html#tslearn.clustering.KernelKMeans) | [LearningShapelets](https://tslearn.readthedocs.io/en/stable/gen_modules/shapelets/tslearn.shapelets.LearningShapelets.html) | [MLP](https://tslearn.readthedocs.io/en/stable/gen_modules/tslearn.neural_network.html#module-tslearn.neural_network) | [Barycenters](https://tslearn.readthedocs.io/en/stable/gen_modules/tslearn.barycenters.html#module-tslearn.barycenters) |\n| | | | [Early Classification](https://tslearn.readthedocs.io/en/stable/gen_modules/tslearn.early_classification.html#module-tslearn.early_classification) | | [Matrix Profile](https://tslearn.readthedocs.io/en/stable/gen_modules/tslearn.matrix_profile.html#module-tslearn.matrix_profile) |\n\n\n## Documentation\n\nThe documentation is hosted at [readthedocs](http://tslearn.readthedocs.io/en/stable/index.html). It includes an [API](https://tslearn.readthedocs.io/en/stable/reference.html), [gallery of examples](https://tslearn.readthedocs.io/en/stable/auto_examples/index.html) and a [user guide](https://tslearn.readthedocs.io/en/stable/user_guide/userguide.html).\n\n## Contributing\n\nIf you would like to contribute to `tslearn`, please have a look at [our contribution guidelines](CONTRIBUTING.md). A list of interesting TODO's can be found [here](https://github.com/tslearn-team/tslearn/issues?utf8=✓&q=is%3Aissue%20is%3Aopen%20label%3A%22new%20feature%22%20). **If you want other ML methods for time series to be added to this TODO list, do not hesitate to [open an issue](https://github.com/tslearn-team/tslearn/issues/new/choose)!**\n\n## Referencing tslearn\n\nIf you use `tslearn` in a scientific publication, we would appreciate citations:\n\n```bibtex\n@article{JMLR:v21:20-091,\n author = {Romain Tavenard and Johann Faouzi and Gilles Vandewiele and \n Felix Divo and Guillaume Androz and Chester Holtz and \n Marie Payne and Roman Yurchak and Marc Ru{\\ss}wurm and \n Kushal Kolar and Eli Woods},\n title = {Tslearn, A Machine Learning Toolkit for Time Series Data},\n journal = {Journal of Machine Learning Research},\n year = {2020},\n volume = {21},\n number = {118},\n pages = {1-6},\n url = {http://jmlr.org/papers/v21/20-091.html}\n}\n```\n\n#### Acknowledgments\nAuthors would like to thank Mathieu Blondel for providing code for [Kernel k-means](https://gist.github.com/mblondel/6230787) and [Soft-DTW](https://github.com/mblondel/soft-dtw), and to Mehran Maghoumi for his [`torch`-compatible implementation of SoftDTW](https://github.com/Maghoumi/pytorch-softdtw-cuda).\n","description_content_type":"text/markdown","docs_url":null,"download_url":"","downloads":{"last_day":-1,"last_month":-1,"last_week":-1},"dynamic":null,"home_page":"http://tslearn.readthedocs.io/","keywords":"","license":"BSD-2-Clause","license_expression":null,"license_files":null,"maintainer":"","maintainer_email":"","name":"tslearn","package_url":"https://pypi.org/project/tslearn/","platform":null,"project_url":"https://pypi.org/project/tslearn/","project_urls":{"Homepage":"http://tslearn.readthedocs.io/","Source":"https://github.com/tslearn-team/tslearn"},"provides_extra":null,"release_url":"https://pypi.org/project/tslearn/0.6.3/","requires_dist":["numpy","scipy","scikit-learn","numba","joblib","torch ; extra == 'pytorch'","pytest ; extra == 'tests'","torch ; extra == 'tests'"],"requires_python":"","summary":"A machine learning toolkit dedicated to time-series data","version":"0.6.3","yanked":false,"yanked_reason":null}

Dependency	Optional
joblib	false
numba	false
numpy	false
scikit-learn	false
scipy	false
pytest	true
torch	true

Package search

tslearn

project_urls

Dependencies

All package metadata

Releases