ADICVTransformer#

class ADICVTransformer(features=None, adi_threshold=1.32, cv_threshold=0.49, adi_trim_handling='pool')[source]#

根据 Syntetos/Boylan 的方法，将时间序列分类到 ADI-CV2 类别中的变换器。

将时间序列转换为类别标签，标签是以下之一："smooth"（平滑）, "erratic"（不稳定）, "intermittent"（间歇性）或 "lumpy"（波动大）。

这些标签基于时间序列的平均需求间隔 (ADI) 和变异系数平方 (CV^2)，使用简单的阈值划分。此外，该变换器可以选择返回 ADI 和 CV^2 的值。

设 \(x_t\) 是时间序列在时间 \(t = 1, 2, \dots, T\) 的值，设 \(N\) 是时间序列中非零值的数量，即 \(N = \text{card}\{t: x_t \neq 0\}\)。

ADI 和 CV^2 的计算方法如下

1. 平均需求间隔 (ADI)：非零需求周期之间的平均周期数，数学定义为

\[ADI = \frac{T}{N}\]

2. 变异系数平方 (CV^2)：CV 是根据时间序列中的非零值计算的。数学定义为

\[CV2 = \frac{1}{N}\sum_{t=1}^{T} x_t^2 - \left(\frac{1}{N}\sum_{t=1}^{T} x_t\right)^2\]

3. 类别：基于 ADI 阈值和 CV^2 阈值对时间序列进行分类。

对于阈值 ADI_threshold 和 CV2_threshold，类别如下

  1. 平滑 (Smooth): 如果 ADI <= adi_threshold 且 CV2 <= cv2_threshold

  2. 不稳定 (Erratic): 如果 ADI <= adi_threshold 且 CV2 > cv2_threshold

  3. 间歇性 (Intermittent): 如果 ADI > adi_threshold 且 cv2 <= cv2_threshold

  4. 波动大 (Lumpy): 如果 ADI > adi_threshold 且 CV2 > cv2_threshold

阈值的默认值取自 Syntetos/Boylan 的论文 [1]，即 adi_threshold = 1.32 和 cv2_threshold = 0.49。也可以通过将它们作为参数传递给变换器来调整。

参数:
adi_threshold浮点数 (默认值 = 1.32)

指定用于时间序列分类的 ADI 阈值

cv2_threshold浮点数 (默认值 = 0.49)

指定用于时间序列分类的 CV2 阈值

features字符串列表 | None (默认值 = [‘adi’, ‘cv2’, ‘class’])

指定要计算的所有特征值

adi_trim_handling: 字符串 (默认值 = pool)

指定处理序列中前导/尾随零的方法。允许的值为 (‘pool’（池化）, ‘trim’（修剪）和 ‘ignore’（忽略）)，它们对应于以下对前导/尾随零的处理方式：pool => L / N trim => (Last N - First N) / N ignore => L / (N - 1)

  • 其中 L 是所有观测值的集合，N 是非零观测值的集合

属性:
is_fitted

是否已调用 fit。

参考

[1]: John E. Boylan, Aris Syntetos: The Accuracy of Intermittent Demand Estimates. International Journal of Forecasting, 1 Apr. 2005

示例

>>> from sktime.transformations.series.adi_cv import ADICVTransformer
>>> from sktime.datasets import load_airline
>>> y = load_airline()
>>> transformer = ADICVTransformer()
>>> y_hat = transformer.fit_transform(y)

方法

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。
check_is_fitted(method_name=None)[source]#

检查估计器是否已拟合。

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

如果不是，则抛出 NotFittedError。

参数:
method_name字符串，可选

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

抛出:
未拟合错误

如果估计器尚未拟合。

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 的对象都有一个标签字典。标签可用于存储有关对象的元数据，或控制对象的行为。

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带有默认参数的类的实例

self
classmethod create_test_instances_and_names(parameter_set='default')[source]#
objscls 实例的列表

创建所有测试实例的列表以及它们的名称列表。

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

instance带有默认参数的类的实例

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

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

测试中第 i 个元素是 obj 的第 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")。

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

参数:
用于拟合变换的数据。

sktime 中的独立数据格式是所谓的 mtype 规范，每个 mtype 实现一个抽象 scitype。

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

  • Panel scitype = 时间序列集合。pd.DataFrame 带有 2 级行 MultiIndex (实例, 时间), 3维 np.ndarray (实例, 变量, 时间), list 包含 Series 类型的 pd.DataFrame

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

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

附加数据，例如用于变换的标签。如果 self.get_tag("requires_y") 为 True，则必须在 fit 中传递，而不是可选。有关所需格式的详细信息，请参阅类文档字符串。

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

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

self
将变换器拟合到 X 和 y，并返回 X 的变换版本。
写入自身：_is_fitted：标志设置为 True。_X：X，X 的强制拷贝，如果 remember_data 标签为 True

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

可能在可能的情况下通过引用强制转换为内部类型或 update_data 兼容类型

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

写入自身

模型属性（以“_”结尾）：取决于估计器

用于拟合变换的数据，以及要变换的数据。

X 的变换版本

参数:
用于拟合变换的数据。

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

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

  • Panel scitype = 时间序列集合。pd.DataFrame 带有 2 级行 MultiIndex (实例, 时间), 3维 np.ndarray (实例, 变量, 时间), list 包含 Series 类型的 pd.DataFrame

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

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

附加数据，例如用于变换的标签。如果 self.get_tag("requires_y") 为 True，则必须在 fit 中传递，而不是可选。有关所需格式的详细信息，请参阅类文档字符串。

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

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

self
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 实例)。示例：面板中的所有序列都分别进行了去趋势

  • 如果 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 的标签值，考虑到标签覆盖，按以下降序优先级排序

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

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

  1. 按继承顺序。

  2. 不考虑实例上的动态标签覆盖，这些动态标签是通过 set_tags 或 clone_tags 在实例上定义的。

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

tag_name字符串

标签值的名称。

参数:
tag_value_default任意类型

如果未找到标签，则为默认/回退值。

tag_value

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

self
classmethod get_class_tags()[source]#

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

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

从类获取类标签，包含来自父类的标签级别继承。

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

clone_tags 从另一个对象 estimator 设置动态标签覆盖。

值是相应的标签值，覆盖优先级按以下降序排列

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

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

  1. 按继承顺序。

  2. 不考虑实例上的动态标签覆盖，这些动态标签是通过 set_tags 或 clone_tags 在实例上定义的。

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

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

collected_tags字典

tag_name字符串

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

get_config()[source]#

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

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

获取自身的配置标志。

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

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

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

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

self
config_dictdict

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

get_fitted_params(deep=True)[source]#

获取拟合参数。

状态要求

要求状态为“已拟合”。

参数:
deepbool, default=True

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

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

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

self
fitted_paramsdict with str-valued keys

已拟合参数的字典，paramname : paramvalue 键值对包含

  • 始终：此对象的所有已拟合参数，通过 get_param_names 获取，值为此对象的该键对应的已拟合参数值

  • 如果 deep=True，还包含组件参数的键/值对，组件参数的索引格式为 [componentname]__[paramname]，componentname 的所有参数都以 paramname 及其值的形式出现

  • 如果 deep=True，还包含任意级别的组件递归，例如 [componentname]__[componentcomponentname]__[paramname] 等

classmethod get_param_defaults()[source]#

获取对象的默认参数。

self
default_dict: dict[str, Any]

键是 cls 在 __init__ 中定义了默认值的所有参数。值是 __init__ 中定义的默认值。

classmethod get_param_names(sort=True)[source]#

获取对象的参数名称。

参数:
sortbool, default=True

是否按字母顺序排序返回参数名称（True），或按它们在类 __init__ 中出现的顺序返回（False）。

self
param_names: list[str]

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

get_params(deep=True)[source]#

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

参数:
deepbool, default=True

是否返回组件的参数。

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

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

self
paramsdict with str-valued keys

参数字典，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 的对象都有一个标签字典。标签可用于存储有关对象的元数据，或控制对象的行为。

clone_tags 从另一个对象 estimator 设置动态标签覆盖。

get_tag 方法从实例中检索名称为 tag_name 的单个标签的值，考虑标签覆盖的优先级如下（从高到低）

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

实例构建时。

  1. 按继承顺序。

  2. 不考虑实例上的动态标签覆盖，这些动态标签是通过 set_tags 或 clone_tags 在实例上定义的。

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

参数:
tag_value_default任意类型

要检索的标签名称

tag_value_defaultany type, optional; default=None

如果找不到标签时的默认/备用值

raise_errorbool

找不到标签时是否抛出 ValueError

self
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 的对象都有一个标签字典。标签可用于存储有关对象的元数据，或控制对象的行为。

clone_tags 从另一个对象 estimator 设置动态标签覆盖。

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

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

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

实例构建时。

  1. 按继承顺序。

  2. 不考虑实例上的动态标签覆盖，这些动态标签是通过 set_tags 或 clone_tags 在实例上定义的。

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

self
collected_tagsdict

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

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

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

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

instance带有默认参数的类的实例

self
paramsdict or list of dict, default = {}

用于创建类的测试实例的参数。每个字典都是构建“有趣”测试用例的参数。

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

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

当前假设只有具有以下标签的变换器

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

具有 inverse_transform 方法。

状态要求

要求状态为“已拟合”。

在 self 中的访问

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

  • self.is_fitted，必须为 True

参数:
用于拟合变换的数据。

sktime 中的独立数据格式是所谓的 mtype 规范，每个 mtype 实现一个抽象 scitype。

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

  • Panel scitype = 时间序列集合。pd.DataFrame 带有 2 级行 MultiIndex (实例, 时间), 3维 np.ndarray (实例, 变量, 时间), list 包含 Series 类型的 pd.DataFrame

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

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

附加数据，例如用于变换的标签。如果 self.get_tag("requires_y") 为 True，则必须在 fit 中传递，而不是可选。有关所需格式的详细信息，请参阅类文档字符串。

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

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

self
X 的逆变换版本

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

is_composite()[source]#

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

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

self
composite: bool

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

property is_fitted[source]#

是否已调用 fit。

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

self
bool

估计器是否已 fit。

classmethod load_from_path(serial)[source]#

从文件位置加载对象。

参数:
serialresult of ZipFile(path).open(“object)
self
反序列化 self，结果位于 path，是 cls.save(path) 的输出
classmethod load_from_serial(serial)[source]#

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

参数:
serial1st element of output of cls.save(None)
self
反序列化 self，结果为 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
对 self 的引用。

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

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

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

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

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

参数:
pathNone or file location (str or Path)

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

  • path=”estimator”，则将在当前工作目录 (cwd) 创建一个 zip 文件 estimator.zip。

  • path=”/home/stored/estimator”，则将在

保存到 /home/stored/。

serialization_format: str, default = “pickle”

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

self
如果 path 为 None - 内存中的序列化 self
如果 path 是文件位置 - 引用该文件的 ZipFile
set_config(**config_dict)[source]#

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

参数:
config_dictdict

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

displaystr, “diagram” (default), or “text”

jupyter 内核如何显示 self 的实例

  • “diagram” = html 方框图表示

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

print_changed_onlybool, default=True

打印 self 时是否仅列出与默认值不同的 self 参数（False），或列出所有参数名称和值（False）。不进行嵌套，即仅影响 self，不影响组件估计器。

warningsstr, “on” (default), or “off”

是否引发警告，仅影响来自 sktime 的警告

  • “on” = 将引发来自 sktime 的警告

  • “off” = 将不引发来自 sktime 的警告

backend:parallelstr, optional, default=”None”

在广播/向量化时用于并行化的后端，以下之一：

  • “None”：顺序执行循环，简单的列表推导

  • “loky”, “multiprocessing” 和 “threading”：使用 joblib.Parallel

  • “joblib”：自定义和第三方 joblib 后端，例如 spark

  • “dask”：使用 dask，需要环境中安装 dask 包

  • “ray”：使用 ray，需要环境中安装 ray 包

backend:parallel:paramsdict, optional, default={} (no parameters passed)

作为配置传递给并行化后端的附加参数。有效键取决于 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_conversionstr, one of “on” (default), “off”, or valid mtype string

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

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

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

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

output_conversionstr, one of “on”, “off”, valid mtype string

控制 _transform、_inverse_transform 的输出转换

  • "on" - 如果 input_conversion 为“on”，则进行输出转换

  • "off" - 直接返回 _transform、_inverse_transform 的输出

  • 有效的 mtype 字符串 - 输出被转换为指定的 mtype

self
selfreference to self.

注意

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

set_params(**params)[source]#

设置此对象的参数。

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

参数:
**paramsdict

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

self
selfreference to self (after parameters have been set)
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 instance or None, default=None

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

deepbool, default=True

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

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

  • 如果为 True，将同时设置组件对象中的 random_state 参数。

self_policystr, one of {“copy”, “keep”, “new”}, default=”copy”

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

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

  • “new” : self.random_state 被设置为一个新的随机状态，

源自输入的 random_state，通常与输入不同

self
selfreference to self
set_tags(**tag_dict)[source]#

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

它从对象返回名称为 tag_name 的标签值，考虑到标签覆盖，按以下降序优先级排序

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

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

set_tags 方法只能在对象的 __init__ 方法中（在构建期间），或通过 __init__ 构建后直接调用。

estimator:class:BaseObject 或派生类的实例

参数:
**tag_dictdict

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

self
Self

对 self 的引用。

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

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

状态要求

要求状态为“已拟合”。

在 self 中的访问

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

  • self.is_fitted，必须为 True

参数:
用于拟合变换的数据。

要变换的数据。

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

  • Panel scitype = 时间序列集合。pd.DataFrame 带有 2 级行 MultiIndex (实例, 时间), 3维 np.ndarray (实例, 变量, 时间), list 包含 Series 类型的 pd.DataFrame

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

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

附加数据，例如用于变换的标签。如果 self.get_tag("requires_y") 为 True，则必须在 fit 中传递，而不是可选。有关所需格式的详细信息，请参阅类文档字符串。

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

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

self
X | tf-output | 返回类型 |
|----------|————–|------------------------| | Series | Primitives | pd.DataFrame (1行) | | Panel | Primitives | pd.DataFrame | | Series | Series | Series | | Panel | Series | Panel | | Series | Panel | Panel |

变换

X

-输出

返回类型

Series

Primitives

pd.DataFrame (1 行)

Panel

Primitives

pd.DataFrame

Series

Series

Series

Panel

Series

Panel

Series

Panel

Panel
明确地说，举例说明
如果 X 是 Series (例如，pd.DataFrame)
且 transform-output 是 Series，则返回是相同 mtype 的单个 Series。示例：对单个序列进行去趋势

  • 如果 X 是 Panel (例如，pd-multiindex) 且 transform-output

是 Series，则返回是具有与 X 相同实例数量的 Panel (变换器应用于每个输入 Series 实例)。示例：面板中的所有序列都分别进行了去趋势

  • 如果 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 的对象都有一个标签字典，用于存储有关对象的元数据。

update(X, y=None, update_params=True)[source]#

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

状态要求

要求状态为“已拟合”。

在 self 中的访问

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

  • self.is_fitted，必须为 True

设置以“_”结尾的拟合模型属性，拟合属性可通过 get_fitted_params 查看。

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

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

参数:
用于拟合变换的数据。

用于更新变换的数据

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

  • Panel scitype = 时间序列集合。pd.DataFrame 带有 2 级行 MultiIndex (实例, 时间), 3维 np.ndarray (实例, 变量, 时间), list 包含 Series 类型的 pd.DataFrame

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

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

附加数据，例如用于变换的标签。如果 self.get_tag("requires_y") 为 True，则必须在 fit 中传递，而不是可选。有关所需格式的详细信息，请参阅类文档字符串。

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

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

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