对数损失

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

用于分布预测的对数损失。

对于一个概率密度函数为 \(p_d\) 的预测分布 \(d\) 和一个真实值 \(y\)，对数损失定义为 \(L(y, d) := -\log p_d(y)\)。

• evaluate 计算平均测试样本损失。

• evaluate_by_index 按测试数据点生成损失样本。

• multivariate 控制变量间的平均。

参数:

multioutput{‘raw_values’, ‘uniform_average’} 或 形状类似的数组

(n_outputs,)，默认值=’uniform_average’

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

• 如果为 ‘uniform_average’（默认），则误差在变量间进行平均。

• 如果为数组类似，则误差在变量间进行加权平均，数组值为权重。

• 如果为 ‘raw_values’，则误差不在变量间平均，列被保留。

multivariatebool，可选，默认值=False

• 如果为 True，则行为类似于多元对数损失：为整个行计算对数损失，每行结果为一个分数

• 如果为 False，则为单变量对数损失：为每个变量边际计算对数损失，每行结果为多个分数

方法

__call__(y_true, y_pred, **kwargs)	使用底层指标函数计算指标值。
复制()	获取具有相同超参数和配置的对象副本。
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_param_names([sort])	获取对象的参数名称。
get_params([deep])	获取此对象的参数值字典。
get_tag(tag_name[, tag_value_default, ...])	从实例中获取标签值，包含标签级别继承和覆盖。
获取标签()	从实例中获取标签，包含标签级别继承和覆盖。
get_test_params([parameter_set])	检索测试参数。
是否是组合对象()	检查对象是否由其他 BaseObjects 组成。
load_from_path(serial)	从文件位置加载对象。
load_from_serial(serial)	从序列化的内存容器加载对象。
重置()	将对象重置到初始化后的干净状态。
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(parameter_set='default')

检索测试参数。

__call__(y_true, y_pred, **kwargs)

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

参数:

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

真实（正确）目标值。

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

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

返回:

lossfloat 或 包含计算指标值（一个或多个）的单列 pd.DataFrame

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

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

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

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

如果 score_average = False，

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

如果 score_average = True，

条目将在分位数/区间列上进行平均

clone()

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

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

等同于构造 type(self) 的新实例，参数与 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 设置动态标签覆盖。

应仅在对象的 __init__ 方法中、构造期间或通过 __init__ 构造后直接调用 clone_tags 方法。

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

tag_names 的默认值是将 estimator 中的所有标签写入 self。

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

参数:

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

tag_namesstr 或 str 列表，默认值 = None

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

返回:

自身

self 的引用。

classmethod create_test_instance(parameter_set='default')

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

参数:

parameter_setstr，默认值=”default”

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

返回:

instance具有默认参数的类的实例

classmethod create_test_instances_and_names(parameter_set='default')

创建所有测试实例的列表和它们的名称列表。

参数:

parameter_setstr，默认值=”default”

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

返回:

objscls 实例列表

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

namesstr 列表，与 objs 长度相同

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

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

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

参数:

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

真实（正确）目标值。

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

必须在 fh 处，且变量与 y_true 中的变量相等

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

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

• 如果为 ‘uniform_average’（默认），则误差在变量间进行平均。

• 如果为数组类似，则误差在变量间进行加权平均，

数组值为权重。 * 如果为 ‘raw_values’，则误差不在变量间平均，列被保留。

返回:

lossfloat 或 包含计算指标值（一个或多个）的单列 pd.DataFrame

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

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

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

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

真实（正确）目标值。

y_pred与 y_true 形状相同的 sktime BaseDistribution

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

返回:

losspd.Series 或 pd.DataFrame

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

如果 self.multioutput="uniform_average" 或 数组类似，则为 pd.Series

• 索引与 y_true 的索引相同

• 索引 i 处的条目是时间点 i 的指标，在变量上进行了平均

如果 self.multioutput="raw_values"，则为 pd.DataFrame

• 索引和列与 y_true 的相同

• 第 i,j 个条目是时间点 i、变量 j 处的指标

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_namestr

标签值的名称。

tag_value_default任意类型

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

返回:

标签值

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_tagsdict

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

get_config()

获取自身的配置标志。

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

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

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

配置在 clone 或 reset 调用下被保留。

返回:

config_dictdict

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

classmethod get_param_defaults()

获取对象的参数默认值。

返回:

default_dict: dict[str, Any]

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

classmethod get_param_names(sort=True)

获取对象的参数名称。

参数:

sortbool，默认值=True

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

返回:

param_names: list[str]

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

get_params(deep=True)

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

参数:

deepbool，默认值=True

是否返回组件的参数。

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

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

返回:

params键为 str 类型的 dict

参数字典，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_namestr

要检索的标签名称

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

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

raise_errorbool

未找到标签时是否引发 ValueError

返回:

tag_valueAny

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

引发:

如果 raise_error 为 True，则引发 ValueError。

如果 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_tagsdict

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

is_composite()

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

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

返回:

composite: bool

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

classmethod load_from_path(serial)

从文件位置加载对象。

参数:

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

返回:

反序列化自身，生成位于 path 的输出，即 cls.save(path) 的结果

classmethod load_from_serial(serial)

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

参数:

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

返回:

反序列化自身，生成输出 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，则返回内存中的序列化自身；如果 path 是文件位置，则将自身作为 zip 文件存储在该位置

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

参数:

pathNone 或 文件位置 (str 或 Path)

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

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

• path=”/home/stored/estimator”，则将创建 zip 文件 estimator.zip 并

存储在 /home/stored/ 中。

serialization_format: str，默认值 = “pickle”

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

返回:

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

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

set_config(**config_dict)

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

参数:

config_dictdict

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

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

jupyter 内核如何显示自身的实例

• “diagram” = html 框图表示

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

print_changed_onlybool，默认值=True

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

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)

设置此对象的参数。

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

参数:

**paramsdict

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

返回:

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_stateint, RandomState 实例或 None，默认为 None

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

deepbool，默认值=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)

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

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

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

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

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

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

参数:

\*\*tag\_dictdict

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

返回:

Self

对自身的引用。