qrTimeSeriesWrapper
Python template · sinapsis_darts_forecasting.templates.time_series_metrics
Overview
Dynamic Template for Darts metrics computation.
This template wraps any metric from the `darts.metrics` module and makes it available as a Sinapsis template. The wrapped metric is applied to the predictions and ground truth of each time series packet in the input container, and the result is stored in the `generic_data` field of the time series packet.
IMPORTANT NOTE: Validation mode should be enabled during model fitting and prediction (e.g., in the `TimeSeriesModel` template), to ensure that the metric is computed on the correct portion of the time series (i.e., the forecast horizon). If validation mode is not enabled, forecasted values and ground truth values may not be properly aligned, which can lead to incorrect metric calculations.
qr — inherited documentation
Quantile Risk (QR)
QR is a metric that quantifies the accuracy of a specific quantile :math:`q` from the predicted value distribution of a stochastic/probabilistic `pred_series` containing N samples.
The main difference to the Quantile Loss (QL) is that QR computes the quantile and loss on the aggregate of all sample values summed up along the time axis (QL computes the quantile and loss per time step).
For the true series :math:`y` and predicted stochastic/probabilistic series (containing N samples) :math:`\hat{y}` of of shape :math:`T \times N`, it is computed per column/component and quantile as:
.. math:: 2 \frac{QL(Z, \hat{Z}_q)}{Z},
where :math:`QL` is the Quantile Loss (:func:`~darts.metrics.metrics.ql`), :math:`Z = \sum_{t=1}^{T} y_t` is the sum of all target/actual values, :math:`\hat{Z} = \sum_{t=1}^{T} \hat{y}_t` is the sum of all predicted samples along the time axis, and :math:`\hat{Z}_q` is the quantile :math:`q` of that sum.
Parameters ---------- actual_series The (sequence of) actual series. pred_series The (sequence of) predicted series. intersect For time series that are overlapping in time without having the same time index, setting `True` will consider the values only over their common time interval (intersection in time). q The quantile (float [0, 1]) or list of quantiles of interest to compute the metric on. component_reduction Optionally, a function to aggregate the metrics over the component/column axis. It must reduce a `np.ndarray` of shape `(t, c)` to a `np.ndarray` of shape `(t,)`. The function takes as input a ``np.ndarray`` and a parameter named `axis`, and returns the reduced array. The `axis` receives value `1` corresponding to the component axis. If `None`, will return a metric per component. series_reduction Optionally, a function to aggregate the metrics over multiple series. It must reduce a `np.ndarray` of shape `(s, t, c)` to a `np.ndarray` of shape `(t, c)` The function takes as input a ``np.ndarray`` and a parameter named `axis`, and returns the reduced array. The `axis` receives value `0` corresponding to the series axis. For example with `np.nanmean`, will return the average over all series metrics. If `None`, will return a metric per component. 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. verbose Optionally, whether to print operations progress.
Returns ------- float A single metric score (when `len(q) <= 1`) for:
- a single univariate series. - a single multivariate series with `component_reduction`. - a sequence (list) of uni/multivariate series with `series_reduction` and `component_reduction`. np.ndarray A numpy array of metric scores. The array has shape (n components * n quantiles,) without component reduction, and shape (n quantiles,) with component reduction and `len(q) > 1`. For:
- the same input arguments that result in the `float` return case from above but with `len(q) > 1`. - a single multivariate series and at least `component_reduction=None`. - a sequence of uni/multivariate series including `series_reduction` and `component_reduction=None`. list[float] Same as for type `float` but for a sequence of series. list[np.ndarray] Same as for type `np.ndarray` but for a sequence of series.
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
Optional
Default: 0.5
Optional
Default: 1
Optional
Default: false
Optional
Default: true
Field used to set the template instance name and agent name. Defaults to None. qr intersect <class 'bool'>: default: True q typing.Union[float, list[float], tuple[numpy.ndarray, pandas.Index]]: default: 0.5 n_jobs… Read full field description
Field used to set the template instance name and agent name. Defaults to None. qr intersect <class 'bool'>: default: True q typing.Union[float, list[float], tuple[numpy.ndarray, pandas.Index]]: default: 0.5 n_jobs <class 'int'>: default: 1 verbose <class 'bool'>: default: False
Optional
Default: null
Configuration example
Generated from documented defaults. Replace any placeholders and complete required nested settings before running.
templates:
- template_name: "qrTimeSeriesWrapper"
class_name: "qrTimeSeriesWrapper"
attributes:
qr:
q: 0.5
n_jobs: 1
verbose: false
intersect: true
Inheritance
sinapsis_darts_forecasting.templates.time_series_metrics.TimeSeriesMetricsEnvironment variables
Environment definitions belong to their canonical Python modules.