https://github.com/matrix-profile-foundation/matrixprofile

A Python 3 library making time series data mining tasks, utilizing matrix profile algorithms, accessible to everyone.

https://github.com/matrix-profile-foundation/matrixprofile

Science Score: 23.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • CITATION.cff file
  • codemeta.json file
  • .zenodo.json file
  • DOI references
    Found 12 DOI reference(s) in README
  • Academic publication links
    Links to: joss.theoj.org, zenodo.org
  • Committers with academic emails
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (11.5%) to scientific vocabulary

Keywords

algorithms anomaly-detection clustering data-mining data-science hacktoberfest matrixprofile motif-discovery python python2 python3 segmentation time-series time-series-analysis

Keywords from Contributors

matrix-profile
Last synced: 5 months ago · JSON representation

Repository

A Python 3 library making time series data mining tasks, utilizing matrix profile algorithms, accessible to everyone.

Basic Info
  • Host: GitHub
  • Owner: matrix-profile-foundation
  • License: apache-2.0
  • Language: Python
  • Default Branch: master
  • Homepage: https://matrixprofile.org
  • Size: 6.69 MB
Statistics
  • Stars: 384
  • Watchers: 16
  • Forks: 66
  • Open Issues: 31
  • Releases: 0
Topics
algorithms anomaly-detection clustering data-mining data-science hacktoberfest matrixprofile motif-discovery python python2 python3 segmentation time-series time-series-analysis
Created over 6 years ago · Last pushed about 2 years ago
Metadata Files
Readme Contributing License Code of conduct

README.rst

.. image:: https://matrixprofile.org/static/img/mpf-logo.png
    :target: https://matrixprofile.org
    :height: 300px
    :scale: 50%
    :alt: MPF Logo
|
|
.. image:: https://img.shields.io/pypi/v/matrixprofile.svg
    :target: https://pypi.org/project/matrixprofile/
    :alt: PyPI Version
.. image:: https://pepy.tech/badge/matrixprofile
    :target: https://pepy.tech/project/matrixprofile
    :alt: PyPI Downloads
.. image:: https://img.shields.io/conda/vn/conda-forge/matrixprofile.svg
    :target: https://anaconda.org/conda-forge/matrixprofile
    :alt: Conda Version
.. image:: https://img.shields.io/conda/dn/conda-forge/matrixprofile.svg
    :target: https://anaconda.org/conda-forge/matrixprofile
    :alt: Conda Downloads
.. image:: https://codecov.io/gh/matrix-profile-foundation/matrixprofile/branch/master/graph/badge.svg
    :target: https://codecov.io/gh/matrix-profile-foundation/matrixprofile
    :alt: Code Coverage
.. image:: https://dev.azure.com/conda-forge/feedstock-builds/_apis/build/status/matrixprofile-feedstock?branchName=master
    :target: https://dev.azure.com/conda-forge/feedstock-builds/_build/latest?definitionId=11637&branchName=master
    :alt: Azure Pipelines
.. image:: https://api.travis-ci.com/matrix-profile-foundation/matrixprofile.svg?branch=master
    :target: https://travis-ci.com/matrix-profile-foundation/matrixprofile
    :alt: Build Status
.. image:: https://img.shields.io/conda/pn/conda-forge/matrixprofile.svg
    :target: https://anaconda.org/conda-forge/matrixprofile
    :alt: Platforms
.. 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
.. image:: https://img.shields.io/discord/589321741277462559?logo=discord
    :target: https://discordapp.com/invite/sBhDNXT
    :alt: Discord
.. image:: https://joss.theoj.org/papers/10.21105/joss.02179/status.svg
   :target: https://doi.org/10.21105/joss.02179
   :alt: JOSSDOI
.. image:: https://zenodo.org/badge/DOI/10.5281/zenodo.3789780.svg
   :target: https://doi.org/10.5281/zenodo.3789780
   :alt: ZenodoDOI

MatrixProfile
----------------
NOTE: THIS LIBRARY IS NOT ACTIVELY SUPPORTED. PLEASE CHECK OUT THE TD AMERITRADE STUMPY LIBRARY INSTEAD: https://github.com/TDAmeritrade/stumpyhttps://github.com/TDAmeritrade/stumpy

MatrixProfile is a Python 3 library, brought to you by the `Matrix Profile Foundation `_, for mining time series data. The Matrix Profile is a novel data structure with corresponding algorithms (stomp, regimes, motifs, etc.) developed by the `Keogh `_ and `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 through standardization of core concepts, a simplistic API, and sensible default parameter values.

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 `_ - an R implementation
* `go-matrixprofile `_ - a Golang implementation

Python Support
----------------
Currently, we support the following versions of Python:

* 3.5
* 3.6
* 3.7
* 3.8
* 3.9

Python 2 is no longer supported. There are earlier versions of this library that support Python 2.

Installation
------------
The easiest way to install this library is using pip or conda. If you would like to install it from source, please review the `installation documentation `_ for your platform.

Installation with pip

.. code-block:: bash

   pip install matrixprofile

Installation with conda

.. code-block:: bash

   conda config --add channels conda-forge
   conda install matrixprofile

Getting Started
---------------
This article provides introductory material on the Matrix Profile:
`Introduction to Matrix Profiles  `_


This article provides details about core concepts introduced in this library:
`How To Painlessly Analyze Your Time Series  `_

Our documentation provides a `quick start guide `_, `examples `_ and `api `_ 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 `_.
            
------------
Getting Help
------------
We provide a dedicated `Discord channel `_ where practitioners can discuss applications and ask questions about the Matrix Profile Foundation libraries. If you rather not join Discord, then please open a `Github issue `_.

------------
Contributing
------------
Please review the `contributing guidelines `_ located in our documentation.

---------------
Code of Conduct
---------------
Please review our `Code of Conduct documentation `_.

---------
Citations
---------
All proper acknowledgements for works of others may be found in our `citation documentation `_.

------
Citing
------
Please cite this work using the `Journal of Open Source Software article `_.

    Van Benschoten et al., (2020). MPA: a novel cross-language API for time series analysis. Journal of Open Source Software, 5(49), 2179, https://doi.org/10.21105/joss.02179

.. code:: bibtex

    @article{Van Benschoten2020,
        doi = {10.21105/joss.02179},
        url = {https://doi.org/10.21105/joss.02179},
        year = {2020},
        publisher = {The Open Journal},
        volume = {5},
        number = {49},
        pages = {2179},
        author = {Andrew Van Benschoten and Austin Ouyang and Francisco Bischoff and Tyler Marrs},
        title = {MPA: a novel cross-language API for time series analysis},
        journal = {Journal of Open Source Software}
    }

Owner

  • Name: Matrix Profile Foundation
  • Login: matrix-profile-foundation
  • Kind: organization

Enabling community members to easily interact with the Matrix Profile algorithms through education, support and software.

GitHub Events

Total
  • Issues event: 1
  • Watch event: 25
  • Issue comment event: 2
  • Pull request event: 1
  • Fork event: 2
Last Year
  • Issues event: 1
  • Watch event: 25
  • Issue comment event: 2
  • Pull request event: 1
  • Fork event: 2

Committers

Last synced: 9 months ago

All Time
  • Total Commits: 384
  • Total Committers: 18
  • Avg Commits per committer: 21.333
  • Development Distribution Score (DDS): 0.19
Past Year
  • Commits: 0
  • Committers: 0
  • Avg Commits per committer: 0.0
  • Development Distribution Score (DDS): 0.0
Top Committers
Name Email Commits
Tyler Marrs t****s@g****m 311
Nikita Smyrnov n****r@s****m 18
Yue Lu y****_@h****m 18
Demian Dekoninck d****n@l****e 8
Andrew Van Benschoten 8****n 7
Frankie Cancino f****o@g****m 6
Andrew Van Benschoten a****n@o****m 2
Bruno Hanzen b****n@e****m 2
LlewellynS96 l****1@g****m 2
Lukasz Mentel l****l@g****m 2
Bjørn Rustad b****n@r****e 1
Théophile Dano t****o@g****m 1
earthgecko 9****o 1
ksairahul21 k****4@g****m 1
ninimama n****r@g****m 1
rexking6 1****1@q****m 1
Nikita Smyrnov v****r@m****g 1
whitesource-bolt-for-github[bot] 4****] 1
Committer Domains (Top 20 + Academic)

Issues and Pull Requests

Last synced: 6 months ago

All Time
  • Total issues: 61
  • Total pull requests: 44
  • Average time to close issues: 3 months
  • Average time to close pull requests: 20 days
  • Total issue authors: 39
  • Total pull request authors: 22
  • Average comments per issue: 3.66
  • Average comments per pull request: 2.16
  • Merged pull requests: 31
  • Bot issues: 2
  • Bot pull requests: 1
Past Year
  • Issues: 0
  • Pull requests: 0
  • Average time to close issues: N/A
  • Average time to close pull requests: N/A
  • Issue authors: 0
  • Pull request authors: 0
  • Average comments per issue: 0
  • Average comments per pull request: 0
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 0
Top Authors
Issue Authors
  • tylerwmarrs (18)
  • NimaSarajpoor (3)
  • vanbenschoten (2)
  • mend-bolt-for-github[bot] (2)
  • rcyost (2)
  • ChrisCarini (1)
  • darigovresearch (1)
  • TinaShi (1)
  • marwaajouz (1)
  • elopezfune (1)
  • erezinman (1)
  • DemianD (1)
  • lmmentel (1)
  • beeb (1)
  • ythevalil-dd (1)
Pull Request Authors
  • kavj (7)
  • tylerwmarrs (4)
  • DemianD (4)
  • AndrewCharlesHay (3)
  • nikita-smyrnov (3)
  • frankiecancino (2)
  • lmmentel (2)
  • Bruno-Hanzen (2)
  • LuYueee (2)
  • vanbenschoten (2)
  • tomasApo (2)
  • earthgecko (1)
  • burk (1)
  • NimaSarajpoor (1)
  • fabiofumarola (1)
Top Labels
Issue Labels
help wanted (15) feature (11) DevOps (8) bug (6) discussion (5) Documentation (4) security vulnerability (2) enhancement (2)
Pull Request Labels
feature (1)

Packages

  • Total packages: 4
  • Total downloads:
    • pypi 3,293 last-month
  • Total docker downloads: 6
  • Total dependent packages: 6
    (may contain duplicates)
  • Total dependent repositories: 44
    (may contain duplicates)
  • Total versions: 29
  • Total maintainers: 3
pypi.org: matrixprofile

An open source time series data mining library based on Matrix Profile algorithms.

  • Versions: 13
  • Dependent Packages: 4
  • Dependent Repositories: 42
  • Downloads: 3,293 Last month
  • Docker Downloads: 6
Rankings
Downloads: 1.6%
Dependent repos count: 2.3%
Dependent packages count: 2.3%
Docker downloads count: 2.3%
Average: 2.9%
Stargazers count: 3.5%
Forks count: 5.5%
Last synced: 6 months ago
proxy.golang.org: github.com/matrix-profile-foundation/matrixprofile
  • Versions: 14
  • Dependent Packages: 0
  • Dependent Repositories: 0
Rankings
Dependent packages count: 7.0%
Average: 8.2%
Dependent repos count: 9.3%
Last synced: 6 months ago
conda-forge.org: matrixprofile
  • Versions: 1
  • Dependent Packages: 2
  • Dependent Repositories: 1
Rankings
Dependent packages count: 19.6%
Stargazers count: 22.0%
Average: 22.6%
Dependent repos count: 24.3%
Forks count: 24.5%
Last synced: 6 months ago
anaconda.org: matrixprofile
  • Versions: 1
  • Dependent Packages: 0
  • Dependent Repositories: 1
Rankings
Stargazers count: 35.0%
Forks count: 37.4%
Average: 43.8%
Dependent repos count: 51.3%
Dependent packages count: 51.3%
Last synced: 6 months ago