|
33 | 33 | STUMPY |
34 | 34 | ====== |
35 | 35 |
|
36 | | -STUMPY is a powerful and scalable library that efficiently computes something called the `matrix profile`_, which can be used for a variety of time series data mining tasks such as: |
| 36 | +STUMPY is a powerful and scalable library that efficiently computes something called the `matrix profile <docs/Tutorial_0.ipynb>`_, which can be used for a variety of time series data mining tasks such as: |
37 | 37 |
|
38 | 38 | * pattern/motif (approximately repeated subsequences within a longer time series) discovery |
39 | 39 | * anomaly/novelty (discord) discovery |
@@ -151,8 +151,9 @@ Documentation |
151 | 151 |
|
152 | 152 | In order to fully understand and appreciate the underlying algorithms and applications, it is imperative that you read the original publications_. For a more detailed example of how to use STUMPY please consult the latest `documentation <https://stumpy.readthedocs.io/en/latest/>`_ or explore the following tutorials: |
153 | 153 |
|
154 | | -1. `Matrix Profile - Tutorial #1 <docs/Tutorial_1.ipynb>`_ |
155 | | -2. `Time Series Chains - Tutorial #2 <docs/Tutorial_2.ipynb>`_ |
| 154 | +1. `The Matrix Profile - Tutorial 0 <docs/Tutorial_0.ipynb>`_ |
| 155 | +2. `STUMPY Basics - Tutorial #1 <docs/Tutorial_1.ipynb>`_ |
| 156 | +3. `Time Series Chains - Tutorial #2 <docs/Tutorial_2.ipynb>`_ |
156 | 157 |
|
157 | 158 | ----------- |
158 | 159 | Performance |
@@ -251,13 +252,12 @@ First, please check the issues on github to see if your question has already bee |
251 | 252 | Contributing |
252 | 253 | ------------ |
253 | 254 |
|
254 | | -We welcome `contributions <https://github.com/TDAmeritrade/stumpy/blob/master/CONTRIBUTING.md>`_ in any form! Assistance with documentation, particularly expanding tutorials, is always welcome. To contribute please `fork the project <https://github.com/TDAmeritrade/stumpy/fork>`_, make your changes, and submit a pull request. We will do our best to work through any issues with you and get your code merged into the main branch. |
| 255 | +We welcome `contributions <CONTRIBUTING.md>`_ in any form! Assistance with documentation, particularly expanding tutorials, is always welcome. To contribute please `fork the project <https://github.com/TDAmeritrade/stumpy/fork>`_, make your changes, and submit a pull request. We will do our best to work through any issues with you and get your code merged into the main branch. |
255 | 256 |
|
256 | 257 | ---------- |
257 | 258 | References |
258 | 259 | ---------- |
259 | 260 |
|
260 | | -.. _matrix profile: |
261 | 261 | .. _publications: |
262 | 262 |
|
263 | 263 | Yeh, Chin-Chia Michael, et al. (2016) Matrix Profile I: All Pairs Similarity Joins for Time Series: A Unifying View that Includes Motifs, Discords, and Shapelets. ICDM:1317-1322. `Link <https://ieeexplore.ieee.org/abstract/document/7837992>`__ |
|
0 commit comments