CFFilter#

class CFFilter(low=6, high=32, drift=True)[source]#

使用 Christiano Fitzgerald 滤波器过滤时间序列。

这是 `statsmodels` 库中 `cffilter` 函数的包装器。(参见 `statsmodels.tsa.filters.cf_filter.cffilter`)。

参数：
low：浮点数，可选，默认值 = 6.0

振荡的最小周期。周期性低于 low 的特征将被过滤掉。对于季度数据，默认值 6 表示 1.5 年的周期性。

high：浮点数，可选，默认值 = 32.0

振荡的最大周期。周期性高于 high 的特征将被过滤掉。对于季度数据，默认值 32 表示 8 年的周期性。

drift：布尔值，可选，默认值 = True

是否从数据中减去趋势。趋势估计为 np.arange(nobs)*(x[-1] -x[0])/(len(x)-1)。 > X：CFFilter._transform() 的参数 > x：如果 X 是一维的，则 X=x。如果是二维的，则 x 被假定为列。 > nobs：len(x)

属性：
is_fitted

是否已调用 `fit` 方法。

示例

>>> from sktime.transformations.series.cffilter import CFFilter 
>>> import pandas as pd 
>>> import statsmodels.api as sm 
>>> dta = sm.datasets.macrodata.load_pandas().data 
>>> index = pd.date_range(start='1959Q1', end='2009Q4', freq='Q') 
>>> dta.set_index(index, inplace=True) 
>>> cf = CFFilter(6, 24, True) 
>>> cycles = cf.fit_transform(X=dta[['realinv']])

方法

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_set：字符串，默认值 = “default”

要返回的测试参数集的名称，用于测试。如果未为某个值定义特殊参数，将返回 "default" 集。目前没有为变换器保留的值。

返回：
params：字典或字典列表，默认值 = {}

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

check_is_fitted(method_name=None)[source]#

检查估计器是否已拟合。

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

如果不是，则引发 NotFittedError。

参数：
method_name：字符串，可选

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

引发：
NotFittedError

如果估计器尚未拟合。

clone()[source]#

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

克隆是一个不同的对象，没有共享引用，处于初始化后状态。此函数等同于返回 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_names：字符串或字符串列表，默认值 = None

要克隆的标签名称。默认值 (`None`) 克隆 estimator 中的所有标签。

返回：
self

self 的引用。

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

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

参数：
parameter_set：字符串，默认值 = “default”

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

返回：
instance：使用默认参数的类的实例
classmethod create_test_instances_and_names(parameter_set='default')[source]#

创建所有测试实例的列表及其名称列表。

参数：
parameter_set：字符串，默认值 = “default”

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

返回：
objs：cls 实例列表

第 i 个实例是 cls(**cls.get_test_params()[i])

names：字符串列表，长度与 objs 相同

第 i 个元素是 objs 中第 i 个实例的名称，用于测试。如果实例多于一个，命名约定为 {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")。

参数：
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)，Series 类型 pd.DataFrame 的 list

  • 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 的变换版本。

状态变更

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

写入自身：_is_fitted：标志设置为 True。_X：X，如果 remember_data 标签为 True，则为 X 的强制副本

如果可能，可能会通过引用强制转换为内部类型或 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)，Series 类型 pd.DataFrame 的 list

  • 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，则返回是行数与 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)[source]#

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

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

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

它从对象中返回名称为 tag_name 的标签值，考虑标签覆盖，优先级从高到低如下：

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

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

按照继承顺序。

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

要检索可能具有实例覆盖的标签值，请改用 get_tag 方法。

参数：
tag_name：字符串

标签值的名称。

tag_value_default：任意类型

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

返回：
tag_value

self 中 tag_name 标签的值。如果找不到，则返回 tag_value_default。

classmethod get_class_tags()[source]#

从类中获取类标签，带有来自父类的标签级别继承。

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

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

get_class_tags 方法是一个类方法，它获取一个标签字典，其中键是类或其任何父类中设置的 _tags 属性的任何键，值是相应的标签值。

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

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

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

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

按照继承顺序。

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

要检索可能具有实例覆盖的标签，请改用 get_tags 方法。

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

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

collected_tags：字典

标签名称 : 标签值 对的字典。通过嵌套继承从 _tags 类属性收集。不受 set_tags 或 clone_tags 设置的动态标签覆盖。

get_config()[source]#

获取自身的配置标志。

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

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

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

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

返回：
config_dict：字典

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

get_fitted_params(deep=True)[source]#

获取已拟合的参数。

所需状态

要求状态为“已拟合”。

参数：
deep：布尔值，默认值 = True

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

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

  • 如果为 False，将返回此对象的参数名称 : 值 字典，但不包括组件的已拟合参数。

返回：
fitted_params：键为字符串的字典

已拟合参数字典， 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]#

获取对象的参数名称。

参数：
sort：布尔值，默认值 = True

是否按字母顺序返回参数名称 (True)，或按其在类的 __init__ 中出现的顺序返回 (False)。

返回：
param_names：list[str]

cls 的参数名称列表。如果 sort=False，则按其在类的 __init__ 中出现的相同顺序排列。如果 sort=True，则按字母顺序排列。

get_params(deep=True)[source]#

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

参数：
deep：布尔值，默认值 = True

是否返回组件的参数。

  • 如果为 True，将返回此对象的参数名称 : 值 的 dict，包括组件（= BaseObject 值参数）的参数。

  • 如果为 False，将返回此对象的参数名称 : 值 的 dict，但不包括组件的参数。

返回：
params：键为字符串的字典

参数字典， 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_name：字符串

要检索的标签名称

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

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

raise_error：布尔值

找不到标签时是否引发 ValueError

返回：
tag_value：任意类型

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_tags：字典

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

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

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

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

“scitype:transform-input”=”Series”， “scitype:transform-output”=”Series”，

具有 inverse_transform 方法。

所需状态

要求状态为“已拟合”。

访问自身

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

  • 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)，Series 类型 pd.DataFrame 的 list

  • 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]#

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

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

返回：
composite：布尔值

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

property is_fitted[source]#

是否已调用 `fit` 方法。

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

返回：
布尔值

估计器是否已 fit。

classmethod load_from_path(serial)[source]#

从文件位置加载对象。

参数：
serial：ZipFile(path).open(“object”) 的结果
返回：
cls.save(path) 在 path 生成的输出的反序列化结果
classmethod load_from_serial(serial)[source]#

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

参数：
serial：cls.save(None) 输出的第 1 个元素
返回：
cls.save(None) 生成的输出 serial 的反序列化结果
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，则返回内存中的序列化 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_dict：字典

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

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

jupyter 内核如何显示 self 的实例

  • “diagram” = html 框图表示

  • “text” = 字符串打印输出

print_changed_onlybool，默认为 True

控制打印 self 时是否只列出与默认值不同的参数 (True)，还是列出所有参数名称和值 (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”；要使用的日志记录器名称。

    • “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(**params)[source]#

设置此对象的参数。

此方法适用于简单的 skbase 对象以及复合对象。参数键字符串 <component>__<parameter> 可用于复合对象（即包含其他对象的对象），以访问组件 <component> 中的 <parameter>。如果 <parameter> 字符串（不带 <component>__）使引用没有歧义（例如，没有两个组件的参数同名 <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 以在多次函数调用中获得可重现的输出。

deep：布尔值，默认值 = 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 进行变换并返回变换后的版本。

所需状态

要求状态为“已拟合”。

访问自身

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

  • 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)，Series 类型 pd.DataFrame 的 list

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

有关数据格式的更多详细信息，请参阅关于 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，则返回是与 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)[source]#

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

所需状态

要求状态为“已拟合”。

访问自身

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

  • self.is_fitted，必须为 True

写入自身

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

  • 如果 remember_data 标签为 True，则通过 update_data 将用 X 中的值更新的数据写入到 self._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)，Series 类型 pd.DataFrame 的 list

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

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

y：可选，sktime 兼容数据格式的数据，默认值 = None

额外数据，例如用于变换的标签。某些变换器需要此数据，详细信息请参见类文档字符串。

返回：
self：估计器的已拟合实例