IxToX

class IxToX(coerce_to_type='auto', level=None, ix_source='X')

根据时间索引或层级值创建特征。

在 transform 中返回 X 的索引作为转换后的特征。默认情况下，仅返回时间特征。对于层级输入，也可以通过 levels 参数用于选择层级。

对基于 pandas 的容器应用 transform 后返回的列名，如果输入 transform 中的层级有名称，则列名与层级名称相同，否则时间索引列名为 index，层级列名为 level_{N}，其中 N 是层级整数索引。

要添加而不是替换，请使用 FeatureUnion 和/或 + 双下划线方法。

在 coerce_to_type="auto" 的默认设置下

• 日期型索引（包括周期）被强制转换为浮点型（通过 int64），这通常会导致以自 1970 年开始以来的周期为单位的值（第一个周期为 0）

• 对象、字符串和类别索引被强制转换为整数（唯一的类别 ID），整数映射是按类别层级进行的，在 pandas 类别强制转换之后

对于更多自定义选项或直接的 pandas 接口，替代方法是使用 PandasTransformAdaptor 并设置 method="reset_index"。

参数:

coerce_to_typestr，或 dict，可选，默认为“auto”

当传递给 X 时，如何将索引列强制转换为指定类型。默认为“auto”：日期型索引强制转换为浮点型（通过 int64），对象、字符串和类别索引强制转换为整数值，除“auto”以外的值将作为参数传递给 transform 中的 DataFrame.astype

levelNone（默认），int，str，或 pandas 索引层级名称元素的 iterable

如果已传递，则选择将转换为 X 中的列的层级；如果已传递，则在内部作为 level 参数传递给 reset_index；如果为 None，则仅将时间索引（最后一个层级）转换为特征。请注意，这与 reset_index 的默认行为不同。

ix_sourcestr，可选，默认为“X”

从中获取索引的对象。默认为“X”，即传递给 transform 的 X。

如果在 ForecastingPipeline 中使用，默认表示 X

“y” 表示传递给 transform 的 y（如果已传递且不为 None），否则为 X

属性:

is_fitted

是否已调用 fit 方法。

示例

>>> from sktime.datasets import load_airline
>>> from sktime.transformations.compose import IxToX
>>>
>>> X = load_airline()
>>> t = IxToX()
>>> Xt = t.fit_transform(X)

方法

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])	将序列化的对象保存到类似 bytes 的对象或 (.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。 is_fitted 属性应在调用对象的 fit 方法时设置为 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。

抛出:

如果克隆不符合规范，则抛出 RuntimeError，原因在于有缺陷的 __init__。

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 个元素是测试中 objs 中第 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 = 时间序列集合。具有 2 级行 MultiIndex (instance, time) 的 pd.DataFrame，3D np.ndarray (instance, variable, time)，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)

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

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

状态改变

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

写入对象自身：_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 = 时间序列集合。具有 2 级行 MultiIndex (instance, time) 的 pd.DataFrame，3D np.ndarray (instance, variable, time)，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-row) | | 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，则返回的是行数与 X 中实例数量相同的 pd.DataFrame。示例：返回结果的第 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任意类型

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

返回:

tag_value

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()

获取对象的配置标志。

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

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)

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

参数:

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)

从实例中获取标签值，考虑标签继承和覆盖。

每个 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 = 时间序列集合。具有 2 级行 MultiIndex (instance, time) 的 pd.DataFrame，3D np.ndarray (instance, variable, time)，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()

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

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

返回:

composite: bool

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

property is_fitted

是否已调用 fit 方法。

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

返回:

bool

评估器是否已 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 调用会删除任何对象属性，除了

• 超参数 = __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')

将序列化的对象保存到类似 bytes 的对象或 (.zip) 文件中。

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

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

参数:

pathNone 或文件位置 (str 或 Path)

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

• path=”estimator”，则将在当前工作目录 (cwd) 创建一个 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)

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

参数:

config_dictdict

配置名称与配置值对的字典。下面列出了有效的配置、值及其含义

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

jupyter 内核如何显示对象实例

• “diagram” = html 框图表示

• “text” = 字符串输出

print_changed_onlybool，默认为 True

打印对象时，是否仅列出自与默认值不同的自身参数（False），或列出所有参数名称和值（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”：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对自身的引用。

注意

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

set_params(**params)

设置此对象的参数。

此方法适用于简单的 skbase 对象以及组合对象。参数键字符串 <component>__<parameter> 可用于组合对象，即包含其他对象的对象，以访问组件 <component> 中的 <parameter>。如果不导致引用歧义，即没有两个组件参数具有相同的名称 <parameter>，也可以使用不带 <component>__ 的字符串 <parameter>。

参数:

**paramsdict

BaseObject 参数，键必须是 <component>__<parameter> 字符串。__ 后缀可以作为完整字符串的别名，前提是在 get_params 键中是唯一的。

返回:

self对自身的引用（设置参数后）

set_random_state(random_state=None, deep=True, self_policy='copy')

为对象设置 random_state 伪随机种子参数。

通过 self.get_params 查找名为 random_state 的参数，并通过 sample_dependent_seed 将它们设置为从 random_state 派生的整数。这些整数是通过 sample_dependent_seed 从链式哈希中抽取的，并保证种子随机生成器的伪随机独立性。

根据 self_policy，适用于对象本身的 random_state 参数；当且仅当 deep=True 时，适用于其余组件对象的 random_state 参数。

注意：即使对象本身没有 random_state 参数，或任何组件都没有 random_state 参数，也会调用 set_params。因此，set_random_state 将重置任何 scikit-base 对象，即使是那些没有 random_state 参数的对象。

参数:

random_stateint、RandomState 实例或 None，默认为 None

伪随机数生成器，用于控制随机整数的生成。传入 int 可在多次函数调用中获得可复现的输出。

deepbool，默认为 True

是否在 skbase 对象值参数中设置随机状态，即组件估计器。

• 如果为 False，则仅设置对象本身的 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)

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

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

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

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

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

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

参数:

**tag_dictdict

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

返回:

对象本身

对自身的引用。

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 = 时间序列集合。具有 2 级行 MultiIndex (instance, time) 的 pd.DataFrame，3D np.ndarray (instance, variable, time)，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	-输出	返回类型
序列	基本类型	pd.DataFrame (1 行)
面板	基本类型	pd.DataFrame
序列	序列	序列
面板	序列	面板
序列	面板	面板

返回中的实例对应于 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，则返回的是行数与 X 中实例数量相同的 pd.DataFrame。示例：返回结果的第 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 = 时间序列集合。具有 2 级行 MultiIndex (instance, time) 的 pd.DataFrame，3D np.ndarray (instance, variable, time)，Series 类型的 pd.DataFrame 列表

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

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

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

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

返回:

self评估器的已拟合实例