darts.explainability.utils.get_component_names(series, past_covariates=None, future_covariates=None, idx=0)[源代码]

提取并返回目标序列、静态协变量、过去和未来协变量序列的组成部分。

参数
  • model – 任何 ForecastingModel

  • series (Sequence[TimeSeries]) – 一系列目标 TimeSeries

  • past_covariates (Optional[Sequence[TimeSeries], None]) – 可选地,一系列过去的协变量 TimeSeries

  • future_covariates (Optional[Sequence[TimeSeries], None]) – 可选地,一系列未来协变量 TimeSeries

  • idx (int) – 输入序列的索引,用于提取组件。

返回类型

Tuple[List[str], Optional[List[str], None], Optional[List[str], None], Optional[List[str], None]]

darts.explainability.utils.process_horizons_and_targets(horizons=None, fallback_horizon=None, target_components=None, fallback_target_components=None, check_component_names=False)[源代码]

处理输入的地平线和目标组件名称。

地平线

可选地,一个整数或整数序列,表示要解释的未来时间步。1 对应于被预测的第一个时间戳。所有值必须 <= 被解释的预测模型的 output_chunk_length

fallback_horizon

可选地,如果未提供 horizons,则回退到地平线。

目标组件

可选地,一个字符串或字符串序列,包含要解释的目标组件。

fallback_target_components

可选地,在未提供 target_components 的情况下,回退到的一系列字符串。

check_component_names

是否强制要求目标组件在 fallback_target_component 中。

返回类型

Tuple[Sequence[int], Sequence[str]]

darts.explainability.utils.process_input(model, input_type, series=None, past_covariates=None, future_covariates=None, fallback_series=None, fallback_past_covariates=None, fallback_future_covariates=None, check_component_names=False, requires_input=True, requires_covariates_encoding=False, test_stationarity=False)[源代码]

帮助函数,用于处理和检查 _ForecastingModelExplainer 的背景或前景系列输入。

如果没有提供输入(series, past/future_covariates),将使用回退值进行下游任务。如果输入和回退值都不可用,将引发错误。

回退依赖于输入类型(“背景”或“前景”): - 对于背景 input_type:回退是保存在拟合预测模型中的系列 - 对于前景 input_type:回退是来自 _ForecastingModelExplainer 的背景系列

参数
  • model (ForecastingModel) – 任何 ForecastingModel

  • input_type (str) – 输入序列的类型。可以是“background”或“foreground”

  • series (Union[TimeSeries, Sequence[TimeSeries], None]) – 可选地,一个或一系列目标 TimeSeries

  • past_covariates (Union[TimeSeries, Sequence[TimeSeries], None]) – 可选地,一个或一系列过去的协变量 TimeSeries

  • future_covariates (Union[TimeSeries, Sequence[TimeSeries], None]) – 可选地,一个或一系列未来协变量 TimeSeries

  • fallback_series (Union[TimeSeries, Sequence[TimeSeries], None]) – 可选地,一个或一系列目标 TimeSeries ,在未提供 series 的情况下作为备选。

  • fallback_past_covariates (Union[TimeSeries, Sequence[TimeSeries], None]) – 可选地,一个或一系列过去协变量 TimeSeries ,在未提供 past_covariates 的情况下作为备用。

  • fallback_future_covariates (Union[TimeSeries, Sequence[TimeSeries], None]) – 可选地,一个或一系列未来协变量 TimeSeries ,以备在未提供 future_covariates 时使用。

  • check_component_names (bool) – 是否强制要求,在多时间序列的情况下,所有相同类型(目标或 *_covariates)的序列必须具有相同的组件名称。

  • requires_input (bool) – 输入是否为必需。如果 True,则在未提供输入时引发错误。

  • requires_covariates_encoding (bool) – 是否将模型的编码器应用于输入协变量。只有在解释器不会直接调用模型的 fit()predict() 方法时,才应设置为 True

  • test_stationarity (bool) – 如果目标 series 中的所有组件不是静止的,是否引发警告。