Get Started

Installation guide

fABBA has the following essential dependencies for its functionality:

  • cython (>= 0.29.7)

  • numpy (>= 1.19.5)

  • scipy (>=1.2.1)

  • requests

  • scikit-learn (>=0.17.1)

  • threadpoolctl (>= 2.0.0)

  • matplotlib

  1. pip

To install the current release via PIP use:

pip install fabba

To check the installation, simply run:

python -m pip show fabba

If you want to uninstall it, you can use:

pip uninstall fabba

  1. conda

For conda users, to install this package with conda run:

conda install -c conda-forge fabba

To check the installation, run:

conda list fabba

and uninstall it with

conda uninstall fabba

Note

Some machine may raise the Cython issue, most of them happens since their machine have security issue - e.g., firewall - or without VC++ installed. Pleasee contact developers team for further support if you cannot address the Cython related issues.

Installing fABBA from the conda-forge channel can also be achieved by adding conda-forge to your channels with:

conda config --add channels conda-forge
conda config --set channel_priority strict

Once the conda-forge channel has been enabled, fABBA can be installed with conda:

conda install fabba

or with mamba:

mamba install fabba

It is possible to list all of the versions of fABBA available on your platform with conda:

conda search fabba --channel conda-forge

or with mamba:

mamba search fabba --channel conda-forge

Alternatively, mamba repoquery may provide more information:

# Search all versions available on your platform:
mamba repoquery search fabba --channel conda-forge

# List packages depending on fABBA:
mamba repoquery whoneeds fabba --channel conda-forge

# List dependencies of fABBA:
mamba repoquery depends fabba --channel conda-forge

  1. download

Download this repository via:

git clone https://github.com/nla-group/fABBA.git

If you have any instaling issues, please be free to submit your questions in the issues.

Quick start

The following example approximately transforms a time series into a symbolic string representation (fit_transform) and then converts the string back into a numerical format (inverse_transform). fABBA essentially requires two parameters tol and alpha. The tolerance tol determines how closely the polygonal chain approximation follows the original time series. The parameter alpha controls how similar time series pieces need to be in order to be represented by the same symbol. A smaller tol means that more polygonal pieces are used and the polygonal chain approximation is more accurate; but on the other hand, it will increase the length of the string representation. A smaller alpha typically results in a larger number of symbols.

The choice of parameters depends on the application, but in practice, one often just wants the polygonal chain to mimic the key features in time series and not to approximate any noise. In this example the time series is a sine wave and the chosen parameters result in the symbolic representation BbAaAaAaAaAaAaAaC. Note how the periodicity in the time series is nicely reflected in repetitions in its string representation.

import numpy as np
import matplotlib.pyplot as plt
from fABBA import fABBA

ts = [np.sin(0.05*i) for i in range(1000)]  # original time series
fabba = fABBA(tol=0.1, alpha=0.1, sorting='2-norm', scl=1, verbose=0)

string = fabba.fit_transform(ts)            # string representation of the time series
print(string)                               # prints BbAaAaAaAaAaAaAaC

inverse_ts = fabba.inverse_transform(string, ts[0]) # numerical time series reconstruction

Now you can plot your reconstruction to see how close it is to the raw data:

plt.plot(ts, label='time series', c='olive')
plt.plot(inverse_ts, label='reconstruction', c='darkblue')
plt.legend()
plt.grid(True, axis='y')
plt.show()
_images/demo.png