DiffWrapper
Python template · sinapsis_darts_forecasting.templates.time_series_preprocessing
Overview
A dynamic preprocessing template for applying Darts transformations to time series data.
This template allows users to apply various transformations from `darts.dataprocessing.transformers` to different parts of the time series packet (`content`, `past_covariates`, `future_covariates`).
If a transformer requires fitting (e.g., `Scaler`), it stores and retrieves transformation parameters.
Diff — inherited documentation
Helper class that provides a standard way to create an ABC using inheritance.Differencing data transformer.
Differencing is typically applied to a time series to make it stationary; see [1]_ for further details. The transformation is applied independently over each dimension (component) and sample of the time series.
Notes ----- `Diff` sequentially applies a series of :math:`m`-lagged differencing operations (i.e. :math:`y\prime_t = y_t - y_{t-m}`) to a time series; please refer to [2]_ for further details about lagged differencing. The :math:`m` value to use for each differencing operation is specified by the `lags` parameter; for example, setting `lags = [1, 12]` first applies 1-lagged differencing to the time series, and then 12-lagged differencing to the 1-lagged differenced series.
Each element in `lags` represents a single first-order differencing operation, so the 'total order' of the differencing equals `len(lags)`. To specify second-order differencing then (i.e. the equivalent of `series.diff(n=2)`), one should specify `lags = [1,1]` (i.e. two sequential 1-lagged, first-order differences); see [3]_ for further details on second-order differencing.
Upon computing each :math:`m`-lagged difference, the first :math:`m` values of the time series are 'lost', since differences cannot be computed for these values. The length of a `series` transformed by `Diff(lags=lags)` will therefore be `series.n_timesteps - sum(lags)`.
Parameters ---------- name A specific name for the transformer lags Specifies the lag values to be used for each first-order differencing operation (i.e. the :math:`m` value in :math:`y'_t = y_t - y_{t-m}`). If a single int is provided, only one differencing operation is performed with this specified lag value. If a sequence of ints is provided, multiple differencing operations are sequentially performed using each value in `lags`, one after the other. For example, specifying `lags = [2, 3]` will effectively compute `series.diff(n=1, periods=2).diff(n=1, periods=3)`. dropna Optionally, specifies if values which can't be differenced (i.e. at the start of the series) should be dropped. Note that if `dropna = True`, then a `component_mask` cannot be specified, since the undifferenced components will be of a different length to the differenced ones. n_jobs The number of jobs to run in parallel. Parallel jobs are created only when a ``Sequence[TimeSeries]`` is passed as input, parallelising operations regarding different ``TimeSeries``. Defaults to `1` (sequential). Setting the parameter to `-1` means using all the available processors. Note: for a small amount of data, the parallelisation overhead could end up increasing the total required amount of time. verbose Whether to print operations progress
Examples -------- >>> from darts.datasets import AirPassengersDataset >>> from darts.dataprocessing.transformers import Diff >>> series = AirPassengersDataset().load() >>> first_order_diff = Diff(lags=1, dropna=True).fit_transform(series) >>> print(first_order_diff.values()[:5]) [[ 6.] [14.] [-3.] [-8.] [14.]] >>> second_order_diff = Diff(lags=[1, 2], dropna=False).fit_transform(series) >>> print(second_order_diff.values()[:5]) [[ nan] [ nan] [ nan] [ -9.] [-22.]]
References ---------- .. [1] https://otexts.com/fpp2/stationarity.html .. [2] https://otexts.com/fpp2/stationarity.html#seasonal-differencing .. [3] https://otexts.com/fpp2/stationarity.html#second-order-differencing
Capabilities
Capabilities: not setInstallation
Install the published package using pip or uv.
pip install sinapsis-darts-forecasting==1.0.0uv pip install sinapsis-darts-forecasting==1.0.0uv add sinapsis-darts-forecasting==1.0.0Configuration
Effective fields from the inspector schema, including nested Pydantic model fields.
Required
Default: null
Required
Default: null
Optional
Default: null
Required
Default: null
Optional
Default: 1
Optional
Default: "Diff"
Optional
Default: true
Optional
Default: 1
Optional
Default: false
Optional
Default: null
Optional
Default: null
Configuration example
Generated from documented defaults. Replace any placeholders and complete required nested settings before running.
templates:
- template_name: "DiffWrapper"
class_name: "DiffWrapper"
attributes:
method: "<required>"
apply_to: "<required>"
diff_init:
lags: 1
name: "Diff"
dropna: true
n_jobs: 1
verbose: false
params_key: null
transform_kwargs: null
View original docstring example
The source example references MissingValuesFillerWrapper, not DiffWrapper.
agent:
name: my_test_agent
templates:
- template_name: InputTemplate
class_name: InputTemplate
attributes: {}
- template_name: MissingValuesFillerWrapper
class_name: MissingValuesFillerWrapper
template_input: InputTemplate
attributes:
method: "transform"
apply_to: ["content"]
transform_kwargs:
method: "linear"
missingvaluesfiller_init:
fill: "auto"
name: "MissingValuesFiller"
n_jobs: 1
verbose: False
For a full list of options use the sinapsis cli: sinapsis info --all-template-names
If you want to see all available transformers, please visit: https://unit8co.github.io/darts/generated_api/darts.dataprocessing.transformers.htmlInheritance
sinapsis_darts_forecasting.templates.time_series_preprocessing.TimeSeriesPreprocessorEnvironment variables
Environment definitions belong to their canonical Python modules.