Docs /Templates/ sinapsis-darts-forecasting

InvertibleMapperWrapper

sinapsis-darts-forecastingDartsdatadartsdynamicforecasting

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.

InvertibleMapper — inherited documentation

Helper class that provides a standard way to create an ABC using inheritance. Data transformer to apply a custom function and its inverse to a (sequence of) ``TimeSeries`` (similar to calling :func:`TimeSeries.map()` on each series).

Parameters ---------- fn Either a function which takes a value and returns a value ie. `f(x) = y` Or a function which takes a value and its timestamp and returns a value ie. `f(timestamp, x) = y`. inverse_fn Similarly to `fn`, either a function which takes a value and returns a value ie. `f(x) = y` Or a function which takes a value and its timestamp and returns a value ie. `f(timestamp, x) = y`. `inverse_fn` should be such that ``inverse_fn(fn(x)) == x``. name A specific name for the transformer. n_jobs The number of jobs to run in parallel. Parallel jobs are created only when a `Sequence[TimeSeries]` is passed as input to a method, 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 Optionally, whether to print operations progress

Examples -------- >>> import numpy as np >>> from darts import TimeSeries >>> from darts.dataprocessing.transformers import InvertibleMapper >>> series = TimeSeries.from_values(np.array([1, 10, 100])) >>> transformer = InvertibleMapper(np.log10, lambda x: 10 ** x) >>> series_transformed = transformer.transform(series) >>> print(series_transformed.values()) [[0.] [1.] [2.]] [3.]] >>> series_restored = transformer.inverse_transform(series_transformed) >>> print(series_restored.values()) [[ 1.] [ 10.] [100.]]

Capabilities

Capabilities: not set

Installation

Install the published package using pip or uv.

Terminalbash
pip install sinapsis-darts-forecasting==1.0.0
uv pip install sinapsis-darts-forecasting==1.0.0
uv add sinapsis-darts-forecasting==1.0.0

Configuration

Effective fields from the inspector schema, including nested Pydantic model fields.

methodRequired
typing.Literal['fit', 'transform', 'fit_transform', 'inverse_transform']
Required
Default: null
apply_toRequired
list[typing.Literal['content', 'past_covariates', 'future_covariates', 'predictions']]
Required
Default: null
metadata
sinapsis_core.template_base.base_models.TemplateMetadata | None
Optional
Default: null
params_key
str | None
Optional
Default: null
transform_kwargs
dict[str, typing.Any]
Optional
Default: null
invertiblemapper_initRequired
__init__Attributes
Required
Default: null
fn
typing.Union[typing.Callable[[numpy.number], numpy.number], typing.Callable[[pandas.Timestamp, numpy.number], numpy.number]]
Optional
Default: null
name
str
Optional
Default: "InvertibleMapper"
n_jobs
int
Optional
Default: 1
verbose
bool
Optional
Default: false
inverse_fn
typing.Union[typing.Callable[[numpy.number], numpy.number], typing.Callable[[pandas.Timestamp, numpy.number], numpy.number]]
Optional
Default: null

Configuration example

Generated from documented defaults. Replace any placeholders and complete required nested settings before running.

yaml
templates:
  - template_name: "InvertibleMapperWrapper"
    class_name: "InvertibleMapperWrapper"
    attributes:
      method: "<required>"
      apply_to: "<required>"
      params_key: null
      transform_kwargs: null
      invertiblemapper_init:
        fn: null
        name: "InvertibleMapper"
        n_jobs: 1
        verbose: false
        inverse_fn: null
View original docstring example

The source example references MissingValuesFillerWrapper, not InvertibleMapperWrapper.

yaml
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.html

Inheritance

Immediate parent: sinapsis_darts_forecasting.templates.time_series_preprocessing.TimeSeriesPreprocessor

Environment variables

Environment definitions belong to their canonical Python modules.

SINAPSIS_BUILD_DOCS · defined elsewhere