Skip to main content

Deep learning for time series data

Project description

GitHub Workflow Status Coverage PyPI DOI Binder

The goal of mcfly is to ease the use of deep learning technology for time series classification and regression. The advantage of deep learning is that it can handle raw data directly, without the need to compute signal features. Deep learning does not require expert domain knowledge about the data, and has been shown to be competitive with conventional machine learning techniques. As an example, you can apply mcfly on accelerometer data for activity classification, as shown in the tutorial.

If you use mcfly in your research, please cite the following software paper:

D. van Kuppevelt, C. Meijer, F. Huber, A. van der Ploeg, S. Georgievska, V.T. van Hees. Mcfly: Automated deep learning on time series. SoftwareX, Volume 12, 2020. doi: 10.1016/j.softx.2020.100548

Installation

Prerequisites:

  • Python 3.7, 3.8, 3.9 or 3.10
  • pip
  • Tensorflow 2

Installing all dependencies in separate conda environment:

conda env create -f environment.yml

# activate this new environment
source activate mcfly

To install the package, run in the project directory:

pip install mcfly

Visualization

We build a tool to visualize the configuration and performance of the models. The tool can be found on http://nlesc.github.io/mcfly/. To run the model visualization on your own computer, cd to the html directory and start up a python web server:

python -m http.server 8888 &

Navigate to http://localhost:8888/ in your browser to open the visualization. For a more elaborate description of the visualization see user manual.

User documentation

User and code documentation.

Contributing

You are welcome to contribute to the code via pull requests. Please have a look at the NLeSC guide for guidelines about software development.

We use numpy-style docstrings for code documentation.

Licensing

Source code and data of mcfly are licensed under the Apache License, version 2.0.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

mcfly-4.0.0.tar.gz (19.4 kB view details)

Uploaded Source

Built Distribution

mcfly-4.0.0-py3-none-any.whl (24.8 kB view details)

Uploaded Python 3

File details

Details for the file mcfly-4.0.0.tar.gz.

File metadata

  • Download URL: mcfly-4.0.0.tar.gz
  • Upload date:
  • Size: 19.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.9.16

File hashes

Hashes for mcfly-4.0.0.tar.gz
Algorithm Hash digest
SHA256 3dc9dbcc06da7f168a48bf6d67bb5c33ed9a427507e3b967cf3c517d5696e93c
MD5 78f14bc940e9553cec83827a9a2185d7
BLAKE2b-256 c402e71ce41f317b3e552cae138c899101ca6fbc2f6b55714172ab11aa810eca

See more details on using hashes here.

File details

Details for the file mcfly-4.0.0-py3-none-any.whl.

File metadata

  • Download URL: mcfly-4.0.0-py3-none-any.whl
  • Upload date:
  • Size: 24.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.9.16

File hashes

Hashes for mcfly-4.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 52044646fccf338982863677186cab7e08f5a536b3f95b313ec60a1ce0c01cf5
MD5 87248b09fb59e7a1a499edb97b686b42
BLAKE2b-256 55a351d8e4709d371f19252342400e677e44b684ae54c395ee372eb5828ff6f8

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