NOTE: sktime-dl is currenlty not maintained and replies to issues and PRs may be slow. We're looking for a new maintainer to help us maintain sktime-dl.

|travis|_ |pypi|_ |gitter|_ |Binder|_

.. |travis| image:: https://img.shields.io/travis/com/sktime/sktime-dl/master?logo=travis .. _travis: https://travis-ci.com/sktime/sktime-dl

.. |pypi| image:: https://img.shields.io/pypi/v/sktime-dl .. _pypi: https://pypi.org/project/sktime-dl/

.. |gitter| image:: https://img.shields.io/gitter/room/alan-turing-institute/sktime?logo=gitter .. _gitter: https://gitter.im/sktime/community

.. |binder| image:: https://mybinder.org/badge_logo.svg .. _Binder: https://mybinder.org/v2/gh/sktime/sktime-dl/master?filepath=examples

sktime-dl

An extension package for deep learning with Tensorflow/Keras for sktime <https://github.com/alan-turing-institute/sktime>, a scikit-learn <https://github.com/scikit-learn/scikit-learn> compatible Python toolbox for learning with time series and panel data.

sktime-dl is under development and we welcome new contributors.

Installation

The simplest installation method is to install in a new environment via pip: :: # if using anaconda for environment management conda create -n sktime-dl python=3.6 conda activate sktime-dl

# if using virtualenv for environment management
virtualenv sktime-dl
source bin/activate            #unix
sktime-dl\Scipts\activate      #windows

pip install sktime-dl

sktime-dl is under development. To ensure that you're using the most up to date code, you can instead install the development version in your environment: :: git clone https://github.com/sktime/sktime-dl.git cd sktime-dl git checkout dev git pull origin dev pip install .

When installing sktime-dl from scratch, the latest stable version of Tensorflow <https://www.tensorflow.org/install/>__ 2.x will be installed. Tensorflow 1.x is also supported beyond 1.9, if you have an existing installation in your environment that you wish to maintain.

Users with Tensorflow versions older than 2.1.0 shall also need to install keras-contrib <https://github.com/keras-team/keras-contrib>__ after installing sktime-dl, using the installation instructions for tf.keras <https://github.com/keras-team/keras-contrib#install-keras_contrib-for-tensorflowkeras>__.

Using GPUS

	
With the above instructions, the networks can be run out the box on your CPU. If 
you wish to run the networks on an NVIDIA® GPU, you can:

- use Docker (see below) 

or

- install extra drivers and toolkits (GPU drivers, CUDA Toolkit, and CUDNN library). See `this page <https://www.tensorflow.org/install/gpu#software_requirements>`__ for links and instructions, and also `this page <https://www.tensorflow.org/install/source#tested_build_configurations>`__ for a list of definite versioning compatabilities.       

Docker
~~~~~~

Follow `Tensorflow's instuctions <https://www.tensorflow.org/install/gpu>`__ to install Docker and nvidia-docker (Linux only).

Build the sktime-dl Docker image:
::
	cd sktime-dl
	docker build -t sktime_dl .

Run a container with GPU support using the image:
::
	docker run --gpus all --rm -it sktime_dl:latest

Run all the tests with:
::
	pytest -v --cov=sktime_dl

or exclude the long-running tests with:
::
	pytest -v -m="not slow" --cov=sktime_dl --pyargs sktime_dl

**CPU**

To run this Docker container on CPU, replace the above ``docker run`` command with:
::
	docker run --rm -it sktime_dl:latest

Overview
--------

A repository for off-the-shelf networks

The aim is to define Keras networks able to be directly used within sktime and its pipelining and strategy tools, and by extension scikit-learn, for use in applications and research. Over time, we wish to interface or implement a wide range of networks from the literature in the context of time series analysis.

Classification

Currently, we interface with a number of networks for time series classification in particular. A large part of the current toolset serves as an interface to `dl-4-tsc <https://github.com/hfawaz/dl-4-tsc>`__, and implements the following network architectures: 

- Time convolutional neural network (CNN)
- Encoder (Encoder)
- Fully convolutional neural network (FCNN)
- Multi channel deep convolutional neural network (MCDCNN)
- Multi-scale convolutional neural network (MCNN)
- Multi layer perceptron (MLP)
- Residual network (ResNet)
- Time Le-Net (TLeNet)
- Time warping invariant echo state network (TWIESN)

We also interface with `InceptionTime <https://github.com/hfawaz/InceptionTime>`__, as of writing the strongest deep learning approach to general time series classification. 

- Inception network, singular. 

Regression
~~~~~~~~~~

Most of the classifier architectures have been adapted to also provide regressors. These are:

- Time convolutional neural network (CNN)
- Encoder (Encoder)
- Fully convolutional neural network (FCNN)
- Multi layer perceptron (MLP)
- Residual network (ResNet)
- Time Le-Net (TLeNet)
- InceptionTime (Inception)

Forecasting
~~~~~~~~~~~

The regression networks can also be used to perform time series forecasting via sktime's `reduction strategies <https://alan-turing-institute.github.io/sktime/examples/forecasting.html#Reduction-strategies>`__. 

We aim to incorporate bespoke forecasting networks in future updates, both specific architectures and general RNNs/LSTMs. 

Meta-functionality

• Hyper-parameter tuning (through calls to sci-kit learn's Grid and RandomizedSearch tools, currently)
• Ensembling methods (over different random initialisations for stability) These act as wrappers to networks, and can be used in high-level and experimental pipelines as with any sktime model.

Documentation

sktime-dl is an extension package to sktime, primarily introducing different learning algorithms. All examples <https://github.com/alan-turing-institute/sktime/tree/master/examples>__ and documentation <https://alan-turing-institute.github.io/sktime/>__ on higher level funtionality and usage from the base sktime apply to this package.

Documentation specifically for sktime-dl shall be produced in due course.

Example notebooks for sktime-dl usage can be found under the examples folder.

Contributors

Former and current active contributors are as follows:

James Large (@James-Large, @jammylarge <https://twitter.com/jammylarge>__, [email protected]), Aaron Bostrom (@ABostrom), Hassan Ismail Fawaz (@hfawaz), Markus Löning (@mloning), @Withington