Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
add additonal sections and update README.rst
- Loading branch information
1 parent
7aa42af
commit 6270d6c
Showing
19 changed files
with
105 additions
and
1,855 deletions.
There are no files selected for viewing
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,71 @@ | ||
.. |br| raw:: html | ||
|
||
<br /> | ||
|
||
=============================== | ||
MatrixProfile-TS Documentation | ||
=============================== | ||
|
||
.. image:: https://img.shields.io/pypi/v/matrixprofile-ts.svg | ||
:target: https://pypi.org/project/matrixprofile-ts/ | ||
:alt: PyPI Version | ||
.. image:: https://pepy.tech/badge/matrixprofile-ts | ||
:target: https://pepy.tech/project/matrixprofile-ts | ||
:alt: PyPI Downloads | ||
.. image:: https://travis-ci.org/target/matrixprofile-ts.svg | ||
:target: https://travis-ci.org/target/matrixprofile-ts | ||
:alt: Build Status | ||
.. image:: https://anaconda.org/conda-forge/matrixprofile-ts/badges/version.svg | ||
:target: https://anaconda.org/conda-forge/matrixprofile-ts | ||
:alt: Conda-forge Version | ||
.. image:: https://anaconda.org/conda-forge/matrixprofile-ts/badges/downloads.svg | ||
:target: https://anaconda.org/conda-forge/matrixprofile-ts | ||
:alt: Conda-forge Downloads | ||
.. image:: https://img.shields.io/badge/License-Apache%202.0-blue.svg | ||
:target: https://opensource.org/licenses/Apache-2.0 | ||
:alt: License | ||
.. image:: https://img.shields.io/twitter/follow/matrixprofile.svg?style=social | ||
:target: https://twitter.com/matrixprofile | ||
:alt: Twitter | ||
|
||
|br| | ||
|
||
.. image:: https://matrixprofile.org/static/img/mpf-logo.png | ||
:target: https://matrixprofile.org | ||
:height: 300px | ||
:scale: 50% | ||
:alt: MPF Logo | ||
|
||
MatrixProfile-TS | ||
---------------- | ||
MatrixProfile-TS is a Python 2 and 3 library, brought to you by the `Matrix Profile Foundation <https://matrixprofile.org>`_, for mining time series data. The Matrix Profile is a novel data structure developed by the `Keogh <https://www.cs.ucr.edu/~eamonn/MatrixProfile.html>`_ and `Mueen <https://www.cs.unm.edu/~mueen/>`_ research groups at UC-Riverside and the University of New Mexico. The goal of this library is to make these algorithms accessible to both the novice and expert. | ||
|br| | ||
|br| | ||
In addition to this Python library, the Matrix Profile Foundation, provides implementations in other languages. These languages have a pretty consistent API allowing you to easily switch between them without a huge learning curve. | ||
|
||
* `tsmp <https://github.com/matrix-profile-foundation/tsmp>`_ - an R implementation | ||
* `go-matrixprofile <https://github.com/matrix-profile-foundation/go-matrixprofile>`_ - a Golang implementation | ||
|
||
Installation | ||
------------ | ||
The easiest way to install this library is using pip. If you would like to install it from source, please review the `installation documentation <http://matrixprofile-ts.docs.matrixprofile.org/install.html>`_ for your platform. | ||
|
||
.. code-block:: bash | ||
pip install matrixprofile-ts | ||
Getting Started | ||
--------------- | ||
Our documentation provides a `quick start guide <http://matrixprofile-ts.docs.matrixprofile.org/Quickstart.html>`_, `examples <http://matrixprofile-ts.docs.matrixprofile.org/examples.html>`_ and `api <http://matrixprofile-ts.docs.matrixprofile.org/api.html>`_ documentation. It is the source of truth for getting up and running. | ||
|
||
Algorithms | ||
---------- | ||
For details about the algorithms implemented, including performance characteristics, please refer to the `documentation <http://matrixprofile-ts.docs.matrixprofile.org/Algorithms.html>`_. | ||
|
||
.. include:: help.rst | ||
|
||
.. include:: contributing.rst | ||
|
||
.. include:: code_of_conduct.rst | ||
|
||
.. include:: citations.rst |
Oops, something went wrong.