TransformIf

class TransformIf(if_estimator, param=None, condition='bool', condition_value=None, then_trafo=None, else_trafo=None)

根据可拟合对象提供的条件，有条件地执行转换器。

用于构建条件执行的转换器的组合器，例如，

• 如果平稳性检验为阳性，则计算一阶差分

• 如果季节性检验为阳性，则去除季节性

该组合器允许指定一个条件以及一个 if/else 转换器。默认的“else”转换器是“不进行转换”。

实现的具体算法如下：

在 fit 方法中，对于输入 X, y： 1. 将 if_estimator 拟合到 X, y 2. 检查 if_estimator 拟合参数 param 的条件

判断 param 是否满足与 condition_value 相关的 condition

3. 如果满足，则将 then_est 拟合到 X, y，并从那时起表现得像 then_est

如果不满足，则将 else_est 拟合到 X, y，并从那时起表现得像 else_est

在其他方法中，如上所述，表现得像 then_est 或 else_est。

注意：then_trafo 和 else_trafo 必须具有相同的输入/输出签名，例如，Series-to-Series 或 Series-to-Primitives。

参数:

if_estimatorsktime 估计器，必须具有 fit 方法

用于拟合和应用于时间序列的 sktime 估计器。这是一个“蓝图”估计器，调用 fit 时其状态不会改变

paramstr，可选，默认 = 拟合的 if_estimator 的第一个布尔参数

conditionstr，可选，默认 = “bool”

定义 self 是表现得像 then_est 还是 else_est 的条件 当且仅当满足以下条件时，此估计器表现得像 then_est： “bool” = 如果 param 为 True “>”, “>=”, “==”, “<”, “<=”, “!=” = 如果 param condition condition_value

condition_value某些条件必需，见上文；否则可选

then_trafosktime 转换器，可选，默认=``if_estimator``

当条件满足时，此转换器表现得像指定的转换器。这是一个“蓝图”转换器，调用 fit 时其状态不会改变

else_trafosktime 转换器，可选，默认=``Id`` (恒等/不进行转换)

当条件不满足时，此转换器表现得像指定的转换器。这是一个“蓝图”转换器，调用 fit 时其状态不会改变

属性:

transformer_转换器，

这个克隆在调用 fit 时被拟合。如果条件满足，则是一个 then_est 的克隆；如果条件不满足，则是一个 else_est 的克隆

condition_bool，

如果条件为真，则为 True；如果条件为假，则为 False

if_estimator_估计器

在调用 fit 时，将拟合 if_estimator 的这个克隆

示例

>>> from sktime.param_est.seasonality import SeasonalityACF
>>> from sktime.transformations.compose import TransformIf
>>> from sktime.transformations.series.detrend import Deseasonalizer
>>> from sktime.datasets import load_airline
>>>
>>> y = load_airline()  
>>>
>>> seasonal = SeasonalityACF(candidate_sp=12)  
>>> deseason = Deseasonalizer(sp=12)  
>>> cond_deseason = TransformIf(seasonal, "sp", "!=", 1, deseason)  
>>> y_hat = cond_deseason.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。
fit_transform(X[, y])	拟合数据，然后转换数据。
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])	返回估计器的测试参数设置。
inverse_transform(X[, y])	对 X 进行逆转换并返回逆转换后的版本。
is_composite()	检查对象是否由其他 BaseObject 组成。
load_from_path(serial)	从文件位置加载对象。
load_from_serial(serial)	从序列化内存容器加载对象。
reset()	将对象重置到干净的初始化后状态。
save([path, serialization_format])	将序列化的 self 保存到字节类对象或 (.zip) 文件。
set_config(**config_dict)	将配置标志设置为给定值。
set_params(**params)	设置此对象的参数。
set_random_state([random_state, deep, ...])	为 self 设置 random_state 伪随机种子参数。
set_tags(**tag_dict)	将实例级标签覆盖设置为给定值。
transform(X[, y])	转换 X 并返回转换后的版本。
update(X[, y, update_params])	使用 X（可选地使用 y）更新转换器。

check_is_fitted(method_name=None)

检查估计器是否已拟合。

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

如果不是，则引发 NotFittedError。

参数:

method_namestr，可选

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

引发:

NotFittedError

如果估计器尚未拟合。

clone()

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

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

等同于使用 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_namesstr 或 str 列表，默认 = None

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

返回:

self

self 的引用。

classmethod create_test_instance(parameter_set='default')

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

参数:

parameter_setstr，默认值=”default”

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

返回:

instance具有默认参数的类实例

classmethod create_test_instances_and_names(parameter_set='default')

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

参数:

parameter_setstr，默认值=”default”

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

返回:

objscls 实例列表

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

namesstr 列表，长度与 objs 相同

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

fit(X, y=None)

将转换器拟合到 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 (1D 或 2D)

• Panel scitype = 时间序列集合。pd.DataFrame，带有 2 级行 MultiIndex (instance, time)，3D np.ndarray (instance, variable, time)，list 包含 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 的转换版本。

状态变化

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

写入 self： _is_fitted：标志设置为 True。 _X：X，X 的强制转换副本，如果 remember_data 标签为 True

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

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

参数:

X采用与 sktime 兼容的数据容器格式的时间序列

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

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 包含 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 | 转换输出 | 返回类型 |

|----------|————–|------------------------| | 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 方法是一个类方法，它仅考虑类级标签值和覆盖来检索标签的值。

1. 它返回对象中名称为 tag_name 的标签的值，考虑到标签覆盖，按以下优先级降序排列：

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

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

按继承顺序排列。

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

参数:

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

tag_namestr

标签值的名称。

tag_value_default任意类型

返回:

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

tag_value

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

从类中获取类标签，带有从父类继承的标签层级。

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

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

classmethod get_class_tags()

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

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

1. 它返回对象中名称为 tag_name 的标签的值，考虑到标签覆盖，按以下优先级降序排列：

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

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

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

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

按继承顺序排列。

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

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

collected_tagsdict

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

获取 self 的配置标志。

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 值的 dict

• 拟合参数字典，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，默认值=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 值的 dict

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

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

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

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

从实例中获取标签值，带有标签层级继承和覆盖。

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

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

get_tag(tag_name, tag_value_default=None, raise_error=True)

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

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

2. 它返回对象中名称为 tag_name 的标签的值，考虑到标签覆盖，按以下优先级降序排列：

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

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

参数:

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

在实例构造时设置的标签。

要检索的标签名称

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。

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

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

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

get_tags()

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

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

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

2. 它返回对象中名称为 tag_name 的标签的值，考虑到标签覆盖，按以下优先级降序排列：

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

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

返回:

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

collected_tagsdict

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

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

inverse_transform(X, y=None)

目前假定只有带有标签

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

get_fitted_params(deep=True)

所需状态

的转换器才具有 inverse_transform 方法。

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

• self.is_fitted，必须为 True

参数:

X采用与 sktime 兼容的数据容器格式的时间序列

用于拟合转换的数据。

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 包含 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: 布尔值

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

property is_fitted

是否已调用 fit 方法。

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

返回:

布尔值

评估器是否已 fit (拟合)。

classmethod load_from_path(serial)

从文件位置加载对象。

参数:

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

返回:

反序列化的自身，其输出位于 path，来自 cls.save(path) 的输出

classmethod load_from_serial(serial)

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

参数:

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

返回:

反序列化的自身，其输出为 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')

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

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

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

参数:

pathNone 或文件位置 (str 或 Path)

如果为 None，则将自身保存为内存对象；如果为文件位置，则将自身保存到该文件位置。如果

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

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

并存储在 /home/stored/ 中。

serialization_format: str，默认 = “pickle”

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

返回:

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

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

set_config(**config_dict)

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

参数:

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

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

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

jupyter kernel 如何显示自身实例

• “diagram” = html 框图表示

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

print_changed_only布尔值，默认=True

打印自身时，是仅列出与默认值不同的自身参数 (当 print_changed_only=True 时)，还是列出所有参数名称和值 (当 print_changed_only=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”：布尔值，默认=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

返回:

self自身的引用。

注意

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

set_params(**params)

设置此对象的参数。

此方法适用于简单的 skbase 对象以及复合对象。对于复合对象（即包含其他对象的对象），可以使用参数键字符串 <component>__<parameter> 来访问组件 <component> 中的 <parameter>。如果引用明确，也可以使用不带 <component>__ 的字符串 <parameter>，例如组件的参数中没有两个具有相同名称 <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 可在多次函数调用中获得可复现的输出。

要求状态为“已拟合”。

是否在 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)

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

classmethod get_class_tag(tag_name, tag_value_default=None)

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

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

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

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

参数:

**tag_dictdict

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

返回:

Self

自身的引用。

transform(X, y=None)

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

get_fitted_params(deep=True)

所需状态

的转换器才具有 inverse_transform 方法。

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

• self.is_fitted，必须为 True

参数:

X采用与 sktime 兼容的数据容器格式的时间序列

要转换的数据。

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 包含 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 标签

	transform
X	- 输出	返回值类型
Series	Primitives	pd.DataFrame（单行）
Panel	Primitives	pd.DataFrame
Series	Series	Series
Panel	Series	Panel
Series	Panel	Panel

| 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，

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

使用 X（可选地使用 y）更新转换器。

get_fitted_params(deep=True)

所需状态

的转换器才具有 inverse_transform 方法。

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

• self.is_fitted，必须为 True

写入 self

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

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

参数:

X采用与 sktime 兼容的数据容器格式的时间序列

用于更新转换的数据

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 包含 Series 类型的 pd.DataFrame

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

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

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

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

返回:

self估计器的已拟合实例

classmethod get_test_params(parameter_set='default')

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

参数:

parameter_setstr，默认值=”default”

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

返回:

paramsdict 或 dict 列表，默认 = {}

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