- darts.explainability.utils.get_component_names(series, past_covariates=None, future_covariates=None, idx=0)[source]¶
提取并返回目标序列、静态协变量、过去协变量和未来协变量序列的组成部分。
- 参数
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)[source]¶
处理输入的时间范围和目标组件名称。
- horizons (时间范围)
可选，一个整数或整数序列，表示需要解释的未来时间步。 1 对应于预测的第一个时间戳。所有值必须 <=output_chunk_length （被解释的预测模型的输出块长度）。
- fallback_horizon (备用时间范围)
可选，在未提供 horizons 时回退到的时间范围。
- target_components (目标组件)
可选，一个字符串或字符串序列，包含需要解释的目标组件。
- 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)[source]¶
处理和检查提供给 _ForecastingModelExplainer 的背景或前景序列输入的辅助函数。
如果未提供输入（series，past/future_covariates），则将使用备用输入进行下游任务。如果输入和备用输入均不可用，则会引发错误。
备用输入取决于输入类型（“background”或“foreground”）： - 对于 background input_type：备用输入是拟合的预测模型中保存的序列 - 对于 foreground 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]) – 可选，在未提供 series 时回退到的一个或一个序列的目标 TimeSeries。fallback_past_covariates (
Union[TimeSeries,Sequence[TimeSeries],None]) – 可选，在未提供 past_covariates 时回退到的一个或一个序列的过去协变量 TimeSeries。fallback_future_covariates (
Union[TimeSeries,Sequence[TimeSeries],None]) – 可选，在未提供 future_covariates 时回退到的一个或一个序列的未来协变量 TimeSeries。check_component_names (
bool) – 对于多个时序的情况，是否强制要求同类型（目标或协变量）的所有序列必须具有相同的组成部分名称。requires_input (
bool) – 是否需要输入。如果为 True，则在未提供输入时引发错误。requires_covariates_encoding (
bool) – 是否将模型的编码器应用于输入协变量。仅当 Explainer 不会直接调用模型方法 fit() 或 predict() 时，此项应为 True。test_stationarity (
bool) – 如果目标 series 的所有组成部分都不是平稳的，是否发出警告。