MultiplexTransformer#

class MultiplexTransformer(transformers: list, selected_transformer=None)[source]#

便于基于AutoML选择最佳转换器。

与TransformedTargetForecaster或ForecastingPipeline以及ForecastingGridSearchCV结合使用时，MultiplexTransformer 提供了一个用于转换器选择的框架。通过选择适当的管道（即 TransformedTargetForecaster 或 ForecastingPipeline），MultiplexTransformer 中的转换器将应用于外生数据或目标数据。

MultiplexTransformer 将所有转换任务（即调用 fit、transform、inverse_transform 和 update）委托给 transformers 中名称与 selected_transformer 匹配的转换器副本。transformers 中的所有其他转换器将被忽略。

参数:

transformerssktime 转换器列表，或

命名 sktime 转换器的元组列表 (str, estimator) MultiplexTransformer 可以在这些转换器之间切换（“多路复用”）。注意 - 传递给“transformers”的所有转换器都应视为蓝图。在 MultiplexTransformer 上调用转换函数不会改变它们的状态。 - 而是创建每个转换器的副本，并更新该副本。

selected_transformer: str 或 None，可选，默认为 None。

如果是 str，必须是转换器名称之一。: 如果在 transformers 中传递的转换器未命名，则 selected_transformer 必须与自动生成的名称字符串一致。要检查自动生成的名称字符串，请调用 get_params。
如果为 None，selected_transformer 默认为第一个转换器的名称: 在 transformers 中。
selected_transformer 表示 MultiplexTransformer: 应表现为（即委托所有相关的转换功能给）

属性:

transformer_sktime 转换器: 由 selected_transformer 命名的转换器副本，所有转换功能都委托给它。
_transformers(name, est) 元组列表，其中 est 是对以下项的直接引用：: 已转为 name/est 元组的 Forecasters。

示例

>>> from sktime.datasets import load_shampoo_sales
>>> from sktime.forecasting.naive import NaiveForecaster
>>> from sktime.transformations.compose import MultiplexTransformer
>>> from sktime.transformations.series.impute import Imputer
>>> from sktime.forecasting.compose import TransformedTargetForecaster
>>> from sktime.forecasting.model_selection import ForecastingGridSearchCV
>>> from sktime.split import ExpandingWindowSplitter
>>> # create MultiplexTransformer:
>>> multiplexer = MultiplexTransformer(transformers=[
...     ("impute_mean", Imputer(method="mean", missing_values = -1)),
...     ("impute_near", Imputer(method="nearest", missing_values = -1)),
...     ("impute_rand", Imputer(method="random", missing_values = -1))])
>>> cv = ExpandingWindowSplitter(
...     initial_window=24,
...     step_length=12,
...     fh=[1,2,3])
>>> pipe = TransformedTargetForecaster(steps = [
...     ("multiplex", multiplexer),
...     ("forecaster", NaiveForecaster())
...     ])
>>> gscv = ForecastingGridSearchCV(
...     cv=cv,
...     param_grid={"multiplex__selected_transformer":
...     ["impute_mean", "impute_near", "impute_rand"]},
...     forecaster=pipe,
...     )
>>> y = load_shampoo_sales()
>>> # randomly make some of the values nans:
>>> y.loc[y.sample(frac=0.1).index] = -1
>>> gscv = gscv.fit(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`()	获取对象的配置标志。
`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`()	检查对象是否为复合对象。
`load_from_path`(serial)	从文件位置加载对象。
`load_from_serial`(serial)	从序列化内存容器加载对象。
`reset`()	将对象重置为干净的初始化后状态。
`save`([path, serialization_format])	将序列化后的对象保存到字节类对象或到 (.zip) 文件。
`set_config`(**config_dict)	将配置标志设置为给定值。
`set_params`(**kwargs)	设置估计器的参数。
`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')[source]#

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

参数:

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

返回:

paramsdict 或 list of dict

check_is_fitted(method_name=None)[source]#

检查估计器是否已拟合。

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

如果不是，则引发 NotFittedError。

参数:

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

引发:

NotFittedError: 如果估计器尚未拟合。

clone()[source]#

获取对象的副本，具有相同的超参数和配置。

克隆是一个不同的对象，没有共享引用，处于初始化后状态。此函数等同于返回 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。

引发:

如果克隆不符合要求（由于 __init__ 有误），则会引发 RuntimeError。

clone_tags(estimator, tag_names=None)[source]#

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

每个与 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')[source]#

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

参数:

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

返回:

instance具有默认参数的类的实例

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

创建所有测试实例的列表以及它们的名称列表。

参数:

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

返回:

objscls 实例列表: 第 i 个实例是 cls(**cls.get_test_params()[i])
namesstr 列表，与 objs 长度相同: 第 i 个元素是测试中 objs 中第 i 个实例的名称。如果实例多于一个，命名约定为 {cls.__name__}-{i}，否则为 {cls.__name__}

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

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

状态改变: 将状态更改为“fitted”。

写入 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 = 时间序列集合。带有 2 级行 MultiIndex (instance, time) 的 pd.DataFrame，3D np.ndarray (instance, variable, time)，list 包含 Series 类型的 pd.DataFrame
Hierarchical scitype = 分层时间序列集合。带有 3 级或更多级行 MultiIndex (hierarchy_1, ..., hierarchy_n, time) 的 pd.DataFrame

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

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

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

返回:

self估计器的拟合实例

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

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

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

状态改变: 将状态更改为“fitted”。

写入 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 = 时间序列集合。带有 2 级行 MultiIndex (instance, time) 的 pd.DataFrame，3D np.ndarray (instance, variable, time)，list 包含 Series 类型的 pd.DataFrame
Hierarchical scitype = 分层时间序列集合。带有 3 级或更多级行 MultiIndex (hierarchy_1, ..., hierarchy_n, time) 的 pd.DataFrame

有关数据格式的更多详细信息，请参阅关于 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 实例）。示例：Panel 中的所有序列都单独去趋势

如果 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)[source]#

从类获取类标签值，并继承父类的标签级别。

每个与 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()[source]#

从类获取类标签，并继承父类的标签级别。

每个与 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()[source]#

获取对象的配置标志。

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

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

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

配置在 clone 或 reset 调用下会保留。

返回:

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

get_fitted_params(deep=True)[source]#

获取拟合参数。

所需状态: 要求状态为“fitted”。

参数:

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

获取对象的默认参数。

返回:

default_dict: dict[str, Any]: 键是 cls 在 __init__ 中定义了默认值的所有参数。值是默认值，如在 __init__ 中定义的那样。

classmethod get_param_names(sort=True)[source]#

获取对象的参数名称。

参数:

sortbool，默认为 True: 是否按字母顺序 (True) 或按它们在类 __init__ 中出现的顺序 (False) 返回参数名称。

返回:

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

get_params(deep=True)[source]#

获取估计器的参数。

参数:

deepboolean，可选: 如果为 True，将返回此估计器及其包含的估计器子对象的参数。

返回:

params从 string 到任意类型的映射: 参数名称映射到其值。

get_tag(tag_name, tag_value_default=None, raise_error=True)[source]#

从实例获取标签值，并应用标签级别继承和覆盖。

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

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

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

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

在构造实例时。

在类的 _tags 属性中设置的标签。
在父类的 _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()[source]#

从实例获取标签，并应用标签级别继承和覆盖。

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

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

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

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

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

在构造实例时。

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

按继承顺序。

返回:

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

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

逆转换 X 并返回逆转换版本。

目前假定只有具有以下标签的转换器: “scitype:transform-input”=”Series”，“scitype:transform-output”=”Series”，

具有 inverse_transform 方法。

所需状态: 要求状态为“fitted”。

访问 self 中的内容

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

self.is_fitted，必须为 True

参数:

X符合 sktime 兼容数据容器格式的时间序列

用于拟合转换的数据。

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

Series scitype = 单个时间序列。pd.DataFrame、pd.Series 或 np.ndarray (1D 或 2D)
Panel scitype = 时间序列集合。带有 2 级行 MultiIndex (instance, time) 的 pd.DataFrame，3D np.ndarray (instance, variable, time)，list 包含 Series 类型的 pd.DataFrame
Hierarchical scitype = 分层时间序列集合。带有 3 级或更多级行 MultiIndex (hierarchy_1, ..., hierarchy_n, time) 的 pd.DataFrame

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

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

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

返回:

X 的逆转换版本: 与 X 类型相同，且符合 mtype 格式规范

is_composite()[source]#

检查对象是否为复合对象。

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

返回:

composite: bool，表示 self 是否包含一个 BaseObject 类型的参数

property is_fitted[source]#

是否已调用 fit。

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

返回:

布尔值: 估计器是否已拟合。

类方法 load_from_path(serial)[source]#

从文件位置加载对象。

参数:

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

返回:

反序列化 self，结果输出到 path，这是 cls.save(path) 的结果。

类方法 load_from_serial(serial)[source]#

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

参数:

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

返回:

反序列化 self，结果输出 serial，这是 cls.save(None) 的结果。

reset()[source]#

将对象重置为干净的初始化后状态。

将 self 设置回构造函数调用后的状态，具有相同的超参数。通过 set_config 设置的配置值也会被保留。

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

超参数 = __init__ 的参数，这些参数被写入 self，例如 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')[source]#

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

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

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

参数:

pathNone 或文件位置 (str 或 Path)

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

path=”estimator”，则会在当前工作目录 (cwd) 创建一个名为 estimator.zip 的 zip 文件。
path=”/home/stored/estimator”，则会创建一个名为 estimator.zip 的 zip 文件并

存储在 /home/stored/ 中。

serialization_format: str, 默认 = “pickle”

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

返回:

如果 path 为 None - 内存中的序列化 self
如果 path 是文件位置 - 引用该文件的 ZipFile 对象

set_config(**config_dict)[source]#

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

参数:

config_dictdict

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

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

jupyter kernel 如何显示 self 的实例

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

print_changed_onlybool, 默认=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: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”；要使用的 logger 名称。
- “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 的引用。

注意

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

set_params(**kwargs)[source]#

设置估计器的参数。

有效的参数键可以通过 get_params() 列出。

返回:

self返回 self 的一个实例。

set_random_state(random_state=None, deep=True, self_policy='copy')[source]#

为对象设置 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，默认为 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)[source]#

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

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

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

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

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

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

参数:

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

返回:

self: 对 self 的引用。

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

转换 X 并返回转换版本。

所需状态: 要求状态为“fitted”。

访问 self 中的内容

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

self.is_fitted，必须为 True

参数:

X符合 sktime 兼容数据容器格式的时间序列

要转换的数据。

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

Series scitype = 单个时间序列。pd.DataFrame、pd.Series 或 np.ndarray (1D 或 2D)
Panel scitype = 时间序列集合。带有 2 级行 MultiIndex (instance, time) 的 pd.DataFrame，3D np.ndarray (instance, variable, time)，list 包含 Series 类型的 pd.DataFrame
Hierarchical scitype = 分层时间序列集合。带有 3 级或更多级行 MultiIndex (hierarchy_1, ..., hierarchy_n, time) 的 pd.DataFrame

有关数据格式的更多详细信息，请参阅关于 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 实例）。示例：Panel 中的所有序列都单独去趋势

如果 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)[source]#

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

所需状态: 要求状态为“fitted”。

访问 self 中的内容

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

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 = 时间序列集合。带有 2 级行 MultiIndex (instance, time) 的 pd.DataFrame，3D np.ndarray (instance, variable, time)，list 包含 Series 类型的 pd.DataFrame
Hierarchical scitype = 分层时间序列集合。带有 3 级或更多级行 MultiIndex (hierarchy_1, ..., hierarchy_n, time) 的 pd.DataFrame

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

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

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

返回:

self估计器的拟合实例