Skip to content
A package for time series data processing, classification, clustering, and prediction.
Julia
Branch: master
Clone or download

README.md

TSML Logo
Documentation Build Status Help

TSML is a package for time series data processing, classification, clustering, and prediction written in Julia.

The design/framework of this package is influenced heavily by Samuel Jenkins' Orchestra.jl and Paulito Palmes CombineML.jl packages.

Follow these links for a quick Jupyter Notebook TSML Demo and the JuliaCon 2019 Proceedings Paper.

TSML Notebooks Live Demo

Package Features

  • TS data type clustering/classification for automatic data discovery
  • TS aggregation based on date/time interval
  • TS imputation based on symmetric Nearest Neighbors
  • TS statistical metrics for data quality assessment
  • TS ML wrapper with more than 100+ libraries from caret, scikitlearn, and julia
  • TS date/value matrix conversion of 1-D TS using sliding windows for ML input
  • Common API wrappers for ML libs from JuliaML, PyCall, and RCall
  • Pipeline API allows high-level description of the processing workflow
  • Specific cleaning/normalization workflow based on data type
  • Automatic selection of optimised ML model
  • Automatic segmentation of time-series data into matrix form for ML training and prediction
  • Easily extensible architecture by using just two main interfaces: fit and transform
  • Meta-ensembles for robust prediction
  • Support for threads and distributed computation for scalability, and speed

Installation

TSML is in the Julia Official package registry. The latest release can be installed at the Julia prompt using Julia's package management which is triggered by pressing ] at the julia prompt:

julia> ]
(v1.1) pkg> add TSML

Or, equivalently, via the Pkg API:

julia> using Pkg
julia> Pkg.add("TSML")

Documentation

  • STABLEdocumentation of the most recently tagged version.
  • DEVELdocumentation of the in-development version.

Project Status

TSML is tested and actively developed on Julia 1.0 and above for Linux and macOS.

There is no support for Julia versions 0.4, 0.5, 0.6 and 0.7.

Overview

TSML (Time Series Machine Learning) is a package for Time Series data processing, classification, and prediction. It combines ML libraries from Python's ScikitLearn, R's Caret, and Julia using a common API and allows seamless ensembling and integration of heterogenous ML libraries to create complex models for robust time-series prediction.

Motivations

Over the past years, the industrial sector has seen many innovations brought about by automation. Inherent in this automation is the installation of sensor networks for status monitoring and data collection. One of the major challenges in these data-rich environments is how to extract and exploit information from these large volume of data to detect anomalies, discover patterns to reduce downtimes and manufacturing errors, reduce energy usage, etc.

To address these issues, we developed TSML package. It leverages AI and ML libraries from ScikitLearn, Caret, and Julia as building blocks in processing huge amount of industrial times series data. It has the following characteristics described below.

Main Workflow

The package assumes a two-column input composed of Dates and Values. The first part of the workflow aggregates values based on the specified date/time interval which minimizes occurrence of missing values and noise. The aggregated data is then left-joined to the complete sequence of dates in a specified date/time interval. Remaining missing values are replaced by k nearest neighbors where k is the symmetric distance from the location of missing value. This approach can be called several times until there are no more missing values.

TSML uses a pipeline of filters and transformers which iteratively calls the fit and transform families of functions relying on multiple dispatch to select the correct algorithm from the steps outlined above.

TSML supports transforming time series data into matrix form for ML training and prediction. Dateifier filter extracts the date features and convert the values into matrix form parameterized by the size and stride of the sliding window representing the dimension of the input for ML training and prediction. Similar workflow is done by the Matrifier filter to convert the time series values into matrix form.

The final part combines the dates matrix with the values matrix to become input of the ML with the output representing the values of the time periods to be predicted ahead of time.

Machine learning functions in TSML are wrappers to the corresponding Scikit-learn, Caret, and native Julia ML libraries. There are more than hundred classifiers and regression functions available using a common API.

Below are examples of the Pipeline workflow.

Generally, you will need the different transformers and utils in TSML for time-series processing. To use them, it is standard in TSML code to have the following declared at the topmost part of your application:

  • Load TSML and setup filters/transformers

# Setup source data and filters to aggregate and impute hourly
using TSML 

fname = joinpath(dirname(pathof(TSML)),"../data/testdata.csv")
csvreader = CSVDateValReader(Dict(:filename=>fname,:dateformat=>"dd/mm/yyyy HH:MM"))
valgator = DateValgator(Dict(:dateinterval=>Dates.Hour(1))) # aggregator
valnner = DateValNNer(Dict(:dateinterval=>Dates.Hour(1)))   # imputer
stfier = Statifier(Dict(:processmissing=>true))             # get statistics
mono = Monotonicer(Dict()) # normalize monotonic data
outnicer = Outliernicer(Dict(:dateinterval => Dates.Hour(1))) # normalize outliers
plotter = Plotter() # visualize output
  • Setup pipeline to load csv data, aggregate, and get statistics

# Setup pipeline without imputation and run
mpipeline1 = Pipeline(Dict(
  :transformers => [csvreader,valgator,stfier]
 )
)
fit!(mpipeline1)
stats1 = transform!(mpipeline1)

# Show statistics including blocks of missing data stats
show(stats1, allcols=true)
  • Load csv data, aggregate, impute, and get statistics

# Add imputation in the pipeline and rerun
mpipeline2 = Pipeline(Dict(
  :transformers => [csvreader,valgator,valnner,stfier]
 )
)
fit!(mpipeline2)
stats2 = transform!(mpipeline2)

# Show statistics including blocks of missing data stats
show(stats2, allcols=true)
  • Load csv data, aggregate, impute, normalize monotonic data, and plot

# Add imputation in the pipeline, and plot 
mpipeline2 = Pipeline(Dict(
  :transformers => [csvreader,valgator,valnner,mono,plotter]
 )
)
fit!(mpipeline2)
transform!(mpipeline2)

Feature Requests and Contributions

We welcome contributions, feature requests, and suggestions. Here is the link to open an issue for any problems you encounter. If you want to contribute, please follow the guidelines in contributors page.

Help usage

Usage questions can be posted in:

You can’t perform that action at this time.