OptionalPassthrough#

class OptionalPassthrough(transformer, passthrough=False)[源代码]#

封装现有转换器，以调整是否将其包含在管道中。

允许调整隐式超参数，即是否在管道（例如 TransformedTargetForecaster）内部使用特定的转换器。这可以通过超参数 passthrough 实现，然后可以将其添加到调优网格中（见示例）。

参数:

transformer评估器

类似于 scikit-learn 或 sktime 的转换器，用于拟合和应用于时间序列。这是一个“蓝图”转换器，当调用 fit 时其状态不会改变

passthroughbool, 默认=False

是否应用给定的转换器，或者只是: 直通数据（恒等转换）。如果为 True，则不应用转换器，OptionalPassthrough 将使用恒等转换。

属性:

transformer_: 转换器，: 当调用 fit 时，这个克隆体会被拟合，并提供 transform 和 inverse（如果 passthrough = False）。如果 passthrough = True，则传递的是 transformer 的克隆体，即恒等转换器 Id

示例

>>> from sktime.datasets import load_airline
>>> from sktime.forecasting.naive import NaiveForecaster
>>> from sktime.transformations.compose import OptionalPassthrough
>>> from sktime.transformations.series.detrend import Deseasonalizer
>>> from sktime.transformations.series.adapt import TabularToSeriesAdaptor
>>> from sktime.forecasting.compose import TransformedTargetForecaster
>>> from sktime.forecasting.model_selection import ForecastingGridSearchCV
>>> from sktime.split import SlidingWindowSplitter
>>> from sklearn.preprocessing import StandardScaler
>>> # create pipeline
>>> pipe = TransformedTargetForecaster(steps=[
...     ("deseasonalizer", OptionalPassthrough(Deseasonalizer())),
...     ("scaler", OptionalPassthrough(TabularToSeriesAdaptor(StandardScaler()))),
...     ("forecaster", NaiveForecaster())])  
>>> # putting it all together in a grid search
>>> cv = SlidingWindowSplitter(
...     initial_window=60,
...     window_length=24,
...     start_with_window=True,
...     step_length=48)  
>>> param_grid = {
...     "deseasonalizer__passthrough" : [True, False],
...     "scaler__transformer__transformer__with_mean": [True, False],
...     "scaler__passthrough" : [True, False],
...     "forecaster__strategy": ["drift", "mean", "last"]}  
>>> gscv = ForecastingGridSearchCV(
...     forecaster=pipe,
...     param_grid=param_grid,
...     cv=cv,
...     n_jobs=-1)  
>>> gscv_fitted = gscv.fit(load_airline())  

方法

`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。

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

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

将转换器拟合到 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")。

参数:

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 类型的 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)[source]#

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

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

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

写入 self：_is_fitted：标志设置为 True。_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 (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 | 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 实例）。示例：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]#

获取自身的配置标志。

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

get_config 返回动态 config，它会覆盖默认 config。

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

Config 在 clone 或 reset 调用中保留。

返回:

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

get_fitted_params(deep=True)[source]#

获取已拟合参数。

所需状态: 要求状态为“已拟合”。

参数:

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

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

参数:

deepbool，默认为 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] 等。

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 对象属性收集任何覆盖和新标签。

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

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

参数:

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

返回:

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

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

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

目前假设只有带有标签: “scitype:transform-input”=”Series”， “scitype:transform-output”=”Series”，

的转换器具有 inverse_transform。

所需状态: 要求状态为“已拟合”。

访问 self 中的属性

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

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

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

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

返回:

composite: bool: 对象的任何参数的值是否为 BaseObject 的后代实例。

property is_fitted[source]#

是否已调用 fit。

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

返回:

bool: 估计器是否已 fit。

classmethod load_from_path(serial)[source]#

从文件位置加载对象。

参数:

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

返回:

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

classmethod load_from_serial(serial)[source]#

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

参数:

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

返回:

反序列化的 self，其输出为 serial，来自 cls.save(None)。

reset()[source]#

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

结果是将 self 设置为其构造函数调用后直接所处的状态，具有相同的超参数。通过 set_config 设置的 config 值也会保留。

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

超参数 = 写入 self 的 __init__ 参数，例如 self.paramname，其中 paramname 是 __init__ 的一个参数。
包含双下划线（即字符串“__”）的对象属性。例如，名为“__myattr”的属性将被保留。
config 属性，configs 会保留不变。也就是说，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”，则将在当前工作目录创建 zip 文件 estimator.zip。
path=”/home/stored/estimator”，则 zip 文件 estimator.zip 将被

存储在 /home/stored/ 中。

serialization_format: str，默认为“pickle”

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

返回:

如果 path 为 None - 内存中的序列化 self
如果 path 是文件位置 - 指向文件的 ZipFile

set_config(**config_dict)[source]#

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

参数:

config_dictdict

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

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

jupyter kernels 如何显示 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，可选，默认为 {} (未传递参数)

作为 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，默认为 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 中的 configs 复制到 self._config_dynamic。

set_params(**params)[source]#

设置此对象的参数。

此方法适用于简单的 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')[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 中指定的值，其中键是标签名称，dict 值是要设置的标签值。

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

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

参数:

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

返回:

Self: 对 self 的引用。

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

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

所需状态: 要求状态为“已拟合”。

访问 self 中的属性

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

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 类型的 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	-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 实例）。示例：Panel 中的所有时间序列都单独去趋势。

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

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

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

则返回值为类型为 pd-multiindex 的 Panel 对象。示例：输出的第 i 个实例是作用于 X 的第 i 个窗口。

（注意：这里似乎缺少表格的其余行，但 HTML 源只提供了这些）

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

所需状态: 要求状态为“已拟合”。

访问 self 中的属性

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

self.is_fitted，必须为 True

写入 self

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

如果 remember_data 标签为 True，则通过 update_data 将 X 中的值更新到 self._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 类型的 Series pd.DataFrame。
Hierarchical scitype = 时间序列分层集合。pd.DataFrame 带有 3 级或更多级行 MultiIndex (hierarchy_1, ..., hierarchy_n, time)。

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

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

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

返回:

self估计器的已拟合实例