PlateauFinder

class PlateauFinder(value=nan, min_length=2)

Plateau finder 转换器。

该转换器用于查找时间序列中具有相同给定值（即平台期）的段，并返回其起始索引和长度。

参数:

value{int, float, np.nan, np.inf}

要查找的具有指定值的段

min_lengthint

包含具有相同值的段的最小长度。如果 min_length 设置为 1，该转换器可作为值查找器使用。

属性:

is_fitted

是否已调用 fit 方法。

方法

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])	返回 skbase 对象的测试参数设置。
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()

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

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

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

每个 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 个实例的名称。命名约定为 {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，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 行) | | 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)

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

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

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

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

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

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

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

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

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

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

2. 在父类的 _tags 属性中设置的标签，按继承顺序。

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

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

collected_tagsdict

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

标签名称 : 标签值对的字典。通过嵌套继承从 _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 类型的字典

• 已拟合参数字典，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 值参数）。

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

参数:

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

如果为 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)

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

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

从实例中获取标签值，包括标签级别的继承和覆盖。

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

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

在实例构造时设置。

1. 要检索的标签名称

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

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

3. 在父类的 _tags 属性中设置的标签，按继承顺序。

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

参数:

标签值的名称。

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

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

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

collected_tagsdict

从实例中获取标签，包括标签级别的继承和覆盖。

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

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

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

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

1. 要检索的标签名称

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

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

3. 在父类的 _tags 属性中设置的标签，按继承顺序。

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

返回:

classmethod get_test_params(parameter_set='default')

get_test_params 是一个统一的接口点，用于存储测试目的的参数设置。此函数也用于 create_test_instance 和 create_test_instances_and_names 来构造测试实例。

get_test_params 应返回一个单个 dict，或一个 dict 列表。

返回 skbase 对象的测试参数设置。

每个 dict 都是一个用于测试的参数配置，可用于构造一个“有趣的”测试实例。对于 get_test_params 返回中的所有字典 params，调用 cls(**params) 都应有效。

get_test_params 不必返回固定的字典列表，它也可以返回动态或随机的参数设置。

paramsdict 或 dict 列表，默认值 = {}

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

参数:

parameter_setstr, 默认值=”default”

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

返回:

inverse_transform(X, y=None)

目前假定只有带有以下标签的转换器

scitype:transform-input=”Series”, scitype:transform-output=”Series”,

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

具有 inverse_transform 方法。

访问对象自身

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

deepbool, 默认值=True

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

self.is_fitted，必须为 True

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

• 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

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

返回:

is_composite()

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

composite: bool

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

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

返回:

property is_fitted

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

bool

是否已调用 fit 方法。

估计器是否已 fit。

返回:

classmethod load_from_path(serial)

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

cls.save(path) 后在 path 处生成的反序列化对象

从文件位置加载对象。

参数:

classmethod load_from_serial(serial)

返回:

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

cls.save(None) 后生成的反序列化对象 serial

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

参数:

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

返回:

self

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

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

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

pathNone 或文件位置 (str 或 Path)

如果为 None，对象将被保存到内存中对象；如果 path 是文件位置，则将对象保存到该文件位置。例如，如果

参数:

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

path=”/home/stored/estimator” ，则会在 /home/stored/ 中创建一个 zip 文件 estimator.zip。

• 并保存在 /home/stored/ 中。

• serialization_format: str, 默认值 = “pickle”

存储在 /home/stored/。

serialization_format: str, default = “pickle”

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

返回:

如果 path 是 None - 内存中的序列化对象自身

如果 path 是文件位置 - 指向该文件的 ZipFile

set_config(**config_dict)

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

参数:

get_fitted_params(deep=True)

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

displaystr，可选值为“diagram”（默认）或“text”

jupyter kernel 如何显示对象实例

• “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 的参数，并通过 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 可在多次函数调用中获得可复现的输出。

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

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

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

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

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

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

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

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

参数:

**tag_dictdict

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

返回:

自身

对自身的引用。

transform(X, y=None)

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

deepbool, 默认值=True

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

self.is_fitted，必须为 True

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

• 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

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

返回:

X 的转换版本

类型取决于 X 的类型和 scitype:transform-output 标签

	transform
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，则返回的 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 个窗口。

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

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

deepbool, 默认值=True

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

self.is_fitted，必须为 True

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

• X 的逆转换版本

写入对象自身

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

• 如果 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

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

返回:

self估计器的一个已拟合实例