Skip to content

NLeSC/mcfly-tutorial

Repository files navigation

CI Build

This repository contains notebooks that show how to use the mcfly software. Mcfly is deep learning tool for time series classification.

Tutorials

Currently we offer two tutorials here. Our main tutorial can be found in the notebook notebooks/tutorial/tutorial.ipynb. This tutorial will let you train deep learning models with mcfly on the PAMAP2 dataset for activity recognition.

A comparable, slightly quicker tutorial can be found in the notebook notebooks/tutorial/tutorial_quick.ipynb. This tutorial will let you train deep learning models with mcfly on the RacketSports dataset for activity recognition.

Prerequisites:

  • Python 3.7 and above
  • The following python packages have to be installed (also specified in requirements.txt file):
    • mcfly
    • jupyter
    • pandas
    • matplotlib
    • scipy
    • numpy

Installation

python3 -m venv env
. env/bin/activate
pip install --upgrade pip setuptools
pip install -r requirements.txt

Running the notebooks

The tutorials can be run using Jupyter notebook. From the tutorial root folder run:

jupyter notebook

There are two versions of the tutorial. The standard tutorial is for self-learning. There is also a version for workshops which is only expected to be used with the aid of an instructor.