BaseStrategy

class BaseStrategy(estimator, name=None)

抽象基策略类。

实现所有策略共有的属性和操作，包括传入的估计器、数据和任务之间的输入和兼容性检查。

属性:

estimator

只读估计器属性。

is_fitted

是否已调用 fit。

name

只读名称属性。

方法

check_is_fitted([method_name])	检查估计器是否已拟合。
clone()	获取具有相同超参数和配置的对象的克隆。
clone_tags(estimator[, tag_names])	将标签从另一个对象克隆为动态覆盖。
create_test_instance([parameter_set])	使用第一个测试参数集构建该类的实例。
create_test_instances_and_names([parameter_set])	创建所有测试实例的列表及其名称列表。
fit(task, data)	将策略拟合到给定的任务和数据。
get_class_tag(tag_name[, tag_value_default])	从类中获取类标签值，并从父类继承标签级别。
get_class_tags()	从类中获取类标签，并从父类继承标签级别。
get_config()	获取 self 的配置标志。
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()	检查对象是否由其他 BaseObject 组成。
load(path)	加载已保存的策略。
load_from_path(serial)	从文件位置加载对象。
load_from_serial(serial)	从序列化内存容器加载对象。
reset()	将对象重置为干净的初始化后状态。
save(path)	将序列化的 self 保存到字节类对象或 (.zip) 文件。
set_config(**config_dict)	将配置标志设置为给定值。
set_params(**params)	设置此对象的参数。
set_random_state([random_state, deep, ...])	为 self 设置 random_state 伪随机种子参数。
set_tags(**tag_dict)	将实例级标签覆盖设置为给定值。

property name

只读名称属性。

property estimator

只读估计器属性。

fit(task, data)

将策略拟合到给定的任务和数据。

参数:

taskTask

封装特征和目标变量元信息的任务，用于拟合数据。

datapandas.DataFrame

包含任务中指定特征和目标变量的数据框。

返回值:

selfself 的一个实例

save(path)

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

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

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

参数:

pathNone 或文件位置（字符串或 Path）

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

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

• path=”/home/stored/estimator” 则会创建一个 zip 文件 estimator.zip 并将其

存储在 /home/stored/ 中。

serialization_format: str, 默认值 = “pickle”

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

返回值:

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

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

load(path)

加载已保存的策略。

参数:

path: 字符串

策略保存到磁盘上的位置

返回值:

strategy

sktime 策略

check_is_fitted(method_name=None)

检查估计器是否已拟合。

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

如果不是，则引发 NotFittedError。

参数:

method_name字符串, 可选

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

引发:

NotFittedError

如果估计器尚未拟合。

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

对 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__}

classmethod get_class_tag(tag_name, tag_value_default=None)#

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

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

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 的配置标志。

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

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

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

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

返回值:

config_dict字典

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

get_fitted_params(deep=True)#

获取已拟合参数。

所需状态

要求状态为“已拟合”。

参数:

deep布尔值, 默认值=True

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

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

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

返回值:

fitted_params键为字符串的字典

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

• 始终：此对象的所有已拟合参数，如通过 get_param_names 所示，值是该键在此对象中的已拟合参数值

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

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

classmethod get_param_defaults()#

获取对象的默认参数。

返回值:

default_dict: dict[str, Any]

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

classmethod get_param_names(sort=True)#

获取对象的参数名称。

参数:

sort布尔值, 默认值=True

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

返回值:

param_names: list[str]

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

get_params(deep=True)#

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

参数:

deep布尔值, 默认值=True

是否返回组件的参数。

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

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

返回值:

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_value任意类型

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 对象属性的任何覆盖和新标签。

classmethod get_test_params(parameter_set='default')#

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

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

get_test_params 应返回单个 dict 或 dict 的 list。

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

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

参数:

parameter_set字符串, 默认值=”default”

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

返回值:

params字典或字典列表, 默认值 = {}

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

is_composite()#

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

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

返回值:

composite: 布尔值

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

property is_fitted#

是否已调用 fit。

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

返回值:

布尔值

估计器是否已 fit。

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

返回值:

self

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

set_config(**config_dict)#

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

参数:

config_dict字典

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

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

jupyter 内核如何显示 self 的实例

• “diagram” = html 框图表示

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

print_changed_only布尔值, 默认值=True

打印 self 时是仅列出与默认值不同的 self 参数（False），还是列出所有参数名称和值（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”: 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')

为 self 设置 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 可在多次函数调用中获得可重现的输出。

deep布尔值, 默认值=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

指向自身的引用。