Skip to main content

A python library for easy manipulation and forecasting of time series.

Project description

Time Series Made Easy in Python

darts


PyPI version Conda Version Supported versions Docker Image Version (latest by date) GitHub Release Date GitHub Workflow Status Downloads Downloads

darts is a Python library for easy manipulation and forecasting of time series. It contains a variety of models, from classics such as ARIMA to deep neural networks. The models can all be used in the same way, using fit() and predict() functions, similar to scikit-learn. The library also makes it easy to backtest models, and combine the predictions of several models and external regressors. Darts supports both univariate and multivariate time series and models. The neural networks can be trained on multiple time series, and some of the models offer probabilistic forecasts.

Documentation

High Level Introductions
Articles on Selected Topics

Quick Install

We recommend to first setup a clean Python environment for your project with at least Python 3.7 using your favorite tool (conda, venv, virtualenv with or without virtualenvwrapper).

Once your environment is set up you can install darts using pip:

pip install darts

For more detailed install instructions you can refer to our installation guide at the end of this page.

Example Usage

Create a TimeSeries object from a Pandas DataFrame, and split it in train/validation series:

import pandas as pd
from darts import TimeSeries

# Read a pandas DataFrame
df = pd.read_csv('AirPassengers.csv', delimiter=",")

# Create a TimeSeries, specifying the time and value columns
series = TimeSeries.from_dataframe(df, 'Month', '#Passengers')

# Set aside the last 36 months as a validation series
train, val = series[:-36], series[-36:]

Fit an exponential smoothing model, and make a (probabilistic) prediction over the validation series' duration:

from darts.models import ExponentialSmoothing

model = ExponentialSmoothing()
model.fit(train)
prediction = model.predict(len(val), num_samples=1000)

Plot the median, 5th and 95th percentiles:

import matplotlib.pyplot as plt

series.plot()
prediction.plot(label='forecast', low_quantile=0.05, high_quantile=0.95)
plt.legend()
darts forecast example

We invite you to go over the example and tutorial notebooks in the examples directory.

Features

Currently, the library contains the following features:

Forecasting Models: A large collection of forecasting models; from statistical models (such as ARIMA) to deep learning models (such as N-BEATS). See table of models below.

Data processing: Tools to easily apply (and revert) common transformations on time series data (scaling, boxcox, …)

Metrics: A variety of metrics for evaluating time series' goodness of fit; from R2-scores to Mean Absolute Scaled Error.

Backtesting: Utilities for simulating historical forecasts, using moving time windows.

Regression Models: Possibility to predict a time series from lagged versions of itself and of some external covariate series, using arbitrary regression models (e.g. scikit-learn models).

Multiple series training: All neural networks, as well as RegressionModels (incl. LinearRegressionModel and RandomForest) support being trained on multiple series.

Past and Future Covariates support: Some models support past-observed and/or future-known covariate time series as inputs for producing forecasts.

Multivariate Support: Tools to create, manipulate and forecast multivariate time series.

Probabilistic Support: TimeSeries objects can (optionally) represent stochastic time series; this can for instance be used to get confidence intervals.

Filtering Models: Darts offers three filtering models: KalmanFilter, GaussianProcessFilter, and MovingAverage, which allow to filter time series, and in some cases obtain probabilistic inferences of the underlying states/values.

Forecasting Models

Here's a breakdown of the forecasting models currently implemented in Darts. We are constantly working on bringing more models and features.

Model Univariate Multivariate Probabilistic Multiple-series training Past-observed covariates support Future-known covariates support Reference
ARIMA x x
VARIMA x x
AutoARIMA x
ExponentialSmoothing x x
Theta and FourTheta x Theta & 4 Theta
Prophet x Prophet repo
FFT (Fast Fourier Transform) x
RegressionModel (incl RandomForest, LinearRegressionModel and LightGBMModel) x x x x x
RNNModel (incl. LSTM and GRU); equivalent to DeepAR in its probabilistic version x x x x x DeepAR paper
BlockRNNModel (incl. LSTM and GRU) x x x x
NBEATSModel x x x x N-BEATS paper
TCNModel x x x x x TCN paper, DeepTCN paper, blog post
TransformerModel x x x x
Naive Baselines x

Community & Contact

Anyone is welcome to join our Discord server to ask questions, make proposals, discuss use-cases, and more. If you spot a bug or or have a feature request, Github issues are also welcome.

If what you want to tell us is not suitable for Discord or Github, feel free to send us an email at darts@unit8.co for darts related matters or info@unit8.co for any other inquiries.

Contribute

The development is ongoing, and there are many new features that we want to add. We welcome pull requests and issues on Github.

Before working on a contribution (a new feature or a fix), check our contribution guidelines.

Installation Guide

Some of the models depend on prophet and torch, which have non-Python dependencies. A Conda environment is thus recommended because it will handle all of those in one go.

From conda-forge

Currently only the x86_64 architecture with Python 3.7 or 3.8 is fully supported with conda; consider using PyPI if you are running into troubles.

To create a conda environment for Python 3.7 (after installing conda):

conda create --name <env-name> python=3.7

Don't forget to activate your virtual environment

conda activate <env-name>

As some models have relatively heavy dependencies, we provide two conda-forge packages:

  • Install darts with all available models (recommended): conda install -c conda-forge -c pytorch u8darts-all.
  • Install core + neural networks (PyTorch): conda install -c conda-forge -c pytorch u8darts-torch
  • Install core only (without neural networks, Prophet or AutoARIMA): conda install -c conda-forge u8darts

For GPU support, please follow the instructions to install CUDA in the PyTorch installation guide.

From PyPI

Install darts with all available models: pip install darts.

If this fails on your platform, please follow the official installation guides for prophet and torch, then try installing Darts again.

As some models have relatively heavy (or non-Python) dependencies, we also maintain the u8darts package, which provides the following alternate lighter install options:

  • Install core only (without neural networks, Prophet or AutoARIMA): pip install u8darts
  • Install core + neural networks (PyTorch): pip install 'u8darts[torch]'
  • Install core + Facebook Prophet: pip install 'u8darts[prophet]'
  • Install core + AutoARIMA: pip install 'u8darts[pmdarima]'

Enabling Support for LightGBM

To enable support for LightGBM in Darts, please follow the installation instructions for your OS.

MacOS Issues with LightGBM

At the time of writing, there is an issue with libomp 12.0.1 that results in segmentation fault on Mac OS Big Sur. Here's the procedure to downgrade the libomp library (from the original Github issue):

  • Install brew if you don't already have it.
  • Install wget if you don't already have it : brew install wget.
  • Run the commands below:
wget https://raw.githubusercontent.com/Homebrew/homebrew-core/fb8323f2b170bd4ae97e1bac9bf3e2983af3fdb0/Formula/libomp.rb
brew unlink libomp
brew install libomp.rb

Running the examples only, without installing:

If the conda setup is causing too many problems, we also provide a Docker image with everything set up for you and ready-to-use Python notebooks with demo examples. To run the example notebooks without installing our libraries natively on your machine, you can use our Docker image:

./gradlew docker && ./gradlew dockerRun

Then copy and paste the URL provided by the docker container into your browser to access Jupyter notebook.

For this setup to work you need to have a Docker service installed. You can get it at Docker website.

Tests

The gradle setup works best when used in a python environment, but the only requirement is to have pip installed for Python 3+

To run all tests at once just run

./gradlew test_all

alternatively you can run

./gradlew unitTest_all # to run only unittests
./gradlew coverageTest # to run coverage
./gradlew lint         # to run linter

To run the tests for specific flavours of the library, replace _all with _core, _prophet, _pmdarima or _torch.

Documentation

To build documentation locally just run

./gradlew buildDocs

After that docs will be available in ./docs/build/html directory. You can just open ./docs/build/html/index.html using your favourite browser.

Project details


Download files

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

Files for darts, version 0.12.0
Filename, size File type Python version Upload date Hashes
Filename, size darts-0.12.0-py3-none-any.whl (253.3 kB) File type Wheel Python version py3 Upload date Hashes View
Filename, size darts-0.12.0.tar.gz (4.6 MB) File type Source Python version None Upload date Hashes View

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page