MedianAbsoluteScaledError#

类 MedianAbsoluteScaledError(multioutput='uniform_average', multilevel='uniform_average', sp=1, by_index=False)[source]#

中位数绝对缩放误差 (MdASE)。

MdASE 输出是非负浮点数。最佳值为 0.0。

采用测试集和训练集绝对误差的中位数而不是均值，使得该指标对误差异常值更鲁棒，因为中位数在存在异常值时通常是一种更鲁棒的中心趋势度量。

与 MASE 和其他缩放性能指标一样，这个无尺度指标可用于比较单个时间序列或不同时间序列上的预测方法。

与 MASE 类似，该指标也非常适合间歇性需求序列，因为它不会产生无穷大或未定义的值，除非训练数据是扁平时间序列。在这种情况下，函数返回一个大值而不是无穷大。

适用于具有同质季节性周期的多输出（多元）时间序列数据。

参数:
spint，默认为 1

数据的季节性周期。

multioutput{‘raw_values’，‘uniform_average’} 或形状为 (n_outputs,) 的类数组，默认为 ‘uniform_average’

定义如何聚合多元（多输出）数据的指标。

  • 如果是类数组，则其值用作对误差进行平均的权重。

  • 如果为 'raw_values'，则在多输出输入情况下返回完整的误差集。

  • 如果为 'uniform_average'，则所有输出的误差以统一权重进行平均。

multilevel{‘raw_values’，‘uniform_average’，‘uniform_average_time’}

定义如何聚合分层数据（带有层级）的指标。

  • 如果为 'uniform_average'（默认），则误差在层级之间进行平均。

  • 如果为 'uniform_average_time'，则指标应用于所有数据，忽略层级索引。

  • 如果为 'raw_values'，则不跨层级平均误差，保留层级结构。

by_index布尔值，默认为 False

确定在直接调用指标对象时是否跨时间点进行平均。

  • 如果为 False，则直接调用指标对象会对时间点进行平均，相当于调用 ``evaluate`` 方法。

  • 如果为 True，则直接调用指标对象会评估每个时间点的指标，相当于调用 evaluate_by_index 方法。

另请参阅

MeanAbsoluteScaledError
MeanSquaredScaledError
MedianSquaredScaledError

参考文献

Hyndman, R. J 和 Koehler, A. B. (2006)。“Another look at measures of forecast accuracy”，《国际预测杂志》(International Journal of Forecasting)，第 22 卷，第 4 期。

Hyndman, R. J. (2006)。“Another look at forecast accuracy metrics for intermittent demand”，《远见》(Foresight)，第 4 期。

Makridakis, S.、Spiliotis, E. 和 Assimakopoulos, V. (2020) “The M4 Competition: 100,000 time series and 61 forecasting methods”，《国际预测杂志》(International Journal of Forecasting)，第 3 卷。

示例

>>> import numpy as np
>>> from sktime.performance_metrics.forecasting import MedianAbsoluteScaledError
>>> y_train = np.array([5, 0.5, 4, 6, 3, 5, 2])
>>> y_true = np.array([3, -0.5, 2, 7])
>>> y_pred = np.array([2.5, 0.0, 2, 8])
>>> mdase = MedianAbsoluteScaledError()
>>> mdase(y_true, y_pred, y_train=y_train)
np.float64(0.16666666666666666)
>>> y_train = np.array([[0.5, 1], [-1, 1], [7, -6]])
>>> y_true = np.array([[0.5, 1], [-1, 1], [7, -6]])
>>> y_pred = np.array([[0, 2], [-1, 2], [8, -5]])
>>> mdase(y_true, y_pred, y_train=y_train)
np.float64(0.18181818181818182)
>>> mdase = MedianAbsoluteScaledError(multioutput='raw_values')
>>> mdase(y_true, y_pred, y_train=y_train)
array([0.10526316, 0.28571429])
>>> mdase = MedianAbsoluteScaledError(multioutput=[0.3, 0.7])
>>> mdase( y_true, y_pred, y_train=y_train)
np.float64(0.21935483870967742)

方法

__call__(y_true, y_pred, **kwargs)

使用底层指标函数计算指标值。

clone()

获取具有相同超参数和配置的对象的克隆。

clone_tags(estimator[, tag_names])

从另一个对象克隆标签作为动态覆盖。

create_test_instance([parameter_set])

使用第一个测试参数集构造类的一个实例。

create_test_instances_and_names([parameter_set])

创建所有测试实例列表及其名称列表。

evaluate(y_true, y_pred, **kwargs)

根据给定输入评估所需指标。

evaluate_by_index(y_true, y_pred, **kwargs)

返回在每个时间点评估的指标。

func(y_pred[, sp, horizon_weight, multioutput])

中位数绝对缩放误差 (MdASE)。

get_class_tag(tag_name[, tag_value_default])

从类获取类标签值，并继承父类的标签级别。

get_class_tags()

从类获取类标签，并继承父类的标签级别。

get_config()

获取对象的配置标志。

get_param_defaults()

获取对象的参数默认值。

get_param_names([sort])

获取对象的参数名称。

get_params([deep])

获取此对象的参数值字典。

get_tag(tag_name[, tag_value_default, ...])

从实例获取标签值，并考虑标签级别继承和覆盖。

get_tags()

从实例获取标签，并考虑标签级别继承和覆盖。

get_test_params([parameter_set])

返回估计器的测试参数设置。

is_composite()

检查对象是否由其他 BaseObjects 组成。

load_from_path(serial)

从文件位置加载对象。

load_from_serial(serial)

从序列化的内存容器加载对象。

reset()

将对象重置为干净的初始化后状态。

save([path, serialization_format])

将序列化对象保存到字节状对象或 (.zip) 文件。

set_config(**config_dict)

将配置标志设置为给定值。

set_params(**params)

设置此对象的参数。

set_random_state([random_state, deep, ...])

为对象设置 random_state 伪随机种子参数。

set_tags(**tag_dict)

将实例级标签覆盖设置为给定值。
func(y_pred, sp=1, horizon_weight=None, multioutput='uniform_average', **kwargs)[source]#

中位数绝对缩放误差 (MdASE)。

MdASE 输出是非负浮点数。最佳值为 0.0。

采用测试集和训练集绝对误差的中位数而不是均值，使得该指标对误差异常值更鲁棒，因为中位数在存在异常值时通常是一种更鲁棒的中心趋势度量。

与 MASE 和其他缩放性能指标一样，这个无尺度指标可用于比较单个时间序列或不同时间序列上的预测方法。

与 MASE 类似，该指标也非常适合间歇性需求序列，因为它不会产生无穷大或未定义的值，除非训练数据是扁平时间序列。在这种情况下，函数返回一个大值而不是无穷大。

适用于具有同质季节性周期的多输出（多元）时间序列数据。

参数:
y_true形状为 (fh,) 或 (fh, n_outputs) 的 pd.Series、pd.DataFrame 或 np.array，其中 fh 是预测范围

真实值（正确）目标值。

y_pred形状为 (fh,) 或 (fh, n_outputs) 的 pd.Series、pd.DataFrame 或 np.array，其中 fh 是预测范围

预测值。必须与 y_true 格式相同，如果带有索引，则索引和列也相同。

y_pred_benchmark可选，sktime 兼容数据容器格式的时间序列，默认为 None

用于与 y_pred 进行比较的基准预测，用于相对指标。仅当指标需要基准预测（由标签 requires-y-pred-benchmark 指示）时才需要。否则，可以传入以确保接口一致性，但会被忽略。必须与 y_true 格式相同，如果带有索引，则索引和列也相同。

y_train可选，sktime 兼容数据容器格式的时间序列，默认为 None

用于归一化误差指标的训练数据。仅当指标需要训练数据（由标签 requires-y-train 指示）时才需要。否则，可以传入以确保接口一致性，但会被忽略。如果带有索引，必须与 y_true 格式相同，列相同，但不一定索引相同。

spint

训练数据的季节性周期。

multioutput{‘raw_values’，‘uniform_average’} 或形状为 (n_outputs,) 的类数组，默认为 ‘uniform_average’

horizon_weight形状为 (fh,) 的类数组，默认为 None

预测范围权重。
定义如何聚合多元（多输出）数据的指标。如果是类数组，其值用作对误差进行平均的权重。如果为 ‘raw_values’，则在多输出输入情况下返回完整的误差集。如果为 ‘uniform_average’，则所有输出的误差以统一权重进行平均。

返回:

另请参阅

mean_absolute_scaled_error
mean_squared_scaled_error
median_squared_scaled_error

参考文献

Hyndman, R. J 和 Koehler, A. B. (2006)。“Another look at measures of forecast accuracy”，《国际预测杂志》(International Journal of Forecasting)，第 22 卷，第 4 期。

Hyndman, R. J. (2006)。“Another look at forecast accuracy metrics for intermittent demand”，《远见》(Foresight)，第 4 期。

Makridakis, S.、Spiliotis, E. 和 Assimakopoulos, V. (2020) “The M4 Competition: 100,000 time series and 61 forecasting methods”，《国际预测杂志》(International Journal of Forecasting)，第 3 卷。

示例

>>> import numpy as np
>>> from sktime.performance_metrics.forecasting import median_absolute_scaled_error
>>> y_train = np.array([5, 0.5, 4, 6, 3, 5, 2])
>>> y_true = [3, -0.5, 2, 7]
>>> y_pred = [2.5, 0.0, 2, 8]
>>> median_absolute_scaled_error(y_true, y_pred, y_train=y_train)
0.16666666666666666
>>> y_train = np.array([[0.5, 1], [-1, 1], [7, -6]])
>>> y_true = np.array([[0.5, 1], [-1, 1], [7, -6]])
>>> y_pred = np.array([[0, 2], [-1, 2], [8, -5]])
>>> median_absolute_scaled_error(y_true, y_pred, y_train=y_train)
0.18181818181818182
>>> median_absolute_scaled_error(y_true, y_pred, y_train=y_train,     multioutput='raw_values')
array([0.10526316, 0.28571429])
>>> median_absolute_scaled_error( y_true, y_pred, y_train=y_train,     multioutput=[0.3, 0.7])
0.21935483870967742
loss浮点数或浮点数 ndarray

返回估计器的测试参数设置。

参数:
MdASE 损失。如果 multioutput 为 ‘raw_values’，则为每个输出分别返回 MdASE。如果 multioutput 为 ‘uniform_average’ 或权重 ndarray，则返回所有输出误差的加权平均 MdASE。

classmethod get_test_params(parameter_set='default')[source]#

预测范围权重。
parameter_set字符串，默认为“default”

要返回的测试参数集的名称，用于测试。如果未为某个值定义特殊参数，则将返回 "default" 集。

params字典或字典列表，默认为 {}

使用底层指标函数计算指标值。

参数:
用于创建类的测试实例的参数。每个字典都是构造一个“有趣”测试实例的参数，即 MyClass(**params) 或 MyClass(**params[i]) 创建一个有效的测试实例。create_test_instance 使用 params 中的第一个（或唯一一个）字典。

真实值（正确）目标值。

__call__(y_true, y_pred, **kwargs)[source]#

  • y_truesktime 兼容数据容器格式的时间序列。

  • sktime 中的个体数据格式是所谓的 mtype 规范，每个 mtype 实现一个抽象 scitype。

  • Series scitype = 单个时间序列，普通预测。pd.DataFrame、pd.Series 或 np.ndarray（1D 或 2D）

Panel scitype = 时间序列集合，全局/面板预测。带有 2 级行 MultiIndex (实例，时间) 的 pd.DataFrame，3D np.ndarray (实例，变量，时间)，或 Series 类型的 pd.DataFrame 的 list

Hierarchical scitype = 分层集合，用于分层预测。带有 3 级或更多级行 MultiIndex (层级 1，...，层级 n，时间) 的 pd.DataFrame

有关数据格式的更多详细信息，请参阅 mtype 的词汇表。有关用法，请参阅预测教程 examples/01_forecasting.ipynb

y_predsktime 兼容数据容器格式的时间序列

用于评估预测值与真实值的差异。必须与 y_true 格式相同，如果带有索引，则索引和列也相同。

y_pred_benchmark可选，sktime 兼容数据容器格式的时间序列

用于比较 y_pred 的基准预测，用于相对指标。仅当指标需要基准预测（由标签 requires-y-pred-benchmark 指示）时才需要。否则，可以传入以确保接口一致性，但会被忽略。必须与 y_true 格式相同，如果带有索引，则索引和列也相同。

y_train可选，sktime 兼容数据容器格式的时间序列

用于归一化误差指标的训练数据。仅当指标需要训练数据（由标签 requires-y-train 指示）时才需要。否则，可以传入以确保接口一致性，但会被忽略。如果带有索引，必须与 y_true 格式相同，列相同，但不一定索引相同。

  • sample_weight可选，1D 类数组或可调用对象，默认为 None

  • 每个时间点的样本权重。

  • 如果为 None，则时间索引被视为等权重。

预测范围权重。
如果是数组，必须是 1D。如果 y_true 和 y_pred 是单个时间序列，则 sample_weight 的长度必须与 y_true 相同。如果时间序列是面板或分层的，则所有单个时间序列的长度必须相同，并且对于传入的所有时间序列实例，长度必须等于 sample_weight 的长度。

如果是可调用对象，它必须遵循 SampleWeightGenerator 接口，或具有以下签名之一：y_true: pd.DataFrame -> 1D array-like，或 y_true: pd.DataFrame x y_pred: pd.DataFrame -> 1D array-like。

  • loss浮点数、np.ndarray 或 pd.DataFrame

  • 计算得出的指标，平均或按变量计算。如果提供了 sample_weight，则按其加权。

  • 浮点数，如果 multioutput="uniform_average" 或 类数组，并且 ``multilevel="uniform_average" 或 “uniform_average_time”``。值是跨变量和层级平均的指标（参见类文档字符串）

形状为 (y_true.columns,) 的 np.ndarray，如果 multioutput=”raw_values”` 且 multilevel="uniform_average" 或 "uniform_average_time"。第 i 个条目是为第 i 个变量计算的指标

获取具有相同超参数和配置的对象的克隆。

如果 multilevel="raw_values"，则为 pd.DataFrame。如果 multioutput="uniform_average"，形状为 (n_levels,)；如果 multioutput="raw_values"，形状为 (n_levels, y_true.columns)。指标按层级应用，行平均（是/否）如 multioutput 中所述。

clone()[source]#

克隆是另一个没有共享引用且处于初始化后状态的对象。此函数等同于返回 self 的 sklearn.clone。

等同于构造 type(self) 的一个新实例，使用 self 的参数，即 type(self)(**self.get_params(deep=False))。

如果在 self 上设置了配置，克隆也将具有与原始对象相同的配置，等同于调用 cloned_self.set_config(**self.get_config())。
在值上也等同于调用 self.reset，不同之处在于 clone 返回一个新对象，而不是像 reset 那样改变 self。
引发:

从另一个对象克隆标签作为动态覆盖。

如果克隆不符合规范，则引发 RuntimeError，原因可能是 __init__ 有误。

clone_tags(estimator, tag_names=None)[source]#

每个 scikit-base 兼容对象都有一个标签字典。标签可用于存储有关对象的元数据，或控制对象的行为。

标签是特定于实例 self 的键值对，它们是静态标志，在对象构造后不会改变。

clone_tags 从另一个对象 estimator 设置动态标签覆盖。

clone_tags 方法只能在对象的 __init__ 方法中调用，即在构造期间或通过 __init__ 构造之后直接调用。

动态标签被设置为 estimator 中标签的值，名称由 tag_names 指定。

参数:
tag_names 的默认设置是将 estimator 中的所有标签写入 self。
当前标签值可通过 get_tags 或 get_tag 查看。

estimator:class:BaseObject 或其派生类的一个实例

预测范围权重。
tag_names字符串或字符串列表，默认为 None

要克隆的标签名称。默认值 (None) 克隆 estimator 中的所有标签。

self

使用第一个测试参数集构造类的一个实例。

参数:
MdASE 损失。如果 multioutput 为 ‘raw_values’，则为每个输出分别返回 MdASE。如果 multioutput 为 ‘uniform_average’ 或权重 ndarray，则返回所有输出误差的加权平均 MdASE。

对 self 的引用。

预测范围权重。
classmethod create_test_instance(parameter_set='default')[source]#
要返回的测试参数集的名称，用于测试。如果未为某个值定义特殊参数，将返回 “default” 集。

创建所有测试实例列表及其名称列表。

参数:
MdASE 损失。如果 multioutput 为 ‘raw_values’，则为每个输出分别返回 MdASE。如果 multioutput 为 ‘uniform_average’ 或权重 ndarray，则返回所有输出误差的加权平均 MdASE。

对 self 的引用。

预测范围权重。
instance带有默认参数的类的实例

classmethod create_test_instances_and_names(parameter_set='default')[source]#

objscls 实例列表

第 i 个实例是 cls(**cls.get_test_params()[i])

names字符串列表，与 objs 长度相同

根据给定输入评估所需指标。

参数:
用于创建类的测试实例的参数。每个字典都是构造一个“有趣”测试实例的参数，即 MyClass(**params) 或 MyClass(**params[i]) 创建一个有效的测试实例。create_test_instance 使用 params 中的第一个（或唯一一个）字典。

真实值（正确）目标值。

__call__(y_true, y_pred, **kwargs)[source]#

  • y_truesktime 兼容数据容器格式的时间序列。

  • sktime 中的个体数据格式是所谓的 mtype 规范，每个 mtype 实现一个抽象 scitype。

  • Series scitype = 单个时间序列，普通预测。pd.DataFrame、pd.Series 或 np.ndarray（1D 或 2D）

Panel scitype = 时间序列集合，全局/面板预测。带有 2 级行 MultiIndex (实例，时间) 的 pd.DataFrame，3D np.ndarray (实例，变量，时间)，或 Series 类型的 pd.DataFrame 的 list

Hierarchical scitype = 分层集合，用于分层预测。带有 3 级或更多级行 MultiIndex (层级 1，...，层级 n，时间) 的 pd.DataFrame

有关数据格式的更多详细信息，请参阅 mtype 的词汇表。有关用法，请参阅预测教程 examples/01_forecasting.ipynb

y_predsktime 兼容数据容器格式的时间序列

用于评估预测值与真实值的差异。必须与 y_true 格式相同，如果带有索引，则索引和列也相同。

y_pred_benchmark可选，sktime 兼容数据容器格式的时间序列

用于比较 y_pred 的基准预测，用于相对指标。仅当指标需要基准预测（由标签 requires-y-pred-benchmark 指示）时才需要。否则，可以传入以确保接口一致性，但会被忽略。必须与 y_true 格式相同，如果带有索引，则索引和列也相同。

y_train可选，sktime 兼容数据容器格式的时间序列

第 i 个元素是测试中 obj 的第 i 个实例的名称。如果多于一个实例，命名约定为 {cls.__name__}-{i}，否则为 {cls.__name__}

  • sample_weight可选，1D 类数组或可调用对象，默认为 None

  • 每个时间点的样本权重。

  • 如果为 None，则时间索引被视为等权重。

预测范围权重。
如果是数组，必须是 1D。如果 y_true 和 y_pred 是单个时间序列，则 sample_weight 的长度必须与 y_true 相同。如果时间序列是面板或分层的，则所有单个时间序列的长度必须相同，并且对于传入的所有时间序列实例，长度必须等于 sample_weight 的长度。

如果是可调用对象，它必须遵循 SampleWeightGenerator 接口，或具有以下签名之一：y_true: pd.DataFrame -> 1D array-like，或 y_true: pd.DataFrame x y_pred: pd.DataFrame -> 1D array-like。

  • evaluate(y_true, y_pred, **kwargs)[source]#

  • 计算得出的指标，平均或按变量计算。如果提供了 sample_weight，则按其加权。

  • 浮点数，如果 multioutput="uniform_average" 或 类数组，并且 ``multilevel="uniform_average" 或 “uniform_average_time”``。值是跨变量和层级平均的指标（参见类文档字符串）

每个时间点的样本权重或可调用对象。

返回在每个时间点评估的指标。

参数:
用于创建类的测试实例的参数。每个字典都是构造一个“有趣”测试实例的参数，即 MyClass(**params) 或 MyClass(**params[i]) 创建一个有效的测试实例。create_test_instance 使用 params 中的第一个（或唯一一个）字典。

真实值（正确）目标值。

__call__(y_true, y_pred, **kwargs)[source]#

  • y_truesktime 兼容数据容器格式的时间序列。

  • sktime 中的个体数据格式是所谓的 mtype 规范，每个 mtype 实现一个抽象 scitype。

  • Series scitype = 单个时间序列，普通预测。pd.DataFrame、pd.Series 或 np.ndarray（1D 或 2D）

Panel scitype = 时间序列集合，全局/面板预测。带有 2 级行 MultiIndex (实例，时间) 的 pd.DataFrame，3D np.ndarray (实例，变量，时间)，或 Series 类型的 pd.DataFrame 的 list

Hierarchical scitype = 分层集合，用于分层预测。带有 3 级或更多级行 MultiIndex (层级 1，...，层级 n，时间) 的 pd.DataFrame

有关数据格式的更多详细信息，请参阅 mtype 的词汇表。有关用法，请参阅预测教程 examples/01_forecasting.ipynb

y_predsktime 兼容数据容器格式的时间序列

用于评估预测值与真实值的差异。必须与 y_true 格式相同，如果带有索引，则索引和列也相同。

y_pred_benchmark可选，sktime 兼容数据容器格式的时间序列

用于比较 y_pred 的基准预测，用于相对指标。仅当指标需要基准预测（由标签 requires-y-pred-benchmark 指示）时才需要。否则，可以传入以确保接口一致性，但会被忽略。必须与 y_true 格式相同，如果带有索引，则索引和列也相同。

y_train可选，sktime 兼容数据容器格式的时间序列

第 i 个元素是测试中 obj 的第 i 个实例的名称。如果多于一个实例，命名约定为 {cls.__name__}-{i}，否则为 {cls.__name__}

  • sample_weight可选，1D 类数组或可调用对象，默认为 None

  • 每个时间点的样本权重。

  • 如果为 None，则时间索引被视为等权重。

预测范围权重。
浮点数，如果 multioutput="uniform_average" 或 类数组，并且 ``multilevel="uniform_average" 或 “uniform_average_time”``。值是跨变量和层级平均的指标（参见类文档字符串）

evaluate_by_index(y_true, y_pred, **kwargs)[source]#

  • losspd.Series 或 pd.DataFrame

  • 计算得出的指标，按时间点计算（默认为 jackknife 伪值）。如果提供了 sample_weight，则按其加权。

如果 multioutput="uniform_average" 或类数组，则为 pd.Series。索引与 y_true 的索引相同；索引 i 处的条目是时间点 i 的指标，经过变量平均。

从类获取类标签值，并继承父类的标签级别。

如果克隆不符合规范，则引发 RuntimeError，原因可能是 __init__ 有误。

clone_tags(estimator, tag_names=None)[source]#

如果 multioutput="raw_values"，则为 pd.DataFrame。索引和列与 y_true 相同；(i,j) 处的条目是时间点 i、变量 j 的指标。

classmethod get_class_tag(tag_name, tag_value_default=None)[source]#

  1. get_class_tag 方法是一个类方法，它仅考虑类级别标签值和覆盖来检索标签的值。

  2. 它从对象返回名称为 tag_name 的标签的值，并考虑标签覆盖，优先级降序排列如下：

在类的 _tags 属性中设置的标签。

在父类的 _tags 属性中设置的标签，

按继承顺序排列。

参数:
不考虑通过 set_tags 或 clone_tags 在实例上设置的动态标签覆盖。

要检索可能包含实例覆盖的标签值，请改用 get_tag 方法。

tag_name字符串

标签值的名称。

预测范围权重。
tag_value_default任何类型，可选；默认为 None

如果未找到标签，则为默认/备用值。

tag_value

从类获取类标签，并继承父类的标签级别。

如果克隆不符合规范，则引发 RuntimeError，原因可能是 __init__ 有误。

clone_tags(estimator, tag_names=None)[source]#

self 中 tag_name 标签的值。如果未找到，则返回 tag_value_default。

classmethod get_class_tags()[source]#

get_class_tags 方法是一个类方法，它仅考虑类级别标签值和覆盖来检索标签的值。

  1. get_class_tag 方法是一个类方法，它仅考虑类级别标签值和覆盖来检索标签的值。

  2. 它从对象返回名称为 tag_name 的标签的值，并考虑标签覆盖，优先级降序排列如下：

在类的 _tags 属性中设置的标签。

它返回一个字典，其键是在类或其任何父类中设置的任何 _tags 属性的键。

值是相应的标签值，按以下优先级降序排列进行覆盖：

在父类的 _tags 属性中设置的标签，

实例可以根据超参数覆盖这些标签。

预测范围权重。
要检索可能包含实例覆盖的标签，请改用 get_tags 方法。

要包含动态标签的覆盖，请使用 get_tags。

collected_tags字典

获取对象的配置标志。

标签名称 : 标签值对的字典。通过嵌套继承从 _tags 类属性收集。不被通过 set_tags 或 clone_tags 设置的动态标签覆盖。

get_config()[source]#

Configs 是 self 的键值对，通常用作控制行为的临时标志。

get_config 返回动态配置，它们会覆盖默认配置。

预测范围权重。
默认配置在类或其父类的类属性 _config 中设置，并通过 set_config 设置的动态配置进行覆盖。

Configs 在 clone 或 reset 调用下保留。

config_dict字典

配置名称 : 配置值对的字典。通过嵌套继承从 _config 类属性收集，然后从 _onfig_dynamic 对象属性获取任何覆盖和新标签。

预测范围权重。
classmethod get_param_defaults()[source]#

获取对象的参数默认值。

default_dict: dict[str, Any]

键是 cls 的所有在 __init__ 中定义了默认值的参数。值是默认值，如 __init__ 中定义的那样。

参数:
classmethod get_param_names(sort=True)[source]#

获取对象的参数名称。

预测范围权重。
sort布尔值，默认为 True

是否按字母顺序排序返回参数名称（True），或按它们在类 __init__ 中出现的顺序返回（False）。

param_names: list[str]

获取此对象的参数值字典。

参数:
cls 的参数名称列表。如果 sort=False，则与它们在类 __init__ 中出现的顺序相同。如果 sort=True，则按字母顺序排序。

get_params(deep=True)[source]#

  • deep布尔值，默认为 True

  • 是否返回组件的参数。

预测范围权重。
如果为 True，将返回此对象的参数名称 : 值 的 dict，包括组件的参数（= BaseObject 类型参数）。

如果为 False，将返回此对象的参数名称 : 值 的 dict，但不包括组件的参数。

  • params键为字符串的字典

  • 参数字典，包含 paramname : paramvalue 键值对，其中包括

  • 始终：此对象的所有参数，如通过 get_param_names 获取的参数值。此对象的参数值始终与构造时传入的值相同

如果 deep=True，还包含组件参数的键/值对。组件的参数以 [componentname]__[paramname] 的形式索引。所有 componentname 的参数以 paramname 及其值的形式出现

从实例获取标签值，并考虑标签级别继承和覆盖。

如果克隆不符合规范，则引发 RuntimeError，原因可能是 __init__ 有误。

clone_tags(estimator, tag_names=None)[source]#

如果 deep=True，还包含任意级别的组件递归，例如 [componentname]__[componentcomponentname]__[paramname] 等。

  1. get_tag(tag_name, tag_value_default=None, raise_error=True)[source]#

get_tag 方法从实例检索名称为 tag_name 的单个标签的值，并考虑标签覆盖，优先级降序排列如下：

  1. get_class_tag 方法是一个类方法，它仅考虑类级别标签值和覆盖来检索标签的值。

  2. 它从对象返回名称为 tag_name 的标签的值，并考虑标签覆盖，优先级降序排列如下：

在类的 _tags 属性中设置的标签。

参数:
不考虑通过 set_tags 或 clone_tags 在实例上设置的动态标签覆盖。

通过实例上的 set_tags 或 clone_tags 设置的标签，

在实例构造时设置的标签。

要检索的标签名称

tag_value_default任何类型，可选；默认为 None

如果未找到标签，则为默认/备用值

预测范围权重。
raise_error布尔值

未找到标签时是否引发 ValueError

如果在 self 上设置了配置，克隆也将具有与原始对象相同的配置，等同于调用 cloned_self.set_config(**self.get_config())。
tag_valueAny

self 中 tag_name 标签的值。如果未找到，并且 raise_error 为 True，则引发错误，否则返回 tag_value_default。

ValueError，如果 raise_error 为 True。

从实例获取标签，并考虑标签级别继承和覆盖。

如果克隆不符合规范，则引发 RuntimeError，原因可能是 __init__ 有误。

clone_tags(estimator, tag_names=None)[source]#

如果 tag_name 不在 self.get_tags().keys() 中，则引发 ValueError。

get_class_tags 方法是一个类方法，它仅考虑类级别标签值和覆盖来检索标签的值。

  1. get_tag(tag_name, tag_value_default=None, raise_error=True)[source]#

get_tag 方法从实例检索名称为 tag_name 的单个标签的值，并考虑标签覆盖，优先级降序排列如下：

  1. get_class_tag 方法是一个类方法，它仅考虑类级别标签值和覆盖来检索标签的值。

  2. 它从对象返回名称为 tag_name 的标签的值，并考虑标签覆盖，优先级降序排列如下：

在类的 _tags 属性中设置的标签。

预测范围权重。
要检索可能包含实例覆盖的标签，请改用 get_tags 方法。

get_tags()[source]#

get_tags 方法返回一个标签字典，其键是在类或其任何父类中设置的任何 _tags 属性的键，或通过 set_tags 或 clone_tags 设置的标签。

检查对象是否由其他 BaseObjects 组成。

标签名称 : 标签值对的字典。通过嵌套继承从 _tags 类属性收集，然后从 _tags_dynamic 对象属性获取任何覆盖和新标签。

预测范围权重。
is_composite()[source]#

复合对象是一个包含其他对象作为参数的对象。在实例上调用，因为这可能因实例而异。

composite: 布尔值

从文件位置加载对象。

参数:
对象是否具有任何参数，其值为 BaseObject 的派生实例。
预测范围权重。
classmethod load_from_path(serial)[source]#
serialZipFile(path).open(“object) 的结果

从序列化的内存容器加载对象。

参数:
反序列化对象，结果输出到 path，是 cls.save(path) 的输出。
预测范围权重。
classmethod load_from_serial(serial)[source]#
serialcls.save(None) 输出的第 1 个元素

将对象重置为干净的初始化后状态。

反序列化对象，结果输出 serial，是 cls.save(None) 的输出。

reset()[source]#

  • 结果是将 self 设置为构造函数调用后直接的状态，具有相同的超参数。通过 set_config 设置的配置值也保留下来。

  • 包含双下划线（即字符串“__”）的对象属性。例如，属性“__myattr”会被保留。

  • 配置属性，配置会保持不变。也就是说，get_config 在 reset 前后的结果是相同的。

类方法、对象方法和类属性也不会受到影响。

等同于 clone，但区别在于 reset 会修改 self 而不是返回一个新对象。

调用 self.reset() 后，self 的值和状态与通过构造函数调用 ``type(self)(**self.get_params(deep=False))`` 获得的对象相同。

预测范围权重。
tag_names字符串或字符串列表，默认为 None

实例重置到干净的初始化后状态，但保留当前的超参数值。

save(path=None, serialization_format='pickle')[source]#

将序列化对象保存到字节状对象或 (.zip) 文件。

行为：如果 path 为 None，则返回内存中的序列化 self；如果 path 是文件位置，则将 self 作为 zip 文件存储在该位置。

保存的文件是 zip 文件，包含以下内容：_metadata - 包含 self 的类，即 type(self)；_obj - 序列化后的 self。此类使用默认的序列化方法 (pickle)。

参数:
pathNone 或文件位置 (str 或 Path)

如果为 None，self 会被保存到内存中的对象；如果为文件位置，self 会被保存到该文件位置。如果

  • path=”estimator”，则会在当前工作目录下创建一个 zip 文件 estimator.zip。

  • path=”/home/stored/estimator”，则会将 zip 文件 estimator.zip

存储在 /home/stored/ 中。

serialization_format: str, 默认值 = “pickle”

用于序列化的模块。可用选项为“pickle”和“cloudpickle”。请注意，非默认格式可能需要安装其他软依赖。

预测范围权重。
如果 path 为 None - 内存中的序列化 self
如果 path 是文件位置 - 指向该文件的 ZipFile 对象
set_config(**config_dict)[source]#

将配置标志设置为给定值。

参数:
默认配置在类或其父类的类属性 _config 中设置，并通过 set_config 设置的动态配置进行覆盖。

配置名称 : 配置值 对的字典。有效的配置、值及其含义如下所示

displaystr，“diagram”（默认）或“text”

jupyter 内核如何显示 self 的实例

  • “diagram” = html 框图表示

  • “text” = 字符串打印输出

print_changed_onlybool, 默认值=True

打印 self 时是否仅列出与默认值不同的 self 参数 (False)，还是列出所有参数名称和值 (False)。不进行嵌套，即仅影响 self 而不影响组件估计器。

warningsstr，“on”（默认）或“off”

是否触发警告，仅影响来自 sktime 的警告

  • “on” = 将触发来自 sktime 的警告

  • “off” = 将不会触发来自 sktime 的警告

backend:parallelstr, 可选，默认值=”None”

用于广播/向量化时的并行化后端，选项之一：

  • “None”：按顺序执行循环，简单的列表推导式

  • “loky”、“multiprocessing”和“threading”：使用 joblib.Parallel

  • “joblib”：自定义和第三方 joblib 后端，例如 spark

  • “dask”：使用 dask，需要在环境中安装 dask 包

  • “ray”：使用 ray，需要在环境中安装 ray 包

backend:parallel:paramsdict, 可选，默认值={}（不传递参数）

作为配置传递给并行化后端的额外参数。有效键取决于 backend:parallel 的值

  • “None”：无额外参数，backend_params 被忽略

  • “loky”、“multiprocessing”和“threading”：默认 joblib 后端，任何 joblib.Parallel 的有效键都可以在此处传递，例如 n_jobs，但 backend 除外，它由 backend 直接控制。如果未传递 n_jobs，则默认为 -1，其他参数默认为 joblib 的默认值。

  • “joblib”：自定义和第三方 joblib 后端，例如 spark。任何 joblib.Parallel 的有效键都可以在此处传递，例如 n_jobs。在这种情况下，必须将 backend 作为 backend_params 的键传递。如果未传递 n_jobs，则默认为 -1，其他参数默认为 joblib 的默认值。

  • “dask”：可以传递 dask.compute 的任何有效键，例如 scheduler

  • “ray”：可以传递以下键

    • “ray_remote_args”：ray.init 的有效键字典

    • “shutdown_ray”：bool，默认值=True；False 可防止 ray

      在并行化后关闭。

    • “logger_name”：str，默认值=”ray”；要使用的日志记录器名称。

    • “mute_warnings”：bool，默认值=False；如果为 True，则抑制警告

预测范围权重。
self对自身的引用。

备注

改变对象状态，将 config_dict 中的配置复制到 self._config_dynamic。

set_params(**params)[source]#

设置此对象的参数。

此方法适用于简单的 skbase 对象以及复合对象。可以使用参数键字符串 <component>__<parameter> 来访问复合对象（即包含其他对象的对象）中组件 <component> 的 <parameter>。如果不产生歧义（例如，没有两个组件参数具有相同的名称 <parameter>），也可以直接使用字符串 <parameter>，不带 <component>__ 前缀。

参数:
**paramsdict

BaseObject 参数，键必须是 <component>__<parameter> 字符串。__ 后缀可以作为完整字符串的别名，如果它们在 get_params 键中是唯一的。

预测范围权重。
self对自身的引用（设置参数后）
set_random_state(random_state=None, deep=True, self_policy='copy')[source]#

为对象设置 random_state 伪随机种子参数。

通过 self.get_params 查找名为 random_state 的参数，并通过 set_params 将它们设置为从 random_state 派生的整数。这些整数通过 sample_dependent_seed 从链式哈希中采样，并保证种子随机生成器的伪随机独立性。

取决于 self_policy，应用于 self 中的 random_state 参数；如果 deep=True，则也应用于剩余的组件对象。

注意：即使 self 没有 random_state 参数，或者没有任何组件有 random_state 参数，也会调用 set_params。因此，set_random_state 将重置任何 scikit-base 对象，即使是没有 random_state 参数的对象。

参数:
random_stateint, RandomState 实例或 None, 默认值=None

伪随机数生成器，用于控制随机整数的生成。传递整数可在多次函数调用中获得可重现的输出。

cls 的参数名称列表。如果 sort=False，则与它们在类 __init__ 中出现的顺序相同。如果 sort=True，则按字母顺序排序。

是否在具有 skbase 对象值的参数（即组件估计器）中设置随机状态。

  • 如果为 False，则只设置 self 的 random_state 参数（如果存在）。

  • 如果为 True，则也会设置组件对象中的 random_state 参数。

self_policystr, 选项之一 {“copy”, “keep”, “new”}, 默认值=”copy”

  • “copy” : 将 self.random_state 设置为输入 random_state

  • “keep” : self.random_state 保持不变

  • “new” : 将 self.random_state 设置为一个新的随机状态，

从输入 random_state 派生，并且通常与输入不同

预测范围权重。
self对自身的引用
set_tags(**tag_dict)[source]#

将实例级标签覆盖设置为给定值。

如果克隆不符合规范，则引发 RuntimeError，原因可能是 __init__ 有误。

clone_tags(estimator, tag_names=None)[source]#

set_tags 将动态标签覆盖设置为 tag_dict 中指定的值，其中键是标签名称，字典值是要设置的标签值。

set_tags 方法应该只在对象的 __init__ 方法中，在构造期间或通过 __init__ 直接构造后调用。

动态标签被设置为 estimator 中标签的值，名称由 tag_names 指定。

参数:
**tag_dictdict

标签名称 : 标签值 对的字典。

预测范围权重。
Self

对自身的引用。