BaseObject#

class BaseObject[源代码]#

sktime 中带有标签的参数化对象的基类。

扩展了 skbase BaseObject，增加了额外功能。

方法

`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_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_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)	将实例级标签覆盖设置为给定值。

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”，则会在 /home/stored/ 中存储一个 zip 文件 estimator.zip。

存储在 /home/stored/ 中。

serialization_format: str, default = “pickle”

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

返回:

如果 path 为 None - 内存中的序列化自身
如果 path 是文件位置 - 带有文件引用的 ZipFile

classmethod load_from_serial(serial)[源代码]#

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

参数:

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

返回:

导致输出 serial 的反序列化自身，即 cls.save(None) 的输出

classmethod load_from_path(serial)[源代码]#

从文件位置加载对象。

参数:

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

返回:

导致在 path 输出的反序列化自身，即 cls.save(path) 的输出

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。

抛出:

RuntimeError 如果克隆不符合要求，由于 __init__ 有误。

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_namesstr 或 str 列表, default = None: 要克隆的标签名称。默认值 (None) 克隆 estimator 中的所有标签。

返回:

自身: self 的引用。

classmethod create_test_instance(parameter_set='default')[源代码]#

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

参数:

parameter_setstr, default=”default”: 要返回的测试参数集的名称，用于测试。如果为某个值未定义特殊参数，则返回 “default” 集。

返回:

instance使用默认参数的类实例

classmethod create_test_instances_and_names(parameter_set='default')[源代码]#

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

参数:

parameter_setstr, default=”default”: 要返回的测试参数集的名称，用于测试。如果为某个值未定义特殊参数，则返回 “default” 集。

返回:

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

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

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

它返回名称为 tag_name 的标签值，考虑标签覆盖，优先级从高到低如下：

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

按继承顺序排列。

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

要检索具有潜在实例覆盖的标签值，请使用 get_tag 方法。

参数:

tag_namestr: 标签值的名称。
tag_value_default任意类型: 如果未找到标签，则使用的默认/回退值。

返回:

tag_value: self 中名称为 tag_name 的标签的值。如果未找到，则返回 tag_value_default。

classmethod get_class_tags()[源代码]#

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

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

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

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

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

值是相应的标签值，覆盖优先级从高到低如下：

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

按继承顺序排列。

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

要检索具有潜在实例覆盖的标签，请使用 get_tags 方法。

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

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

返回:

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

get_config()[源代码]#

获取自身的配置标志。

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

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

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

Configs 在 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, default=True: 是否按字母顺序 (True) 返回参数名称，或按它们在类的 __init__ (False) 中出现的顺序返回。

返回:

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

get_params(deep=True)[源代码]#

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

参数:

deepbool, default=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 的单个标签值，考虑标签覆盖，优先级从高到低如下：

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

在实例构建时。

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

按继承顺序排列。

参数:

tag_namestr: 要检索的标签名称
tag_value_default任意类型，可选；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()[源代码]#

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

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

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

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

值是相应的标签值，覆盖优先级从高到低如下：

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

在实例构建时。

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

按继承顺序排列。

返回:

collected_tagsdict: 标签名称：标签值对的字典。通过嵌套继承从 _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) 都应该是有效的。create_test_instance 使用 params 中的第一个（或唯一一个）字典。

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

参数:

parameter_setstr, default=”default”: 要返回的测试参数集的名称，用于测试。如果为某个值未定义特殊参数，则返回 “default” 集。

返回:

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

is_composite()[源代码]#

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

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

返回:

composite: bool: 对象是否具有任何参数，其值为 BaseObject 派生实例。

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

返回:

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

set_config(**config_dict)[源代码]#

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

参数:

config_dictdict

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

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

jupyter 内核如何显示自身实例

“diagram” = html 框图表示
“text” = 字符串打印输出

print_changed_onlybool, default=True

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

warningsstr，“on”（默认），或 “off”

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

“on” = 将发出来自 sktime 的警告
“off” = 将不发出来自 sktime 的警告

backend:parallelstr, 可选, default=”None”

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

“None”：顺序执行循环，简单的列表推导式
“loky”，“multiprocessing” 和 “threading”：使用 joblib.Parallel
“joblib”：自定义和第三方 joblib 后端，例如 spark
“dask”：使用 dask，需要在环境中安装 dask 包
“ray”：使用 ray，需要在环境中安装 ray 包

backend:parallel:paramsdict, 可选, default={} (未传递参数)

作为配置传递给并行化后端的附加参数。有效键取决于 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, default=None

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

deepbool, default=True

是否在值为 skbase 对象的参数中设置随机状态，即组件估计器。

如果为 False，仅设置 self 的 random_state 参数（如果存在）。
如果为 True，也将设置组件对象中的 random_state 参数。

self_policystr, 以下之一 {“copy”, “keep”, “new”}, default=”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: 标签名称：标签值对的字典。

返回:

自身: 自身的引用。