Filter#

class Filter(sfreq, l_freq=None, h_freq=None, filter_kwargs=None)[source]#

用于过滤 Series 数据的转换器。

FIR、IIR、带通滤波器。

提供了 mne.filter.filter_data 的简单封装。

参数：
sfreq: int 或 float

记录数据的采样频率，单位为 Hz

l_freq: float 或 None

对于 FIR 滤波器，为低通带边缘；对于 IIR 滤波器，为低截止频率。如果为 None，则数据仅进行低通滤波。

h_freq: float 或 None

对于 FIR 滤波器，为高通带边缘；对于 IIR 滤波器，为高截止频率。如果为 None，则数据仅进行高通滤波。

filter_kwargs: dict 或 None

传递给 mne.filter.filter_data 的附加参数。详细描述请参阅 mne.filter.filter_data 文档。

属性：
is_fitted

表示是否已调用 fit。

示例

>>> from sktime.transformations.series.filter import Filter
>>> from sktime.datasets import load_arrow_head
>>> X, y = load_arrow_head(return_X_y=True, return_type="pd-multiindex")
>>> transformer = Filter(sfreq=128, l_freq=0.5, h_freq=40)
>>> X_filtered = transformer.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()

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

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。
classmethod get_test_params(parameter_set='default')[source]#

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

参数：
parameter_setstr，默认为“default”

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

返回：
paramsdict 或 dict 列表，默认为 {}

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

check_is_fitted(method_name=None)[source]#

检查评估器是否已拟合。

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

如果不是，则引发 NotFittedError。

参数：
method_namestr, 可选

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

引发：
NotFittedError

如果评估器尚未拟合。

clone()[source]#

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

克隆是一个没有共享引用的不同对象，处于初始化后状态。此函数等同于返回 sklearn.clone 的 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 个元素是测试中第 i 个 obj 实例的名称。如果多于一个实例，命名约定为 {cls.__name__}-{i}，否则为 {cls.__name__}

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

将转换器拟合到 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 带两级行 MultiIndex (instance, time)，3D np.ndarray (instance, variable, time)，list 的 Series 类型 pd.DataFrame

  • Hierarchical scitype = 分层时间序列集合。pd.DataFrame 带三级或更多级行 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 的转换版本。

状态变化

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

写入自身： _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 带两级行 MultiIndex (instance, time)，3D np.ndarray (instance, variable, time)，list 的 Series 类型 pd.DataFrame

  • Hierarchical scitype = 分层时间序列集合。pd.DataFrame 带三级或更多级行 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 实例）。示例：面板中的所有序列都单独进行去趋势处理

  • 如果 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 的标签值，考虑标签覆盖，优先级从高到低如下：

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

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

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

获取自身的配置标志。

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

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

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

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

返回：
config_dictdict

配置名称 : 配置值对的字典。通过嵌套继承从 _config 类属性收集，然后从 _config_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 的单个标签值，考虑标签覆盖，优先级从高到低如下：

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

在实例构造时。

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

  2. 在父类的 _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 设置的标签。

值是相应的标签值，覆盖顺序优先级从高到低如下：

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

在实例构造时。

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

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

按继承顺序。

返回：
collected_tagsdict

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

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

对 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 带两级行 MultiIndex (instance, time)，3D np.ndarray (instance, variable, time)，list 的 Series 类型 pd.DataFrame

  • Hierarchical scitype = 分层时间序列集合。pd.DataFrame 带三级或更多级行 MultiIndex (hierarchy_1, ..., hierarchy_n, time)

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

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

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

返回：
X 的逆变换版本

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

is_composite()[source]#

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

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

返回：
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") 的结果
返回：
反序列化的自身，结果输出到 path，即 cls.save(path) 的输出
classmethod load_from_serial(serial)[source]#

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

参数：
serialcls.save(None) 输出的第一个元素
返回：
反序列化的自身，结果输出为 serial，即 cls.save(None) 的输出
reset()[source]#

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

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

返回：
self

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

save(path=None, serialization_format='pickle')[source]#

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

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

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

参数：
pathNone 或文件位置 (str 或 Path)

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

  • path="estimator"，则会在当前工作目录创建 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)[source]#

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

参数：
config_dictdict

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

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

jupyter 内核如何显示自身的实例

  • “diagram” = html 框图表示

  • “text” = 字符串输出

print_changed_onlybool, 默认为 True

打印自身时是否仅列出与默认值不同的自身参数（True），或列出所有参数名称和值（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”：布尔值，默认值=True；False 防止 ray

      在并行化后关闭。

    • “logger_name”：字符串，默认值=”ray”；要使用的日志记录器名称。

    • “mute_warnings”：布尔值，默认值=False；如果为 True，则抑制警告

input_conversion字符串，为 “on”（默认）、“off”之一，或有效的 mtype 字符串

控制输入检查和转换，用于 _fit、_transform、_inverse_transform、_update

  • "on" - 执行输入检查和转换

  • "off" - 在将数据传递给内部方法之前不执行输入检查和转换

  • 有效的 mtype 字符串 - 输入被假定为指定的 mtype，执行转换但不执行检查

output_conversion字符串，为 “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)[source]#

设置此对象的参数。

该方法适用于简单的 skbase 对象以及组合对象。参数键字符串 <component>__<parameter> 可用于组合对象（即包含其他对象的对象），以访问组件 <component> 中的 <parameter>。字符串 <parameter> 在不带 <component>__ 的情况下也可以使用，如果这样引用是明确的，例如没有两个组件的参数名称相同都是 <parameter>。

参数：
**params字典

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

返回：
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 中的 random_state 参数，取决于 self_policy，并且仅当 deep=True 时适用于剩余的组件对象。

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

参数：
random_state整数、RandomState 实例或 None，默认值=None

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

deepbool, 默认为 True

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

  • 如果为 False，则仅设置 self 的 random_state 参数（如果存在）。

  • 如果为 True，则也设置组件对象中的 random_state 参数。

self_policy字符串，为 {“copy”, “keep”, “new”} 之一，默认值=”copy”

  • “copy” : self.random_state 被设置为输入的 random_state

  • “keep” : self.random_state 保持不变

  • “new” : self.random_state 被设置为一个新的 random state，

从输入的 random_state 派生，通常与它不同

返回：
self对自身的引用
set_tags(**tag_dict)[source]#

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

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

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

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

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

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

参数：
**tag_dict字典

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

返回：
Self

对自身的引用。

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

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

所需状态

要求状态为“已拟合”。

自身访问

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

  • self.is_fitted，必须为 True

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

要转换的数据。

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

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

  • Panel scitype = 时间序列集合。pd.DataFrame 带两级行 MultiIndex (instance, time)，3D np.ndarray (instance, variable, time)，list 的 Series 类型 pd.DataFrame

  • Hierarchical scitype = 分层时间序列集合。pd.DataFrame 带三级或更多级行 MultiIndex (hierarchy_1, ..., hierarchy_n, time)

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

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

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

返回：
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 实例）。示例：面板中的所有序列都单独进行去趋势处理

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

所需状态

要求状态为“已拟合”。

自身访问

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

  • self.is_fitted，必须为 True

写入自身

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

  • 如果 remember_data 标签为 True，则写入 self._X，通过 update_data 由 X 中的值进行更新。

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

用于更新转换的数据

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

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

  • Panel scitype = 时间序列集合。pd.DataFrame 带两级行 MultiIndex (instance, time)，3D np.ndarray (instance, variable, time)，list 的 Series 类型 pd.DataFrame

  • Hierarchical scitype = 分层时间序列集合。pd.DataFrame 带三级或更多级行 MultiIndex (hierarchy_1, ..., hierarchy_n, time)

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

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

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

返回：
self评估器的拟合实例