ConstraintViolation

class ConstraintViolation(multioutput='uniform_average', score_average=True, coverage=None)

区间预测的区间约束违反百分比。

参数:

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

定义是否以及如何跨变量聚合指标。

• 如果为 'uniform_average' (默认)，则误差在变量之间平均计算。

• 如果为类数组对象，则误差在变量之间加权平均计算，值用作权重。

• 如果为 ‘raw_values’，则不跨变量聚合误差，保留列。

score_average布尔值，可选，默认=True

指定是否应对每个覆盖度值的分数进行平均。

• 如果为 True，则指标/损失将在 y_pred 中存在的所有覆盖度上平均计算。

• 如果为 False，则指标/损失不在覆盖度上平均计算。

coverage (可选)浮点数，浮点数列表，或 1D 类数组对象，默认=None

用于评估指标的名义覆盖度。如果指标直接使用中没有明确的覆盖度，例如通过 evaluate 进行基准测试或通过 ForecastingGridSearchCV 进行调优，则可以指定此项。

方法

__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[, multioutput])	根据给定输入评估所需指标。
evaluate_by_index(y_true, y_pred[, multioutput])	返回在每个时间点评估的指标。
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()	检索测试参数。
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)	将实例级别的标签覆盖设置为给定值。

classmethod get_test_params()

检索测试参数。

__call__(y_true, y_pred, **kwargs)

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

参数:

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

真实（正确）目标值。

y_pred概率预测方法的返回对象 scitype:y_pred

必须在 fh 处，并且变量必须与 y_true 中的变量相同。

返回:

loss浮点数或包含计算指标值的单列 pd.DataFrame

如果 multioutput = “raw_values”，则指标始终在 fh 值上平均（算术平均）计算，

将有一个与 y_true 中变量对应的列级别

如果 multioutput = “uniform_average” 或 类数组对象

条目将在输出变量列上平均计算

如果 score_average = False，

将有与分位数/区间对应的列级别

如果 score_average = True，

条目将在分位数/区间列上平均计算

clone()

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

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

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

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

在值上等同于调用 self.reset，但有一个例外：clone 返回一个新对象，而不是像 reset 那样修改 self。

引发:

如果由于错误的 __init__ 导致克隆不符合要求，则引发 RuntimeError。

clone_tags(estimator, tag_names=None)

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

每个 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 的引用。

classmethod create_test_instance(parameter_set='default')

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

参数:

parameter_set字符串，默认=”default”

要返回的测试参数集的名称，用于测试。如果某个值没有定义特殊参数，则返回 “default” 集。

返回:

instance具有默认参数的类实例

classmethod create_test_instances_and_names(parameter_set='default')

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

参数:

parameter_set字符串，默认=”default”

要返回的测试参数集的名称，用于测试。如果某个值没有定义特殊参数，则返回 “default” 集。

返回:

objscls 实例列表

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

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

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

evaluate(y_true, y_pred, multioutput=None, **kwargs)

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

参数:

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

真实（正确）目标值。

y_pred概率预测方法的返回对象 scitype:y_pred

必须位于预测范围 (fh) 内，且变量与 y_true 中的变量相同

multioutput字符串，“uniform_average” 或 “raw_values”，确定如何处理多输出结果。

返回:

loss浮点数或包含计算指标值的单列 pd.DataFrame

如果 multioutput = “raw_values”，则指标始终在 fh 值上平均（算术平均）计算，

将有一个与 y_true 中变量对应的列级别

如果 multioutput = “uniform_average” 或 类数组对象

条目将在输出变量列上平均计算

如果 score_average = False，

将有与分位数/区间对应的列级别

如果 score_average = True，

条目将在分位数/区间列上平均计算

evaluate_by_index(y_true, y_pred, multioutput=None, **kwargs)

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

参数:

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

真实（正确）目标值。

y_pred概率预测方法的返回对象 scitype:y_pred

必须位于预测范围 (fh) 内，且变量与 y_true 中的变量相同

multioutput字符串，“uniform_average” 或 “raw_values”，确定如何处理多输出结果。

返回:

loss长度为 len(fh) 的 pd.DataFrame，包含计算出的指标值

如果 multioutput = “raw_values”，第 i 列包含在第 i 个 fh 元素处的预测指标值，

将有一个与 y_true 中变量对应的列级别

如果 multioutput = “uniform_average” 或 类数组对象

条目将在输出变量列上平均计算

如果 score_average = False，

将有与分位数/区间对应的列级别

如果 score_average = True，

条目将在分位数/区间列上平均计算

classmethod get_class_tag(tag_name, tag_value_default=None)

从类中获取类标签值，具有来自父类的标签级别继承。

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

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

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

它从对象中返回名为 tag_name 的标签值，考虑标签覆盖，优先级按以下降序排列：

1. 类 _tags 属性中设置的标签。

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

按继承顺序。

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

要检索具有潜在实例覆盖的标签值，请改用 get_tag 方法。

参数:

tag_name字符串

标签值的名称。

tag_value_default任意类型

如果找不到标签，则使用的默认/备用值。

返回:

tag_value

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

classmethod get_class_tags()

从类中获取类标签，具有来自父类的标签级别继承。

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

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

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

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

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

1. 类 _tags 属性中设置的标签。

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

按继承顺序。

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

要检索具有潜在实例覆盖的标签，请改用 get_tags 方法。

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

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

返回:

collected_tags字典

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

get_config()

获取自身的配置标志。

配置是 self 的键值对，通常用作控制行为的瞬时标志。

get_config 返回动态配置，这些配置会覆盖默认配置。

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

配置在调用 clone 或 reset 时保留。

返回:

config_dict字典

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

classmethod get_param_defaults()

获取对象的参数默认值。

返回:

default_dict: 字典[str, Any]

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

classmethod get_param_names(sort=True)

获取对象的参数名称。

参数:

sort布尔值，默认为 True

是按字母顺序返回参数名称 (True)，还是按它们在类 __init__ 中出现的顺序返回 (False)。

返回:

param_names: 列表[str]

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

get_params(deep=True)

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

参数:

deep布尔值，默认为 True

是否返回组件的参数。

• 如果为 True，将返回此对象的参数名称 : 值 字典，包括组件的参数（= BaseObject 类型参数）。

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

返回:

params键为字符串类型的字典

参数字典，paramname : paramvalue 键值对包括

• 总是：此对象的所有参数，如同通过 get_param_names 获取的值一样，这些值始终与构造时传递的值相同

• 如果 deep=True，还包含组件参数的键值对。组件参数的索引格式为 [componentname]__[paramname]。 componentname 的所有参数都显示为其 paramname 及其值。

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

get_tag(tag_name, tag_value_default=None, raise_error=True)

从实例获取标签值，具有标签级别继承和覆盖。

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

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

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

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

在实例构造时。

2. 类 _tags 属性中设置的标签。

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

按继承顺序。

参数:

tag_name字符串

要检索的标签的名称

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

如果找不到标签，则使用的默认/备用值

raise_error布尔值

当找不到标签时是否引发 ValueError

返回:

tag_valueAny

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

引发:

ValueError，如果 raise_error 为 True。

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

get_tags()

从实例获取标签，具有标签级别继承和覆盖。

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

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

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

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

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

在实例构造时。

2. 类 _tags 属性中设置的标签。

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

按继承顺序。

返回:

collected_tags字典

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

is_composite()

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

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

返回:

composite: 布尔值

对象是否有任何参数的值是 BaseObject 的后代实例。

classmethod load_from_path(serial)

从文件位置加载对象。

参数:

serialZipFile(path).open(“object) 的结果

返回:

反序列化后的 self，其输出位于 path 处，与 cls.save(path) 的输出相同

classmethod load_from_serial(serial)

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

参数:

serialcls.save(None) 输出的第 1 个元素

返回:

反序列化后的 self，其输出为 serial，与 cls.save(None) 的输出相同

reset()

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

将 self 设置回构造函数调用后的状态，保留相同的超参数。通过 set_config 设置的配置值也会保留。

reset 调用会删除所有对象属性，除了

• 超参数 = 写入 self 的 __init__ 参数，例如 self.paramname，其中 paramname 是 __init__ 的一个参数

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

• 配置属性，配置保持不变。即，在 reset 前后调用 get_config 的结果是相同的。

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

等同于 clone，但 reset 修改的是 self 本身，而不是返回一个新对象。

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

返回:

自身

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

save(path=None, serialization_format='pickle')

将序列化的自身保存到字节类对象或 (.zip) 文件中。

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

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

参数:

pathNone 或 文件位置 (str 或 Path)

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

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

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

存储在 /home/stored/ 中。

serialization_format: 字符串，默认为 “pickle”

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

返回:

如果 path 为 None - 内存中的序列化 self

如果 path 是文件位置 - 引用该文件的 ZipFile 对象

set_config(**config_dict)

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

参数:

config_dict字典

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

display字符串，“diagram”（默认）或“text”

jupyter 内核如何显示 self 的实例

• “diagram” = HTML 框图表示

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

print_changed_only布尔值，默认为 True

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

warnings字符串，“on”（默认）或“off”

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

• “on” = 会发出来自 sktime 的警告

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

backend:parallel字符串，可选，默认为“None”

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

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

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

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

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

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

backend:parallel:params字典，可选，默认为 {}（不传递参数）

作为配置传递给并行化后端的额外参数。有效键取决于 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”：布尔值，默认为 True；False 会阻止 ray 在并行化后

    关闭。

  • “logger_name”：字符串，默认为“ray”；要使用的日志记录器的名称。

  • “mute_warnings”：布尔值，默认为 False；如果为 True，则禁止警告

返回:

self对 self 的引用。

注意

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

set_params(**params)

设置此对象的参数。

此方法适用于简单的 skbase 对象以及复合对象。对于复合对象（即包含其他对象的对象），可以使用参数键字符串 <component>__<parameter> 来访问组件 <component> 中的 <parameter>。如果引用是明确的（例如，没有两个组件参数同名 <parameter>），也可以使用不带 <component>__ 的字符串 <parameter>。

参数:

**params字典

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

返回:

self对 self 的引用（设置参数后）

set_random_state(random_state=None, deep=True, self_policy='copy')

为自身设置 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_state整数，RandomState 实例或 None，默认为 None

用于控制随机整数生成的伪随机数生成器。传递整数可确保多次函数调用之间输出的可重现性。

deep布尔值，默认为 True

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

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

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

self_policy字符串，以下之一：{“copy”，“keep”，“new”}，默认为“copy”

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

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

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

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

返回:

self对 self 的引用

set_tags(**tag_dict)

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

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

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

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

set_tags 方法只能在对象的 __init__ 方法中、构造期间或通过 __init__ 构造后立即调用。

可以通过 get_tags 或 get_tag 检查当前标签值。

参数:

**tag_dict字典

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

返回:

Self

对 self 的引用。