Skip to main content

Time series data preprocessing

Project description

logo

tsExtract: Time Series Preprocessing Library

tsExtract is a time series proprocessing library. Using sliding windows, tsExtract allows for the conversion of time series data to a form that can be fed into standard machine learning regression algorithms like Linear Regression, Decision Trees Regression and as well as Deep Learning.

| enter image description here |enter image description here |enter image description here |enter image description here |enter image description here |enter image description here |enter image description here | Open Source Helpers

Installation

pip

pip install tsextract

conda

conda install -c cydal tsextract

Main Features

  • Take sliding window of data and with that, create additional columns representing the window.
  • Perform differencing on windowed data to remove stationarity.
  • Calculate statistics on windowed and differenced data. These include temporal and spectral statistics functions.
  • Plot visualisations. These include -
    • Actual vs Predicted line and scatter plots
    • Lag correlation

Usage

Example Notebooks

print(df.head())
Date DAYTON_MW
2004-12-31 01:00:00 1596.0
2004-12-31 02:00:00 1517.0
2004-12-31 03:00:00 1486.0
2004-12-31 04:00:00 1469.0
2004-12-31 05:00:00 1472.0

Using the main build_features function

build_features takes in 4 arguments -

  • Data: Time series data in 1d.

  • Request Dictionary: Dictionary with the function type and parameters

  • Include_tzero (optional) - This gives the option on whether to also include the column t+0. Can be quite handy when implementing difference networks.

  • target_lag - Sets lag value. If predicting 10 hours into the future, then a value of 10 should be included. Default is 3.

from tsextract.feature_extraction.extract import build_features

features_request = {
    "window":[10]
}

features = build_features(df["DAYTON_MW"], features_request, include_tzero=False)

The example above sends in a request for a sliding window size of 10. What is returned is a dataframe with 10 columns equal to the window size passed in. The final column is the target column with values shifted 3 time steps in the future.

enter image description here

Features

  • window: Performs windowing of the data. Parameter(s) passed in as a list. A single value will take a sliding window corresponding to that value. A parameter of 10 will take windows from 1 to 10. If [5, 10] is passed in instead, then a window of 5 - 10 will be taken instead.

  • window_statistic: This performs windowing like above, but then applies specified statistic operation to reduce matrix to a vector of 1d.

  • difference/momentum/force: Performs differencing by subtracting from the value in the present time step, the value in the previous time step. The parameter expected is a list of size 2 or 3. Just like in windowing, the first value refers to the window size. Two windowing values may also be passed in for windows in that range. The final value is the lag, this refers to the differencing lag for subtraction. A difference lag of 1 means values are subtracted from immediate past values (t3-t2, t2-t1, t1-t0 e.t.c) while a difference lag of 3 will subtract from 3 time steps before (t6-t3, t5-t2, t4-t1 e.t.c). Momentum & Force are 2nd & 3rd order differences.

  • difference_statistic/momentum_statistic/force_statistic: Similarly, this performs the operations described above, but then applies the specified statistic.

from tsextract.feature_extraction.extract import build_features
from tsextract.domain.statistics import median, mean, skew, kurtosis
from tsextract.domain.temporal import abs_energy

features_request = {
    "window":[2], 
    "window_statistic":[24, median], 
    "difference":[12, 10],
    "difference_statistic":[15, 10, abs_energy], 
}

features = build_features(df["DAYTON_MW"], features_request, include_tzero=True, target_lag=3)

enter image description here

Summary Statistics

As described above, rather than take raw windowing or differencing matrix values, it is possible to take some summary statistic of it. See supported features.

Statistics Temporal Spectral
Mean Absolute Energy Spectral Centroid
Median AUC
Range Mean Absolute Difference
Standard Deviation Moment
Minimum Autocorrelation
Maximum Zero Crossing Rate
Range
Variance
Kurtosis
Skew
IQR
MAE
RMSE

Dependencies

  • pandas >= 1.0.3
  • seaborn >= 0.10.1
  • statsmodels >= 0.11.1
  • scipy >= 1.5.0
  • matplotlib >= 3.2.1
  • numpy >= 1.16.4

License

GNU GPL V3

Contribute

Contributors of all experience levels are welcome. Please see the contributing guide.

Source Code

You can get the latest source code

git clone https://github.com/cydal/tsExtract.git

Project details


Download files

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

Source Distribution

tsextract-0.0.7.tar.gz (8.8 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

tsextract-0.0.7-py3-none-any.whl (18.5 kB view details)

Uploaded Python 3

File details

Details for the file tsextract-0.0.7.tar.gz.

File metadata

  • Download URL: tsextract-0.0.7.tar.gz
  • Upload date:
  • Size: 8.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.5.0.1 requests/2.24.0 setuptools/49.2.0.post20200714 requests-toolbelt/0.9.1 tqdm/4.47.0 CPython/3.6.10

File hashes

Hashes for tsextract-0.0.7.tar.gz
Algorithm Hash digest
SHA256 e7a89cb8a246895f847ab2377a7ba7cdebab61dbc878a91c6fa47563bede362f
MD5 1dd8104ee31bbaa4302830add36ef69d
BLAKE2b-256 121b2d8007fb1bdf4e14d4d38927eb676128994a7a42bf404833af65f6a51902

See more details on using hashes here.

File details

Details for the file tsextract-0.0.7-py3-none-any.whl.

File metadata

  • Download URL: tsextract-0.0.7-py3-none-any.whl
  • Upload date:
  • Size: 18.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.5.0.1 requests/2.24.0 setuptools/49.2.0.post20200714 requests-toolbelt/0.9.1 tqdm/4.47.0 CPython/3.6.10

File hashes

Hashes for tsextract-0.0.7-py3-none-any.whl
Algorithm Hash digest
SHA256 21d0439aa3a0bc0aff65e75ec1f9c9c2bf352d4a70581a9780155ca72a4c1150
MD5 7a6e41305eecf0072d1d37a28a67800b
BLAKE2b-256 ea02903dee5217eee9887341d8b7f6191f655cef15a2bf9167c1e5c579cfc274

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page