TransformByLevel

class TransformByLevel(transformer, groupby='local', raise_warnings=True)

按实例或面板进行变换。

用于按实例或按面板应用 transformer 的多个副本。

如果 groupby="global"，行为与 transformer 相似。如果 groupby="local"，则为每个时间序列实例拟合一个 transformer 克隆。如果 groupby="panel"，则按面板（第一个非时间级别）拟合一个 transformer 克隆。如果级别为 2 或更少，则“global”和“panel”相同；如果只有一个级别（单个时间序列），则所有这三个设置都一致。

如果拟合了多个克隆，拟合的变换器可在 transformers_ 属性中访问，否则可在 transformer_ 属性中访问。

参数:

transformer在 TransformByLevel 中使用的 sktime 变换器

一个“蓝图”变换器，调用 fit 时其状态不会改变。

groupbystr, 可选值为 ["local", "global", "panel"], optional, default=”local”

分组数据的级别，用于拟合 transformer 的克隆。“local”=单元/实例级别，最低层次的每个级别一个缩减模型；“global”=顶层，对忽略级别后的池化数据整体使用一个缩减模型；“panel”=第二最低级别，如果有 2 个或更少的级别，则每个面板级别 (-2) 一个缩减模型。如果只有一个级别（单个时间序列），则所有这三个设置都一致。

raise_warningsbool, optional, default=True

是否在 transformer 是实例级时警告用户。在这种情况下，在 TransformByLevel 中包装 transformer 不会改变估计器逻辑，与不包装相比。以这种方式包装在某些调优情况下可能有意义，此时可以将 warn=False 设置为 True 以抑制警告。

属性:

transformer_sktime 变换器，仅当 groupby 为“global”时存在

用于拟合和变换的 transformer 克隆

transformers_sktime 变换器的 pd.DataFrame，否则存在

条目是用于拟合和变换的 transformer 克隆

示例

>>> from sktime.transformations.compose import TransformByLevel
>>> from sktime.transformations.hierarchical.reconcile import Reconciler
>>> from sktime.utils._testing.hierarchical import _make_hierarchical
>>> X = _make_hierarchical()
>>> f = TransformByLevel(Reconciler(), groupby="panel")
>>> f.fit(X)
TransformByLevel(...)

方法

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。
fit_transform(X[, y])	拟合数据，然后变换数据。
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])	返回估计器的测试参数设置。
inverse_transform(X[, y])	对 X 进行逆变换并返回逆变换后的版本。
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)	将实例级别标签覆盖设置为给定值。
transform(X[, y])	变换 X 并返回变换后的版本。
update(X[, y, update_params])	使用 X，可选使用 y 更新变换器。

classmethod get_test_params(parameter_set='default')

返回估计器的测试参数设置。

参数:

parameter_setstr, default=”default”

要返回的测试参数集的名称，用于测试。如果未为某个值定义特殊参数，将返回 "default" 集。

返回:

paramsdict or list of dict

check_is_fitted(method_name=None)

检查估计器是否已拟合。

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

如果不是，则引发 NotFittedError。

参数:

method_namestr, optional

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

引发:

NotFittedError

如果估计器尚未拟合。

clone()

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

克隆是一个不同的对象，没有共享引用，处于初始化后状态。此函数等同于返回 self 的 sklearn.clone。

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

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

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

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

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

tag_names 的默认行为是将 estimator 中的所有标签写入 self。

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

参数:

estimator:class:BaseObject 或其派生类的实例

tag_namesstr 或 list of str, default = None

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

返回:

self

对 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 个对象的名称。如果实例多于一个，命名约定为 {cls.__name__}-{i}，否则为 {cls.__name__}。

fit(X, y=None)

将变换器拟合到 X，可选拟合到 y。

状态变更

将状态更改为“fitted”。

写入对象自身

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

• 将 self.is_fitted 标志设置为 True。

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

参数:

Xsktime 兼容数据容器格式的时间序列

用于拟合变换的数据。

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

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

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

• Hierarchical scitype = 分层时间序列集合。pd.DataFrame 带 3 级或更多行 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 的变换版本。

状态变更

将状态更改为“fitted”。

写入对象自身：_is_fitted：标志设置为 True。_X：X，如果 remember_data 标签为 True，则是 X 的强制副本

如果可能，可能会通过引用强制转换为内部类型或 update_data 兼容类型

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

参数:

Xsktime 兼容数据容器格式的时间序列

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

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

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

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

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

有关数据格式的更多详情，请参阅 mtype 词汇表。有关用法，请参阅变换器教程 examples/03_transformers.ipynb。

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

额外数据，例如用于变换的标签。如果 self.get_tag("requires_y") 为 True，则必须在 fit 中传入，不可选。有关所需格式，请参阅类文档字符串了解详情。

返回:

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，则返回的 Panel 与 X 具有相同数量的实例（变换器应用于每个输入的 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 的标签的值，考虑标签覆盖，优先级按降序排列如下：

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

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

按继承顺序排列。

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

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

参数:

tag_namestr

标签值的名称。

tag_value_defaultany type

如果未找到标签，则为默认/回退值。

返回:

tag_value

tag_name 标签在 self 中的值。如果未找到，则返回 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_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)

获取拟合参数。

所需状态

要求状态为“fitted”。

参数:

deepbool, default=True

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

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

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

返回:

fitted_paramsdict with str-valued keys

拟合参数的字典，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)

获取对象的参数名称。

参数:

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，但不包括组件参数。

返回:

paramsdict with str-valued keys

参数字典，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_namestr

要检索的标签名称

tag_value_defaultany type, optional; default=None

如果未找到标签，则为默认/回退值

raise_errorbool

未找到标签时是否引发 ValueError

返回:

tag_valueAny

tag_name 标签在 self 中的值。如果未找到，且 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_tagsdict

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

inverse_transform(X, y=None)

对 X 进行逆变换并返回逆变换后的版本。

目前假定只有带有标签的变换器

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

具有 inverse_transform。

所需状态

要求状态为“fitted”。

访问对象自身

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

• self.is_fitted，必须为 True

参数:

Xsktime 兼容数据容器格式的时间序列

用于拟合变换的数据。

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

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

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

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

有关数据格式的更多详情，请参阅 mtype 词汇表。有关用法，请参阅变换器教程 examples/03_transformers.ipynb。

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

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

返回:

X 的逆变换版本

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

is_composite()

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

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

返回:

composite: bool

对象是否具有任何参数，其值是 BaseObject 的派生实例。

property is_fitted

是否已调用 fit。

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

返回:

bool

估计器是否已 fit。

classmethod load_from_path(serial)

从文件位置加载对象。

参数:

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

返回:

反序列化 self，生成位于 path 的输出，该输出由 cls.save(path) 生成。

classmethod load_from_serial(serial)

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

参数:

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

返回:

反序列化 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

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

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

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

行为：如果 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”，则将在 /home/stored/ 中创建一个 zip 文件 estimator.zip。

存储在 /home/stored/ 中。

serialization_format: str, 默认 = “pickle”

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

返回:

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

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

set_config(**config_dict)

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

参数:

config_dictdict

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

displaystr, “diagram” (默认) 或 “text”

jupyter 内核如何显示 self 的实例

• “diagram” = html 框图表示

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

print_changed_onlybool, 默认=True

打印 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: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，则抑制警告

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

返回:

self对 self 的引用。

Notes

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

set_params(**params)

设置此对象的参数。

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

参数:

**paramsdict

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

deepbool, default=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对 self 的引用

set_tags(**tag_dict)

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

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

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

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

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

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

参数:

**tag_dictdict

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

返回:

Self

对 self 的引用。

transform(X, y=None)

变换 X 并返回变换后的版本。

所需状态

要求状态为“fitted”。

访问对象自身

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

• self.is_fitted，必须为 True

参数:

Xsktime 兼容数据容器格式的时间序列

要转换的数据。

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

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

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

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

有关数据格式的更多详情，请参阅 mtype 词汇表。有关用法，请参阅变换器教程 examples/03_transformers.ipynb。

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

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

返回:

X 的变换版本

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

	转换结果
X	-输出	返回类型
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，则返回的 Panel 与 X 具有相同数量的实例（变换器应用于每个输入的 Series 实例）。示例：面板中的所有序列都单独进行去趋势处理

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

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

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

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

update(X, y=None, update_params=True)

使用 X，可选使用 y 更新变换器。

所需状态

要求状态为“fitted”。

访问对象自身

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

• self.is_fitted，必须为 True

写入对象自身

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

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

参数:

Xsktime 兼容数据容器格式的时间序列

用于更新转换的数据

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

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

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

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

有关数据格式的更多详情，请参阅 mtype 词汇表。有关用法，请参阅变换器教程 examples/03_transformers.ipynb。

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

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

返回:

self估计器的拟合实例