BaseEstimator

class BaseEstimator

sktime 中定义估计器的基类。

扩展了 sktime 的 BaseObject，包含了可拟合估计器的基本功能。

属性：:

is_fitted

是否已调用过 fit 方法。

方法

check_is_fitted([method_name])	检查估计器是否已拟合。
clone()	获取具有相同超参数和配置的对象的克隆。
clone_tags(estimator[, tag_names])	从另一个对象克隆标签作为动态覆盖。
create_test_instance([parameter_set])	使用第一个测试参数集构造该类的一个实例。
create_test_instances_and_names([parameter_set])	创建所有测试实例的列表及其对应的名称列表。
get_class_tag(tag_name[, tag_value_default])	从类中获取类标签值，并包含来自父类的标签级继承。
get_class_tags()	从类中获取类标签，并包含来自父类的标签级继承。
get_config()	获取自身的配置标志。
get_fitted_params([deep])	获取已拟合的参数。
get_param_defaults()	获取对象的默认参数。
get_param_names([sort])	获取对象的参数名称。
get_params([deep])	获取此对象的参数值字典。
get_tag(tag_name[, tag_value_default, ...])	从实例获取标签值，并包含标签级继承和覆盖。
get_tags()	从实例获取标签，并包含标签级继承和覆盖。
get_test_params([parameter_set])	返回 skbase 对象的测试参数设置。
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)	将实例级标签覆盖设置为给定值。

check_is_fitted(method_name=None)

检查估计器是否已拟合。

检查 _is_fitted 属性是否存在且为 True。在调用对象的 fit 方法时，is_fitted 属性应设置为 True。

如果不是，则会引发 NotFittedError。

参数：:

method_namestr, 可选

调用此方法的名称。如果提供，错误消息将包含此信息。

引发：:

NotFittedError

如果估计器尚未拟合。

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 兼容的对象都有一个标签字典。标签可用于存储关于对象的元数据，或控制对象的行为。

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

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

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

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

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

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

参数：:

tag_namesstr 或 str 列表，默认 = None

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

返回：:

self

对 self 的引用。

classmethod create_test_instance(parameter_set='default')

parameter_setstr，默认值=”default”

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

参数：:

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

instance使用默认参数的类实例

self

classmethod create_test_instances_and_names(parameter_set='default')

objscls 实例的列表

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

参数：:

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

instance使用默认参数的类实例

self

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

namesstr 列表，与 objs 长度相同

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

classmethod get_class_tag(tag_name, tag_value_default=None)

每个与 scikit-base 兼容的对象都有一个标签字典，用于存储关于对象的元数据。

从类中获取类标签值，并包含来自父类的标签级继承。

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

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

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

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

2. 按继承顺序。

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

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

tag_namestr

参数：:

标签值的名称。

tag_value_default任意类型

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

tag_value

self

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

classmethod get_class_tags()

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

从类中获取类标签，并包含来自父类的标签级继承。

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

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

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

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

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

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

2. 按继承顺序。

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

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

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

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

collected_tagsdict

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

get_config()

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

获取自身的配置标志。

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

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

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

config_dictdict

self

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

get_fitted_params(deep=True)

所需状态

获取已拟合的参数。

需要状态为“已拟合”。

deepbool，默认值=True

参数：:

是否返回组件的已拟合参数。

如果为 True，将返回此对象的参数名 : 值字典，包括可拟合组件（= BaseEstimator 值参数）的已拟合参数。

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

• fitted_params键为 str 的 dict

self

已拟合参数的字典，参数名 : 参数值 键值对包括

始终包含：此对象的所有已拟合参数，如同通过 get_param_names 获取的值，它们是此对象该键对应的已拟合参数值

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

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

• classmethod get_param_defaults()

获取对象的默认参数。

default_dict: dict[str, Any]

self

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

classmethod get_param_names(sort=True)

获取对象的参数名称。

sortbool，默认值=True

参数：:

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

param_names: list[str]

self

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

get_params(deep=True)

是否返回组件的参数。

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

参数：:

是否返回组件的已拟合参数。

如果为 True，将返回此对象的参数名 : 值 dict，包括组件的参数（= BaseObject 值参数）。

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

• params键为 str 的 dict

self

参数字典，参数名 : 参数值 键值对包括

始终包含：此对象的所有参数，如同通过 get_param_names 获取的值，它们是此对象该键对应的参数值，这些值始终与构造时传递的值相同

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

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

• classmethod get_param_defaults()

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

从实例获取标签值，并包含标签级继承和覆盖。

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

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

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

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

要检索的标签名称

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

3. 按继承顺序。

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

参数：:

标签值的名称。

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

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

raise_errorbool

未找到标签时是否引发 ValueError

tag_valueAny

self

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

ValueError，如果 raise_error 为 True。

引发：:

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

get_tags()

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

从实例获取标签，并包含标签级继承和覆盖。

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

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

collected_tagsdict

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

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

要检索的标签名称

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

3. 按继承顺序。

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

self

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

classmethod get_test_params(parameter_set='default')

get_test_params 是一个统一的接口点，用于存储测试目的的参数设置。此函数也用于 create_test_instance 和 create_test_instances_and_names 来构建测试实例。

返回 skbase 对象的测试参数设置。

get_test_params 应该返回一个单独的 dict，或一个 dict 的 list。

每个 dict 都是一个用于测试的参数配置，可用于构造一个“有趣”的测试实例。对于 get_test_params 返回中的所有字典 params，调用 cls(**params) 都应该是有效的。

get_test_params 不一定返回固定的字典列表，它也可以返回动态或随机的参数设置。

paramsdict 或 dict 列表，默认 = {}

参数：:

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

instance使用默认参数的类实例

self

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

is_composite()

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

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

composite: bool

self

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

property is_fitted

检查对象的 _is_fitted` 属性，该属性在对象构造期间应初始化为 False，并在调用对象的 fit 方法时设置为 True。

是否已调用过 fit 方法。

bool

self

估计器是否已 fit。

classmethod load_from_path(serial)

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

从文件位置加载对象。

参数：:

反序列化的自身，其结果是 cls.save(path) 在 path 的输出

self

classmethod load_from_serial(serial)

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

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

参数：:

反序列化的自身，其结果是 cls.save(None) 的输出 serial

self

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))`` 后获得的对象相等。

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

self

对 self 的引用。

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

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

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

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

pathNone 或 文件位置 (str 或 Path)

参数：:

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

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

• path=”/home/stored/estimator”，则会在 /home/stored/ 目录下存储一个名为 estimator.zip 的 zip 文件。

• serialization_format: str，默认值 = “pickle”

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

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

如果 path 是文件位置 - 指向文件的 ZipFile

self

set_config(**config_dict)

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

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

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

参数：:

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

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

“diagram” = html 盒图表示

“text” = 字符串打印输出

• print_changed_onlybool，默认值=True

• 打印自身时是仅列出与默认值不同的自身参数 (True)，还是列出所有参数名称和值 (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。

self

set_params(**params)

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

**paramsdict

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

设置此对象的参数。

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

参数：:

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

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 中的 random_state 参数，取决于 self_policy；以及仅当 deep=True 时适用于剩余组件对象。

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

参数：:

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

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

是否返回组件的已拟合参数。

是否在 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

self引用自身

set_tags(**tag_dict)

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

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

标签是特定于实例 self 的键值对，它们是静态标志，在对象构建后不会改变。它们可用于元数据检查或控制对象的行为。

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

set_tags 方法只能在对象的 __init__ 方法中、构建过程中或通过 __init__ 构建后直接调用。

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

参数：:

**tag_dictdict

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

self

自身

引用自身。