DWTTransformer#

class DWTTransformer(num_levels=3)[源码]#

离散小波变换转换器。

对时间序列执行 Haar 小波变换。

参数：
num_levelsint，执行 Haar 小波变换的层数。

转换。

属性：
is_fitted

是否已调用 fit 方法。

示例

>>> from sktime.transformations.panel.dwt import DWTTransformer
>>> from sktime.datasets import load_airline
>>> from sktime.datatypes import convert
>>>
>>> y = load_airline()
>>> transformer = DWTTransformer(num_levels=3)
>>> y_transformed = transformer.fit_transform(y)

方法

check_is_fitted([method_name])

检查评估器是否已拟合。

clone()

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

clone_tags(estimator[, tag_names])

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

create_test_instance([parameter_set])

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

create_test_instances_and_names([parameter_set])

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

fit(X[, y])

对 X 进行拟合转换，y 可选。

状态更改

将状态更改为“已拟合”。

写入 self

设置以“_”结尾的拟合模型属性，可通过 get_fitted_params 查看拟合属性。

将 self.is_fitted 标志设置为 True。()

如果 self.get_tag("remember_data") 为 True，则将 X 记忆为 self._X，并强制转换为 self.get_tag("X_inner_mtype")。

X与 sktime 兼容的数据容器格式的时间序列()

用于拟合转换的数据。

sktime 中的单个数据格式是所谓的 mtype 规范，每个 mtype 实现一个抽象的 scitype。

Series scitype = 单个时间序列。pd.DataFrame, pd.Series, 或 np.ndarray (1维或2维)

Panel scitype = 时间序列集合。pd.DataFrame 带有两层行 MultiIndex (instance, time)，3D np.ndarray (instance, variable, time)，list 类型的 Series pd.DataFrame()

Hierarchical scitype = 分层时间序列集合。pd.DataFrame 带有三层或更多层行 MultiIndex (hierarchy_1, ..., hierarchy_n, time)

有关数据格式的更多详细信息，请参阅 mtype 的术语表。有关用法，请参阅转换器教程 examples/03_transformers.ipynb。

y可选，sktime 兼容数据格式的数据，默认值为 None

额外数据，例如转换的标签。如果 self.get_tag("requires_y") 为 True，则必须在 fit 中传递，非可选。有关所需格式，请参阅类文档字符串以获取详细信息。

self评估器的已拟合实例

fit_transform(X, y=None)[源码]#

将转换器拟合到 X 和 y，并返回 X 的转换版本。

写入 self: _is_fitted : 标志设置为 True。_X : X 的强制拷贝，如果 remember_data 标签为 True()

可能在可能的情况下强制转换为内部类型或 update_data 兼容类型（通过引用）

模型属性（以“_”结尾）: 取决于评估器

用于拟合转换的数据，以及要转换的数据。

X 的转换版本

类型取决于 X 的类型和 scitype:transform-output 标签

X | tf-output | 返回类型 |()

|----------|————–|------------------------| | Series | Primitives | pd.DataFrame (1行) | | Panel | Primitives | pd.DataFrame | | Series | Series | Series | | Panel | Series | Panel | | Series | Panel | Panel |

返回中的实例对应于 X 中的实例

表中未列出的组合目前不支持

具体说明，附带示例

如果 X 是 Series (例如，pd.DataFrame)

并且 transform-output 是 Series，则返回是相同 mtype 的单个 Series。示例：对单个序列进行去趋势()

如果 X 是 Panel (例如，pd-multiindex) 并且 transform-output

是 Series，则返回是与 X 具有相同实例数量的 Panel（转换器应用于每个输入的 Series 实例）。示例：面板中的所有序列都被单独去趋势

如果 X 是 Series 或 Panel 并且 transform-output 是

Primitives，则返回是 pd.DataFrame，其行数与 X 中的实例数相同。示例：返回的第 i 行具有第 i 个序列的均值和方差

如果 X 是 Series 并且 transform-output 是 Panel，

则返回是类型为 pd-multiindex 的 Panel 对象。示例：输出的第 i 个实例是在 X 上运行的第 i 个窗口

classmethod get_class_tag(tag_name, tag_value_default=None)[源码]#

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

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()[源码]#

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

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

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

值是对应的标签值，覆盖的优先级降序排列如下：

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

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

self 中 tag_name 标签的值。如果未找到，则返回 tag_value_default。
collected_tagsdict
标签名称 : 标签值对的字典。通过嵌套继承从 _tags 类属性收集。不受 set_tags 或 clone_tags 设置的动态标签覆盖。

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

get_config()[源码]#

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

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

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

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

config_dictdict

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

参数：
get_fitted_params(deep=True)[源码]#
所需状态

需要状态为“已拟合”。

deepbool，默认值为 True
是否返回组件的已拟合参数。

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

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

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

参数：
fitted_params键为 str 类型的字典

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

deepbool，默认值为 True
总是：此对象的所有已拟合参数，通过 get_param_names 获取，值为该键的已拟合参数值，属于此对象
如果 deep=True，还包含组件参数的键/值对，组件参数以 [componentname]__[paramname] 索引，componentname 的所有参数以 paramname 及其值的形式出现

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

参数：
fitted_params键为 str 类型的字典

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

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

classmethod get_param_defaults()[源码]#

获取对象的参数默认值。

default_dict: dict[str, Any]

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

对 X 进行拟合转换，y 可选。

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)[源码]#

是否返回组件的参数。

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

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

  • params键为 str 类型的字典

  • 参数字典，paramname : paramvalue 键值对包含

总是：此对象的所有参数，通过 get_param_names 获取，值为该键的参数值，属于此对象，值总是与构造时传递的值相同

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

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

deepbool，默认值为 True
get_tag(tag_name, tag_value_default=None, raise_error=True)[源码]#
get_tag 方法从实例中检索名为 tag_name 的单个标签的值，考虑了标签覆盖，优先级降序排列如下：

将状态更改为“已拟合”。

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

classmethod get_param_names(sort=True)[源码]#

获取对象的参数名称。

在实例构造时。

要检索的标签名称

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

参数：
get_params(deep=True)[源码]#

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

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

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

  • params键为 str 类型的字典

  • 参数字典，paramname : paramvalue 键值对包含

总是：此对象的所有参数，通过 get_param_names 获取，值为该键的参数值，属于此对象，值总是与构造时传递的值相同

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

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

deepbool，默认值为 True
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()[源码]#

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

collected_tagsdict

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

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

  • 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 不必返回固定的字典列表，它也可以返回动态或随机参数设置。

paramsdict 或 list of dict，默认值 = {}

设置以“_”结尾的拟合模型属性，可通过 get_fitted_params 查看拟合属性。

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

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

inverse_transform(X, y=None)[源码]#

  1. 逆转换 X 并返回逆转换后的版本。

  2. 目前假定只有带有标签的转换器

“scitype:transform-input”=”Series”， “scitype:transform-output”=”Series”，

具有 inverse_transform 方法。

在 self 中访问

参数：
以“_”结尾的已拟合模型属性。

self.is_fitted，必须为 True

额外数据，例如转换的标签。一些转换器需要此数据，详细信息请参阅类文档字符串。

X 的逆转换版本

deepbool，默认值为 True
与 X 类型相同，并符合 mtype 格式规范

is_composite()[源码]#

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

如果 self.get_tag("remember_data") 为 True，则将 X 记忆为 self._X，并强制转换为 self.get_tag("X_inner_mtype")。

get_config()[源码]#

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

composite: bool

对象是否有任何参数的值是 BaseObject 的子类实例。

property is_fitted[源码]#

  1. 逆转换 X 并返回逆转换后的版本。

  2. 目前假定只有带有标签的转换器

“scitype:transform-input”=”Series”， “scitype:transform-output”=”Series”，

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

bool

具有 inverse_transform 方法。

评估器是否已 fit 拟合。

classmethod load_from_path(serial)[源码]#

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

在 path 处得到的反序列化 self，对应于 cls.save(path) 的输出

用于拟合转换的数据。

classmethod load_from_serial(serial)[源码]#

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

得到输出 serial 的反序列化 self，对应于 cls.save(None) 的输出

reset()[源码]#

deepbool，默认值为 True
将 self 设置为构造函数调用后立即所处的状态，具有相同的超参数。通过 set_config 设置的配置值也会保留。

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

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

Series scitype = 单个时间序列。pd.DataFrame, pd.Series, 或 np.ndarray (1维或2维)

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

配置属性，配置会保留不变。也就是说，get_config 在 reset 前后的结果是相同的。

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

等同于 clone，区别在于 reset 修改 self 而不是返回新对象。

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

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

deepbool，默认值为 True
save(path=None, serialization_format='pickle')[源码]#

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

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

  • pathNone 或文件位置 (str 或 Path)

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

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

path=”/home/stored/estimator”，则 zip 文件 estimator.zip 将

deepbool，默认值为 True
存储到 /home/stored/。

serialization_format: str，默认值 = “pickle”

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

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

参数：
如果 path 是文件位置 - 引用文件的 ZipFile

set_config(**config_dict)[源码]#

deepbool，默认值为 True
配置名称 : 配置值对的字典。有效的配置、值及其含义列在下面

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

jupyter 内核如何显示 self 的实例

self评估器的已拟合实例

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

“diagram” = html 方框图表示

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

  • print_changed_onlybool，默认值为 True

deepbool，默认值为 True
打印 self 时是仅列出与默认值不同的 self 参数（False），还是列出所有参数名称和值（False）。不嵌套，即只影响 self 而不影响组件评估器。

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

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

  • “on” = 将引发来自 sktime 的警告

  • “off” = 不会引发来自 sktime 的警告

backend:parallelstr，可选，默认值为“None”

将转换器拟合到 X 和 y，并返回 X 的转换版本。

get_config()[源码]#

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

在广播/向量化时用于并行化的后端，选项包括

  1. “None”：顺序执行循环，简单列表推导

“loky”，“multiprocessing”和“threading”：使用 joblib.Parallel

  1. 逆转换 X 并返回逆转换后的版本。

  2. 目前假定只有带有标签的转换器

“scitype:transform-input”=”Series”， “scitype:transform-output”=”Series”，

参数：
以“_”结尾的已拟合模型属性。

“joblib”：自定义和第三方 joblib 后端，例如 spark

“dask”：使用 dask，需要在环境中安装 dask 包

“ray”：使用 ray，需要在环境中安装 ray 包

backend:parallel:paramsdict，可选，默认值为 {} (未传递参数)

作为配置传递给并行化后端的额外参数。有效键取决于 backend:parallel 的值

deepbool，默认值为 True
tag_value任意

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

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

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

get_tags()[source]#

可能在可能的情况下强制转换为内部类型或 update_data 兼容类型（通过引用）

get_config()[源码]#

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

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

property is_fitted[源码]#

  1. “None”：顺序执行循环，简单列表推导

“loky”，“multiprocessing”和“threading”：使用 joblib.Parallel

  1. 逆转换 X 并返回逆转换后的版本。

  2. 目前假定只有带有标签的转换器

“scitype:transform-input”=”Series”， “scitype:transform-output”=”Series”，

deepbool，默认值为 True
collected_tags字典

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

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

用于拟合转换的数据，以及要转换的数据。

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

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

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

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

参数：
fitted_params键为 str 类型的字典

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

deepbool，默认值为 True
params字典或字典列表，默认值 = {}

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

inverse_transform(X, y=None)[source]#

类型取决于 X 的类型和 scitype:transform-output 标签

目前假设只有具有以下标签的转换器

“scitype:transform-input”=”Series”, “scitype:transform-output”=”Series”,

拥有 inverse_transform 方法。

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

配置属性，配置会保留不变。也就是说，get_config 在 reset 前后的结果是相同的。

在 self 中访问

  • 以“_”结尾的拟合模型属性。

  • self.is_fitted，必须为 True

参数：
get_params(deep=True)[源码]#

是否返回组件的参数。

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

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

  • params键为 str 类型的字典

  • 参数字典，paramname : paramvalue 键值对包含

总是：此对象的所有参数，通过 get_param_names 获取，值为该键的参数值，属于此对象，值总是与构造时传递的值相同

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

额外数据，例如用于转换的标签。有些转换器需要此项，详情请参阅类文档字符串。

deepbool，默认值为 True
X 的逆转换版本

与 X 的类型相同，并符合 mtype 格式规范

is_composite()[source]#

|----------|————–|------------------------| | Series | Primitives | pd.DataFrame (1行) | | Panel | Primitives | pd.DataFrame | | Series | Series | Series | | Panel | Series | Panel | | Series | Panel | Panel |

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

deepbool，默认值为 True
composite: 布尔值

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

property is_fitted[source]#

是否已调用 fit 方法。

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

deepbool，默认值为 True
布尔值

估计器是否已 fit。

classmethod load_from_path(serial)[source]#

表中未列出的组合目前不支持

参数：
serialZipFile(path).open(“object) 的结果
deepbool，默认值为 True
反序列化的 self，其结果位于 path 处，与 cls.save(path) 的输出相同
classmethod load_from_serial(serial)[source]#

如果 X 是 Series (例如，pd.DataFrame)

参数：
serialcls.save(None) 输出的第一个元素
deepbool，默认值为 True
反序列化的 self，其结果为 serial，与 cls.save(None) 的输出相同
reset()[source]#

如果 X 是 Panel (例如，pd-multiindex) 并且 transform-output

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

deepbool，默认值为 True
是否返回组件的已拟合参数。

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

save(path=None, serialization_format='pickle')[source]#

如果 X 是 Series 或 Panel 并且 transform-output 是

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

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

参数：
pathNone 或文件位置 (str 或 Path)

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

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

  • path=”/home/stored/estimator”，则将在

/home/stored/ 存储一个名为 estimator.zip 的 zip 文件。

serialization_format: str, 默认值 = “pickle”

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

deepbool，默认值为 True
如果 path 为 None - 内存中的序列化 self
如果 path 为文件位置 - 引用该文件的 ZipFile
set_config(**config_dict)[source]#

如果 X 是 Series 并且 transform-output 是 Panel，

参数：
将 self 设置为构造函数调用后立即所处的状态，具有相同的超参数。通过 set_config 设置的配置值也会保留。

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

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

jupyter kernels 如何显示 self 的实例

  • “diagram” = html 方框图表示

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

print_changed_only布尔值, 默认值=True

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

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: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”: 布尔值, 默认值=True; False 阻止 ray 在并行化后

      关闭。

    • “logger_name”: str, 默认值=”ray”; 要使用的日志记录器名称。

    • “mute_warnings”: 布尔值, 默认值=False; 如果为 True，则抑制警告

input_conversionstr, 以下之一：“on”（默认值）、“off” 或 有效的 mtype 字符串

控制输入检查和转换，适用于 _fit、_transform、_inverse_transform、_update

  • "on" - 执行输入检查和转换

  • "off" - 在将数据传递给内部方法之前，不执行输入检查和转换

  • 有效的 mtype 字符串 - 输入被假定为指定的 mtype，执行转换但不执行检查

output_conversionstr, 以下之一：“on”、“off”，有效的 mtype 字符串

控制 _transform、_inverse_transform 的输出转换

  • "on" - 如果 input_conversion 为 “on”，则执行输出转换

  • "off" - 直接返回 _transform、_inverse_transform 的输出

  • 有效的 mtype 字符串 - 输出被转换为指定的 mtype

deepbool，默认值为 True
self对 self 的引用。

备注

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

set_params(**params)[source]#

classmethod get_class_tag(tag_name, tag_value_default=None)[源码]#

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

参数：
**params字典

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

deepbool，默认值为 True
self对 self 的引用（设置参数后）
set_random_state(random_state=None, deep=True, self_policy='copy')[source]#

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

通过 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，并且通常与输入不同

deepbool，默认值为 True
self对 self 的引用
set_tags(**tag_dict)[source]#

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

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

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

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

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

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

参数：
**tag_dict字典

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

deepbool，默认值为 True
Self

对 self 的引用。

transform(X, y=None)[source]#

按继承顺序。

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

配置属性，配置会保留不变。也就是说，get_config 在 reset 前后的结果是相同的。

在 self 中访问

  • 以“_”结尾的拟合模型属性。

  • self.is_fitted，必须为 True

参数：
get_params(deep=True)[源码]#

要转换的数据。

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

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

  • params键为 str 类型的字典

  • 参数字典，paramname : paramvalue 键值对包含

总是：此对象的所有参数，通过 get_param_names 获取，值为该键的参数值，属于此对象，值总是与构造时传递的值相同

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

额外数据，例如用于转换的标签。有些转换器需要此项，详情请参阅类文档字符串。

deepbool，默认值为 True
raise_errorbool
未找到标签时是否抛出 ValueError 异常

transform

X

-输出

返回类型

Series

Primitives

pd.DataFrame（1行）

Panel

Primitives

pd.DataFrame

Series

Series

Series

Panel

Series

Panel

Series

Panel

Panel
ValueError，如果 raise_error 为 True。
如果 tag_name 不在 self.get_tags().keys() 中，则抛出 ValueError 异常。
get_tags()[源码]#

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

collected_tagsdict

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

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

  • 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 不必返回固定的字典列表，它也可以返回动态或随机参数设置。

update(X, y=None, update_params=True)[source]#

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

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

配置属性，配置会保留不变。也就是说，get_config 在 reset 前后的结果是相同的。

在 self 中访问

  • 以“_”结尾的拟合模型属性。

  • self.is_fitted，必须为 True

sortbool，默认值为 True

  • 以“_”结尾的拟合模型属性。

  • 如果 remember_data 标签为 True，则通过 update_data，将值写入由 X 中的值更新的 self._X。

参数：
get_params(deep=True)[源码]#

用于更新转换的数据

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

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

  • params键为 str 类型的字典

  • 参数字典，paramname : paramvalue 键值对包含

总是：此对象的所有参数，通过 get_param_names 获取，值为该键的参数值，属于此对象，值总是与构造时传递的值相同

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

额外数据，例如用于转换的标签。有些转换器需要此项，详情请参阅类文档字符串。

deepbool，默认值为 True
get_tag(tag_name, tag_value_default=None, raise_error=True)[源码]#