BaseSupervisedLearningStrategy#

class BaseSupervisedLearningStrategy(estimator, name=None)[source]#

时间序列监督学习的抽象策略类。

接受一个低级估计器来执行给定任务。

实现了时间序列回归和分类的预测（predict）和内部拟合（fit）方法。

属性：
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()

获取自身的配置标志。

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(path)

加载已保存的策略。

load_from_path(serial)

从文件位置加载对象。

load_from_serial(serial)

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

predict(data)

使用给定测试数据进行预测。

reset()

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

save(path)

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

set_config(**config_dict)

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

set_params(**params)

设置此对象的参数。

set_random_state([random_state, deep, ...])

设置自身的 random_state 伪随机种子参数。

set_tags(**tag_dict)

将实例级标签覆盖设置为给定值。
predict(data)[source]#

使用给定测试数据进行预测。

参数：
datapandas.DataFrame

包含在传递给 fit 的任务中指定特征和目标变量的 DataFrame。

返回：
y_predpandas.Series

返回预测值序列。

check_is_fitted(method_name=None)[source]#

检查估计器是否已拟合。

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

如果不是，则引发 NotFittedError。

参数：
method_namestr，可选

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

引发：
NotFittedError

如果估计器尚未拟合。

clone()[source]#

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

克隆是另一个没有共享引用且处于初始化后状态的对象。此函数等同于返回 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)[source]#

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

每个与 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_namesstr 或 str 列表，默认 = None

要克隆的标签名称。None（默认）克隆 estimator 中的所有标签。

返回：
self

对 self 的引用。

classmethod create_test_instance(parameter_set='default')[source]#

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

参数：
parameter_setstr，默认=”default”

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

返回：
instance带有默认参数的类实例
classmethod create_test_instances_and_names(parameter_set='default')[source]#

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

参数：
parameter_setstr，默认=”default”

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

返回：
objscls 实例列表

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

namesstr 列表，与 objs 长度相同

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

property estimator[source]#

只读估计器属性。

fit(task, data)[source]#

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

参数：
taskTask

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

datapandas.DataFrame

包含在任务中指定特征和目标变量的 DataFrame。

返回：
self自身的实例
classmethod get_class_tag(tag_name, tag_value_default=None)[source]#

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

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

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

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

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

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

按继承顺序。

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

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

参数：
tag_namestr

标签值的名称。

tag_value_default任意类型

未找到标签时的默认/回退值。

返回：
tag_value

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

classmethod get_class_tags()[source]#

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

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

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

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

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

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

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

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

按继承顺序。

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

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

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

collected_tagsdict

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

get_config()[source]#

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

获取自身的配置标志。

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

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

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

config_dictdict

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

get_fitted_params(deep=True)[source]#

所需状态

获取已拟合参数。

要求状态为“已拟合”。

deepbool，默认=True

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

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

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

  • fitted_paramsstr 键值的 dict

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

总是：此对象的所有已拟合参数，通过 get_param_names 获取的值是此对象对应键的已拟合参数值

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

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

  • classmethod get_param_defaults()[source]#

获取对象的参数默认值。

default_dict: dict[str, Any]

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

classmethod get_param_names(sort=True)[source]#

获取对象的参数名称。

sortbool，默认=True

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

param_names: list[str]

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

get_params(deep=True)[source]#

是否返回组件的参数。

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

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

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

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

  • paramsstr 键值的 dict

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

总是：此对象的所有参数，通过 get_param_names 获取的值是此对象对应键的参数值，这些值总是与构造时传递的值相同

  • get_tag(tag_name, tag_value_default=None, raise_error=True)[source]#

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

  • classmethod get_param_defaults()[source]#

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

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

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

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

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

  1. 在实例构造时。

要检索的标签名称

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

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

按继承顺序。

参数：
tag_namestr

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

未找到标签时的默认/回退值

raise_errorbool

未找到标签时是否引发 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()[source]#

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

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

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

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

collected_tagsdict

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

  1. 在实例构造时。

要检索的标签名称

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

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

按继承顺序。

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

classmethod get_test_params(parameter_set='default')[source]#

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 列表，默认 = {}

参数：
parameter_setstr，默认=”default”

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

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

is_composite()[source]#

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

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

composite: bool

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

property is_fitted[source]#

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

是否已调用 fit 方法。

bool

返回：
估计器是否已 fit。

load(path)[source]#

path: String

加载已保存的策略。

参数：
策略在磁盘上的保存位置

strategy

返回：
sktime 策略

classmethod load_from_path(serial)[source]#

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

从文件位置加载对象。

参数：
反序列化后的自身，结果位于 path，是 cls.save(path) 的输出
返回：
classmethod load_from_serial(serial)[source]#
serialcls.save(None) 输出的第一个元素

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

参数：
反序列化后的自身，结果为 serial，是 cls.save(None) 的输出
返回：
property name[source]#
reset()[source]#

只读名称属性。

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

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

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

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

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

  • 配置属性，配置不变地保留。也就是说，reset 前后 get_config 的结果相等。

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

等同于 clone，不同之处在于 reset 修改 self，而不是返回一个新对象。

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

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

返回：
self

save(path)[source]#

行为：如果 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”，则会生成一个 zip 文件 estimator.zip

  • 存储在 /home/stored/ 中。

serialization_format: str, default = “pickle”

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

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

返回：
如果 path 是文件位置 - 引用该文件的 ZipFile
set_config(**config_dict)[source]#
配置名称 : 配置值 对的字典。下面列出了有效的配置、值及其含义

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

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

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对 self 的引用。

返回：
注意

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

set_params(**params)[source]#

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

设置此对象的参数。

paramsdict

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

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

返回：
set_random_state(random_state=None, deep=True, self_policy='copy')[source]#
通过 self.get_params 查找名为 random_state 的参数，并通过 set_params 将它们设置为从 random_state 导出的整数。这些整数通过 sample_dependent_seed 的链式哈希采样，保证了种子随机生成器的伪随机独立性。

设置自身的 random_state 伪随机种子参数。

取决于 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 可在多次函数调用中获得可复现的输出。

是否在 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)[source]#
标签是特定于实例 self 的键值对，它们是对象构造后不改变的静态标志。它们可用于元数据检查或控制对象的行为。

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

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

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

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

tag_dictdict

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

参数：
标签名称: 标签值 对的字典。

Self

返回：
对 self 的引用。

本页内容