PluginParamsTransformer

class PluginParamsTransformer(param_est, transformer, params=None, update_params=False)

将参数估计器中的参数插入到转换器中。

在 fit 中，首先将 param_est 拟合到传入的数据。

• fit 的 X 作为第一个参数传递给 param_est.fit

• fit 的 y 作为第二个参数传递给 param_est.fit（如果 param_est.fit 有第二个参数）。

然后，使用期望/选定的参数执行 transformer.set_params。拟合的 param_est 的参数会传递给 transformer，源/目标对由 self 的 params 参数指定，详见下文。

然后，将 transformer 拟合到在 fit 中传入的数据。

之后，其行为与设置了这些参数的 transformer 完全相同。

示例：使用 param_est 季节性测试确定 sp 参数；使用带有 sp 参数的 transformer，例如 Deseasonalizer。

参数:

param_est带有 fit 方法并继承自 BaseEstimator 的 sktime 估计器对象

例如，继承自 BaseParamFitter 或 transformer 的估计器，这是一个“蓝图”估计器，调用 fit 时其状态不会改变

transformersktime 转换器，即继承自 BaseTransformer 的估计器

这是一个“蓝图”估计器，调用 fit 时其状态不会改变

paramsNone, str, str 列表, 键/值为 str 的字典，可选，默认=None

确定将 param_est 中的哪些参数插入到转换器（trafo）中以及插入位置。 None: param_est 的所有参数都会插入到 transformer 中，只插入在 transformer 和 param_est 中都存在的参数。 list of str: 列表中的参数会插入到同名参数中，只插入在 transformer 和 param_est 中都存在的参数。 str: 被视为只包含该字符串的单元素 str 列表。 dict: 将值为名称的参数插入到键为名称的参数中，只插入在 param_est 中存在键且在 transformer 中存在值的参数。

属性:

param_est_sktime 参数估计器，是 param_est 中估计器的克隆

调用 fit 时，此克隆会在管道中进行拟合

transformer_sktime 转换器，是 transformer 的克隆

调用 fit 时，此克隆会在管道中进行拟合

param_map_字典

参数从 param_est_ 到 transformer_ 的映射，用于 fit 中，过滤掉只在一边存在的参数后

示例

>>> from sktime.datasets import load_airline
>>> from sktime.param_est.plugin import PluginParamsTransformer
>>> from sktime.param_est.seasonality import SeasonalityACF
>>> from sktime.transformations.series.detrend import Deseasonalizer
>>> from sktime.transformations.series.difference import Differencer
>>>
>>> X = load_airline()  
>>>
>>> # sp_est is a seasonality estimator
>>> # ACF assumes stationarity so we concat with differencing first
>>> sp_est = Differencer() * SeasonalityACF()  

>>> # trafo is a forecaster with a "sp" parameter which we want to tune
>>> trafo = Deseasonalizer()  
>>> sp_auto = PluginParamsTransformer(sp_est, trafo)  
>>>
>>> # fit sp_auto to data, transform, and inspect the tuned sp parameter
>>> sp_auto.fit(X)  
PluginParamsTransformer(...)
>>> Xt = sp_auto.transform(X)  
>>> sp_auto.transformer_.get_params()["sp"]  
12
>>> # shorthand ways to specify sp_auto, via dunder, does the same
>>> sp_auto = sp_est * trafo  
>>> # or entire pipeline in one go
>>> sp_auto = Differencer() * SeasonalityACF() * Deseasonalizer()  

使用字典将“foo”参数插入到“sp”中

>>> from sktime.param_est.fixed import FixedParams
>>> sp_plugin = PluginParamsTransformer(
...     FixedParams({"foo": 12}), Deseasonalizer(), params={"sp": "foo"}
... )  

方法

check_is_fitted([method_name])	检查估计器是否已拟合。
克隆()	获取具有相同超参数和配置的对象的克隆。
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_fitted_params([deep])	获取拟合参数。
获取参数默认值()	获取对象的参数默认值。
get_param_names([sort])	获取对象的参数名称。
get_params([deep])	获取此对象的参数值字典。
get_tag(tag_name[, tag_value_default, ...])	从实例获取标签值，带有标签级别继承和覆盖。
获取标签()	从实例获取标签，带有标签级别继承和覆盖。
get_test_params([parameter_set])	返回估计器的测试参数设置。
inverse_transform(X[, y])	逆向转换 X 并返回逆向转换后的版本。
是否为组合对象()	检查对象是否由其他 BaseObjects 组成。
load_from_path(serial)	从文件位置加载对象。
load_from_serial(serial)	从序列化内存容器加载对象。
重置()	将对象重置为干净的初始化后状态。
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" 集。目前转换器没有保留值。

返回:

paramsdict 或 dict 列表，默认 = {}

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

check_is_fitted(method_name=None)

检查估计器是否已拟合。

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

如果不是，则会引发 NotFittedError。

参数:

method_namestr, 可选

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

引发:

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

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

返回:

自身

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

fit(X, y=None)

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

状态变化

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

写入自身

• 设置以“_”结尾的已拟合模型属性，已拟合属性可通过 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 (实例, 时间), 3D np.ndarray (实例, 变量, 时间), Series 类型的 pd.DataFrame 列表

• Hierarchical scitype = 层级时间序列集合。pd.DataFrame 带有 3 级或更多级行 MultiIndex (层级_1, ..., 层级_n, 时间)

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

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

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

返回:

self估计器的已拟合实例

fit_transform(X, y=None)

拟合数据，然后进行转换。

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

状态变化

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

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

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

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

参数:

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

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

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

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

• Panel scitype = 时间序列集合。pd.DataFrame 带有 2 级行 MultiIndex (实例, 时间), 3D np.ndarray (实例, 变量, 时间), Series 类型的 pd.DataFrame 列表

• Hierarchical scitype = 层级时间序列集合。pd.DataFrame 带有 3 级或更多级行 MultiIndex (层级_1, ..., 层级_n, 时间)

有关数据格式的更多详细信息，请参见 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，则返回是与 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 的标签值，考虑标签覆盖，优先级按降序排列：

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

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

按继承顺序。

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

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

参数:

tag_namestr

标签值的名称。

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

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

返回:

标签值

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

获取拟合参数。

所需状态

要求状态为“已拟合”。

参数:

deepbool, 默认=True

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

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

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

返回:

fitted_params键为 str 的字典

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

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

参数:

deepbool, 默认=True

是否返回组件的参数。

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

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

返回:

params键为 str 的字典

参数字典，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_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 设置的标签。

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

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 方法。

所需状态

要求状态为“已拟合”。

访问自身

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

• 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 (实例, 时间), 3D np.ndarray (实例, 变量, 时间), Series 类型的 pd.DataFrame 列表

• Hierarchical scitype = 层级时间序列集合。pd.DataFrame 带有 3 级或更多级行 MultiIndex (层级_1, ..., 层级_n, 时间)

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

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

附加数据，例如用于转换的标签。某些转换器需要此数据，请参见类文档字符串获取详细信息。

返回:

X 的逆向转换版本

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

is_composite()#

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

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

返回:

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

返回:

自身

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

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”，则 zip 文件 estimator.zip 将会

存储在 /home/stored/ 中。

serialization_format: str, default = “pickle”

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

返回:

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

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

set_config(**config_dict)

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

参数:

config_dictdict

config 名称 : config 值 对的字典。有效的 config、值及其含义列在下方

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

jupyter kernel 如何显示 self 的实例

• “diagram” = html 框图表示

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

print_changed_onlybool, default=True

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

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

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

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

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

backend:parallelstr, optional, default=”None”

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

• “None”：顺序执行循环，简单的列表推导式

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

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

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

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

backend:parallel:paramsdict, optional, default={}（不传递参数）

作为 config 传递给并行化后端的附加参数。有效键取决于 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, default=True; False 会阻止 ray

    在并行化后关闭。

  • “logger_name”：str, default=”ray”; 要使用的 logger 的名称。

  • “mute_warnings”：bool, default=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 的引用。

注意

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

set_params(**params)

设置此对象的参数。

此方法适用于简单的 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')

为自身设置 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, 默认=True

是否在 skbase 对象值的参数（即组件估计器）中设置 random state。

• 如果为 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对 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 并返回转换后的版本。

所需状态

要求状态为“已拟合”。

访问自身

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

• 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 (实例, 时间), 3D np.ndarray (实例, 变量, 时间), Series 类型的 pd.DataFrame 列表

• Hierarchical scitype = 层级时间序列集合。pd.DataFrame 带有 3 级或更多级行 MultiIndex (层级_1, ..., 层级_n, 时间)

有关数据格式的更多详细信息，请参见 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，则返回是与 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 个窗口。

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

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

所需状态

要求状态为“已拟合”。

访问自身

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

• 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 (实例, 时间), 3D np.ndarray (实例, 变量, 时间), Series 类型的 pd.DataFrame 列表

• Hierarchical scitype = 层级时间序列集合。pd.DataFrame 带有 3 级或更多级行 MultiIndex (层级_1, ..., 层级_n, 时间)

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

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

附加数据，例如用于转换的标签。某些转换器需要此数据，请参见类文档字符串获取详细信息。

返回:

self估计器的已拟合实例