STRAY#

类 STRAY(alpha: float = 0.01, k: int = 10, knn_algorithm: str = 'brute', p: float = 0.5, size_threshold: int = 50, outlier_tail: str = 'max')[source]#

STRAY：概念漂移数据流中的鲁棒异常检测。

这是基于 STRAY (Search TRace AnomalY) _[1] 的，它是 HDoutliers _[2] 的修改版。HDoutliers 是一种强大的算法，用于检测数据集中的异常观测值，它（除其他优点外）能够在不需要系统典型行为模型的情况下检测多维数据中的异常值聚类。然而，它也存在一些影响其准确性的限制。STRAY 是 HDoutliers 的一个扩展，它使用极值理论计算异常阈值，以处理表现出非平稳行为的数据流。

参数:
alphafloat，可选（默认值=0.01）

用于确定异常值截止阈值。如果观测值落在范例之间最近邻距离分布的 (1 - alpha) 尾部，则被视为异常值。

kint，可选（默认值=10）

考虑的邻居数量。

knn_algorithmstr {“auto”, “ball_tree”, “kd_tree”, “brute”}，可选

（默认值=”brute”）用于计算最近邻的算法，来自 sklearn.neighbors.NearestNeighbors

pfloat，可选（默认值=0.5）

可能的异常值候选者的比例。这定义了自底向上搜索算法的起点。

size_thresholdint，可选（默认值=50）

用于计算经验阈值的样本大小。

outlier_tailstr {“min”, “max”}，可选（默认值=”max”）

异常值尾部的方向。

属性:
score_pd.Series

X 中每个数据点的异常值得分。

y_pd.Series

X 中每个数据点的异常值布尔标志。

参考文献

[1]

Talagala, Priyanga Dilini, Rob J. Hyndman, and Kate Smith-Miles.

“高维数据中的异常检测。” Journal of Computational and Graphical Statistics 30.2 (2021): 360-374. .. [R3e8206faf7f3-2] Wilkinson, Leland. “通过分布式聚合可视化大数据异常值。” IEEE transactions on visualization and computer graphics 24.1 (2017): 256-266.

示例

>>> from sktime.detection.stray import STRAY
>>> from sktime.datasets import load_airline
>>> from sklearn.preprocessing import MinMaxScaler
>>> import numpy as np
>>> X = load_airline().to_frame().to_numpy()
>>> scaler = MinMaxScaler()
>>> X = scaler.fit_transform(X)
>>> model = STRAY(k=3)
>>> y = model.fit_transform(X)
>>> y[:5]
array([False, False, False, False, False])

方法

check_is_fitted([method_name])

检查估计器是否已拟合。

克隆()

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

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)

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

重置()

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

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

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

参数:
parameter_setstr，默认值=”default”

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

返回值:
paramsdict 或 list of dict，默认值 = {}

用于创建类测试实例的参数。每个 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。

等同于构造 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_namesstr 或 list of str，默认值 = None

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

返回值:
self

对 self 的引用。

类方法 create_test_instance(parameter_set='default')[source]#

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

参数:
parameter_setstr，默认值=”default”

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

返回值:
instance具有默认参数的类实例
类方法 create_test_instances_and_names(parameter_set='default')[source]#

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

参数:
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)[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 具有 2 级行 MultiIndex (instance, time)，3D np.ndarray (instance, variable, time)，list 类型的 Series pd.DataFrame。

  • Hierarchical scitype = 分层时间序列集合。pd.DataFrame 具有 3 级或更多级行 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 的强制复制，如果 remember_data 标签为 True

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

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

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

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

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

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

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

  • Hierarchical scitype = 分层时间序列集合。pd.DataFrame 具有 3 级或更多级行 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 个窗口。

类方法 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。

类方法 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 类属性收集，然后从 _onfig_dynamic 对象属性收集任何覆盖和新标签。

get_fitted_params(deep=True)[source]#

获取拟合参数。

所需状态

要求状态为“已拟合”。

参数:
deepbool，默认值=True

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

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

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

返回值:
fitted_params键为 str 类型的字典

拟合参数字典，paramname : paramvalue 键值对包括

  • 总是：此对象的所有拟合参数，如通过 get_param_names，值是此对象该键的拟合参数值

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

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

类方法 get_param_defaults()[source]#

获取对象的参数默认值。

返回值:
default_dict: dict[str, Any]

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

类方法 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 类型的字典

参数字典，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 具有 2 级行 MultiIndex (instance, time)，3D np.ndarray (instance, variable, time)，list 类型的 Series pd.DataFrame。

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

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

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

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

返回值:
X 的逆变换版本

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

is_composite()[source]#

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

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

返回值:
composite: bool

对象是否有任何参数的值是 BaseObject 的后代实例。

属性 is_fitted[source]#

是否已调用 fit。

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

返回值:
bool

估计器是否已 fit。

类方法 load_from_path(serial)[source]#

从文件位置加载对象。

参数:
serialZipFile(path).open(“object) 的结果
返回值:
在 path 处生成输出的自身反序列化结果，来自 cls.save(path)。
类方法 load_from_serial(serial)[source]#

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

参数:
serialcls.save(None) 输出的第一个元素
返回值:
生成输出 serial 的自身反序列化结果，来自 cls.save(None)。
reset()[source]#

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

结果是将 self 设置为构造函数调用后立即处于的状态，具有相同的超参数。通过 set_config 设置的配置值也得到保留。

一个 reset 调用删除任何对象属性，除了

  • hyper-parameters（超参数）= __init__ 的参数，写入到 self，例如 self.paramname，其中 paramname 是 __init__ 的参数

  • 包含双下划线的对象属性，即字符串“__”。例如，名为“__myattr”的属性会保留。

  • config 属性，config 不会改变地保留。也就是说，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) 创建一个 zip 文件 estimator.zip。

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

存储在 /home/stored/ 中。

serialization_format: str，默认 = “pickle”

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

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

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

参数:
config_dictdict

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

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

jupyter 内核如何显示 self 的实例

  • “diagram” = html 框图表示

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

print_changed_onlybool，默认=True

打印 self 时是仅列出与默认值不同的 self 参数 (False)，还是列出所有参数名称和值 (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，可选，默认={}（不传递参数）

作为 config 传递给并行化后端的额外参数。有效键取决于 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 中的 config 复制到 self._config_dynamic。

set_params(**params)[source]#

设置此对象的参数。

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

deepbool，默认值=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

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

要转换的数据。

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

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

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

  • Hierarchical scitype = 分层时间序列集合。pd.DataFrame 具有 3 级或更多级行 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，则通过 update_data 将数据写入 self._X，并用 X 中的值更新。

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

用于更新转换的数据

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

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

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

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

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

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

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

返回值:
self估计器的拟合实例