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 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.
We recommend to first setup a clean python environment for your project with at least python 3.6 using your favorite tool (conda, venv, virtualenv with or without virtualenvwrapper).
Once your environment is setup you can install darts using the pip package:
pip install u8darts
For more detailed install instructions you can refer to our installation guide at the end of this page.
Create TimeSeries object from a Pandas DataFrame, and split in train/validation series:
import pandas as pd
from darts import TimeSeries
df = pd.read_csv('AirPassengers.csv', delimiter=",")
series = TimeSeries.from_dataframe(df, 'Month', '#Passengers')
train, val = series.split_after(pd.Timestamp('19590101'))The dataset used in this example can be downloaded from this link.
Fit an exponential smoothing model, and make a prediction over the validation series' duration:
from darts.models import ExponentialSmoothing
model = ExponentialSmoothing()
model.fit(train)
prediction = model.predict(len(val))Plot:
import matplotlib.pyplot as plt
series.plot(label='actual', lw=3)
prediction.plot(label='forecast', lw=3)
plt.legend()
plt.xlabel('Year')
We invite you to go over the example notebooks in the examples directory.
The documentation of the API and models is available here.
Currently, the library contains the following features:
Forecasting Models:
- Exponential smoothing,
- ARIMA & auto-ARIMA,
- Facebook Prophet,
- Theta method,
- FFT (Fast Fourier Transform),
- Recurrent neural networks (vanilla RNNs, GRU, and LSTM variants),
- Temporal convolutional network.
Preprocessing: Transformer tool for easily scaling / normalizing time series.
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.
Regressive Models: Possibility to predict a time series from several other time series (e.g., external regressors), using arbitrary regressive models.
Multivariate Support: Tools to create, manipulate and forecast multivariate time series.
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) make sure you can't find anything related in issues. If there is no on-going effort on what you plan to do then we recommend to do the following:
- Create an issue, describe how you would attempt to solve it, and if possible wait for a discussion.
- Fork the repository.
- Clone the forked repository locally.
- Create a clean python env and install requirements with pip:
pip install -r requirements/main.txt -r requirements/dev.txt -r requirements/release.txt - Create a new branch with your fix / feature from the develop branch.
- Check that your code pass the tests / design new unit tests:
python -m unittest. - Verify your tests coverage with
./coverage.sh(additionaly you can generate xml report and use VSCode Coverage gutter to identify untested lines with./coverage.sh xml). - Create a pull request from your new branch to the develop branch.
If what you want to tell us is not a suitable github issue, feel free to send us an email at darts@unit8.co for darts related matters or info@unit8.co for any other inquiries.
Our direct dependencies include fbprophet and torch which have non-Python dependencies.
A Conda environment is thus recommended because it will handle all of those in one go.
The following steps assume running inside a conda environment. If that's not possible, first follow the official instructions to install fbprophet and torch, then skip to Install darts
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>
conda install -c conda-forge -c pytorch pip fbprophet pytorch
conda install -c conda-forge -c pytorch pip fbprophet pytorch cpuonly
pip install u8darts
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 dockerRunThen 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.
Gradle setup works best with python env, but it requires only that pip is for python3.
To run all tests at once just run
./gradlew testalternatively you can run
./gradlew unitTest # to run only unittests
./gradlew coverageTest # to run coverage
./gradlew lint # to run linterTo build documantation locally just run
./gradlew buildDocsAfter that docs will be available in ./docs/build/html directory. You can just open ./docs/build/html/index.html using your favourite browser.