AUCalibration

class AUCalibration(multioutput='uniform_average', multivariate=False)

分布预测的校准曲线下的面积。

计算校准曲线与对角线之间的无符号面积。

校准曲线是预测累积分布函数样本在真实值处评估的累积曲线。

在数学上，设 \(d_1, \dots, d_N\) 为预测分布，设 \(y_1, \dots, y_N\) 为真实值，设 \(F_i\) 为 \(d_i\) 的累积分布函数。

定义校准样本为 \(c_i := F_i(y_i)\)，其中 \(i = 1, \dots, N\)。对于完美预测，\(c_i\) 的样本将在 [0, 1] 上均匀分布，并且从该均匀分布中独立同分布。

设 \(c_{(i)}\) 为样本 \(c_i\) 的第 \(i\) 阶统计量，即样本中第 \(i\) 小的值。

校准曲线下的（无符号）面积——或者更准确地说，对角线和校准曲线之间的面积——被定义为

\[\frac{1}{N} \sum_{i=1}^N \left| c_{(i)} - \frac{i}{N} \right|.\]

• evaluate 返回校准曲线与对角线之间的无符号面积，即上述数量。

• evaluate_by_index 返回第 \(i\) 个测试样本的值 \(\left| c_i - \frac{r_i}{N} \right|\)，其中 \(r_i\) 是 \(c_i\) 在样本中的排名。在出现并列的情况下，并列排名取平均值。

• multivariate 控制变量的平均化。

参数:

多输出{‘raw_values’, ‘uniform_average’} 或形状为 array-like 的对象

(n_outputs,), 默认=’uniform_average’

定义是否以及如何跨变量聚合度量。如果为 ‘uniform_average’（默认），则误差在变量间进行均值平均。如果为数组类型，则误差在变量间进行加权平均，值作为权重。如果为 ‘raw_values’，则不跨变量平均误差，列被保留。

多元bool, 可选, 默认=False

如果为 True，则表现为多元度量（分数总和）。该度量针对整行计算，每行结果为一个分数。如果为 False，则返回单变量度量，每个变量分别计算。该度量针对每个变量的边际计算，每行结果为多个分数。

方法

__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()	获取 self 的配置标志
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, ...])	为 self 设置 random_state 伪随机种子参数。
set_tags(**tag_dict)	将动态标签设置为给定值。

classmethod get_test_params(parameter_set='default')

获取测试参数。

__call__(y_true, y_pred, **kwargs)

使用底层度量函数计算度量值。

参数:

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

地面真值（正确的）目标值。

y_pred概率预测方法返回对象的科学类型：y_pred

必须在 fh 且变量等于 y_true 中的那些。

返回:

损失浮点数或包含计算指标值的1列pd.DataFrame

如果 multioutput = “raw_values”，metric 总是对 fh 值进行平均（算术）。

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

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

条目将对输出变量列进行平均

如果 score_average = False，

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

如果 score_average = True,

条目将根据分位数/区间列进行平均

clone()

获取具有相同超参数的对象副本。

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

引发:

如果克隆不符合规范，由于 __init__ 存在错误，将引发 RuntimeError。

注释

如果成功，值等于 type(self)(**self.get_params(deep=False))。

clone_tags(estimator, tag_names=None)

从另一个估计器克隆标签作为动态覆盖。

参数:

估计器继承自 BaseEstimator 的估计器

标签名称str 或 str 列表，默认 = None

要克隆的标签名称。如果为 None，则使用估计器中的所有标签作为 tag_names。

返回:

自我

自我引用。

注释

通过在 tag_set 中设置来自估计器的标签值，更改对象状态为动态标签在 self 中。

classmethod create_test_instance(parameter_set='default')

如果可能，构造估计器实例。

参数:

参数集str, 默认值=”default”

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

返回:

实例使用默认参数的类实例

注释

get_test_params 可以返回字典或字典列表。此函数获取 get_test_params 返回的第一个或单个字典，并使用该字典构造对象。

classmethod create_test_instances_and_names(parameter_set='default')

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

参数:

参数集str, 默认值=”default”

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

返回:

objscls 实例列表

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

名称list of str, 与 objs 长度相同

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

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

在给定的输入上评估所需的指标。

参数:

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

地面真值（正确的）目标值。

y_pred概率预测方法返回对象的科学类型：y_pred

必须在 fh 并且对于等于 y_true 中的那些变量的变量

多输出字符串 “uniform_average” 或 “raw_values” 决定了多输出结果的处理方式。

返回:

损失浮点数或包含计算指标值的1列pd.DataFrame

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

evaluate_by_index(y_true, y_pred, multioutput='uniform_average', **kwargs)

用于在每个索引处查找评估指标的逻辑。

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

地面真值（正确的）目标值。

y_predsktime 与 y_true 形状相同的基分布

预测分布。必须与 y_true 具有相同的索引和列。

返回:

损失 : pd.Series 或 pd.DataFramepd.Series 或 pd.DataFrame

按时间点计算的指标（默认=刀切伪值）。

pd.Series 如果 self.multioutput="uniform_average" 或类数组对象

• index 等于 y_true 的索引

• 索引 i 处的条目是时间 i 处的度量，在变量上取平均值

pd.DataFrame 如果 self.multioutput="raw_values"

• 索引和列与 y_true 相同

• i,j-th 条目是时间 i 处的变量 j 的度量

classmethod get_class_tag(tag_name, tag_value_default=None)

获取类标签的值。

不返回在实例上定义的动态标签（通过 set_tags 或 clone_tags 设置）的信息。

参数:

标签名称str

标签值的名称。

tag_value_default任何

如果未找到标签，则使用默认/回退值。

返回:

tag_value

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

classmethod get_class_tags()

从类及其所有父类中获取类标签。

从 _tags 类属性中检索标签：值对。不返回在实例上通过 set_tags 或 clone_tags 设置的动态标签信息。

返回:

collected_tagsdict

类标签名称字典：标签值对。通过嵌套继承从 _tags 类属性中收集。

get_config()

获取 self 的配置标志

返回:

config_dictdict

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

classmethod get_param_defaults()

获取对象的参数默认值。

返回:

default_dict: dict[str, Any]

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

classmethod get_param_names(sort=True)

获取对象的参数名称。

参数:

排序bool, 默认=True

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

返回:

param_names: list[str]

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

get_params(deep=True)

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

参数:

深度bool, 默认=True

是否返回组件的参数。

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

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

返回:

参数带有字符串键的字典

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

• 总是：此对象的所有参数，通过 get_param_names 获取的值是该键的参数值，此对象的值始终与构造时传递的值相同。

• 如果 deep=True，还包含组件参数的键/值对，组件的参数被索引为 [组件名称]__[参数名称]，所有 组件名称 的参数都以其值显示为 参数名称。

• 如果 deep=True，还包含任意层级的组件递归，例如，[组件名称]__[组件组件名称]__[参数名称]，等等。

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

从估计器类获取标签值和动态标签覆盖。

参数:

标签名称str

要检索的标签名称

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

如果未找到标签，则使用默认/回退值

raise_error布尔值

当未找到标签时，是否会引发 ValueError

返回:

标签值任何

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

引发:

如果 raise_error 为 True，即如果 tag_name 不在其中，则引发 ValueError

self.get_tags().keys()

get_tags()

从估计器类获取标签和动态标签覆盖。

返回:

collected_tagsdict

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

is_composite()

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

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

返回:

composite: bool

一个对象是否有任何参数的值是 BaseObjects。

classmethod load_from_path(serial)

从文件位置加载对象。

参数:

串行ZipFile(path).open(“object”) 的结果

返回:

反序列化自身，结果输出到 path，通过 cls.save(path)

classmethod load_from_serial(serial)

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

参数:

serial : cls.save(None) 输出的第一个元素输出结果的第一个元素

返回:

反序列化自身，结果输出为 serial，来自 cls.save(None)

reset()

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

使用 reset，使用超参数的当前值（get_params 的结果）运行 __init__。这将移除任何对象属性，除了：

• 超参数 = __init__ 的参数

• 包含双下划线的对象属性，即字符串”__”

类和对象方法，以及类属性也不受影响。

返回:

自身

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

注释

等同于 sklearn.clone 但覆盖 self。在调用 self.reset() 之后，self 的值等于 type(self)(**self.get_params(deep=False))

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

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

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

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

参数:

路径无或文件位置（字符串或路径）

如果为 None，则将 self 保存到内存对象中；如果为文件位置，则将 self 保存到该文件位置。如果：

path=”estimator” 则会在当前工作目录下创建一个名为 estimator.zip 的压缩文件。path=”/home/stored/estimator” 则会在 /home/stored/ 目录下存储一个名为 estimator.zip 的压缩文件。

serialization_format: str, default = “pickle”

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

返回:

如果 path 是 None - 内存中序列化的自身

如果 path 是文件位置 - 带有文件引用的 ZipFile

set_config(**config_dict)

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

参数:

config_dictdict

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

显示str, “diagram” (默认), 或 “text”

jupyter 内核如何显示实例

• “diagram” = html 盒子图表示

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

print_changed_onlybool, 默认=True

是否仅打印与默认值不同的自身参数（False），或打印所有参数名称和值（False）。不嵌套，即仅影响自身，不影响组件估计器。

警告str, “on” (默认), 或 “off”

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

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

• “off” = 不会从 sktime 引发警告

后端:并行str, 可选, 默认=”None”

在广播/矢量化时用于并行化的后端，是以下之一

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

• “loky”, “multiprocessing” 和 “threading”: 使用 joblib.Parallel

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

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

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

返回:

self自我引用。

注释

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

set_params(**params)

设置此对象的参数。

该方法适用于简单估计器以及复合对象。对于复合对象，即包含其他对象的对象，可以使用参数键字符串 <component>__<parameter> 来访问组件 <component> 中的 <parameter>。如果这使得引用明确，例如没有两个组件的参数名称相同，则也可以使用不带 <component>__ 的字符串 <parameter>。

参数:

**参数dict

BaseObject 参数，键必须是 <组件>__<参数> 字符串。如果 get_params 键中唯一，__ 后缀可以别名为完整字符串。

返回:

self引用自身（在参数设置之后）

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

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

通过 estimator.get_params 查找名为 random_state 的参数，并通过 set_params 将其设置为由 random_state 派生的整数。这些整数通过 sample_dependent_seed 的链哈希采样获得，并保证种子随机生成器的伪随机独立性。

根据 self_policy 应用于 estimator 中的 random_state 参数，并且仅当 deep=True 时应用于剩余的组件估计器。

注意：即使 self 没有 random_state，或者没有任何组件有 random_state 参数，也会调用 set_params。因此，set_random_state 将重置任何 scikit-base 估计器，即使它们没有 random_state 参数。

参数:

random_stateint, RandomState 实例或 None, 默认=None

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

深度bool, 默认=True

是否在子估计器中设置随机状态。如果为 False，则仅设置 self 的 random_state 参数（如果存在）。如果为 True，则还会在子估计器中设置 random_state 参数。

self_policystr, 可以是 {“copy”, “keep”, “new”} 之一, 默认值为 “copy”

• “复制” : estimator.random_state 被设置为输入 random_state

• “保持” : estimator.random_state 保持不变

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

源自输入 random_state，并且通常与它不同

返回:

self自我引用

set_tags(**tag_dict)

将动态标签设置为给定值。

参数:

**标签字典dict

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

返回:

自我

自我引用。

注释

通过在 tag_dict 中设置标签值，将对象状态更改为 self 中的动态标签。