DetectorAsTransformer#

class DetectorAsTransformer(estimator)[source]#

使用异常检测器、变点检测器或分割估计器作为转换器。

此适配器用于强制类型转换，例如将检测器传递给转换器槽位时。

该转换是从时间序列到基本类型（Primitives），将时间序列转换为其聚类分配结果。

该适配器将 BaseTransformer.transform 调用分派给 BaseDetector.transform。

参数：
estimatorsktime 检测器，即继承自 BaseDetector 的估计器

这是一个“蓝图”聚类器，调用 fit 时其状态不会改变

属性：
estimator_sktime 检测器，estimator 的克隆

调用 fit 时，此克隆将在管道中进行拟合

示例

>>> from sktime.detection.compose import DetectorAsTransformer
>>> from sktime.detection.lof import SubLOF
>>> from sktime.utils._testing.hierarchical import _make_hierarchical
>>> X = _make_hierarchical()
>>> detector = SubLOF.create_test_instance()
>>> t = DetectorAsTransformer(detector)
>>> t.fit(X)
DetectorAsTransformer(...)
>>> Xt = t.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_set字符串，默认值为“default”

要返回的测试参数集的名称，用于测试。如果没有为某个值定义特殊参数，则将返回“default”集。对于聚类器，应提供一组“default”参数用于一般测试，如果通用集无法产生合适的概率进行比较，则提供一组“results_comparison”参数用于与先前记录的结果进行比较。

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

用于创建类测试实例的参数。每个字典是构造一个“有趣”测试实例的参数，即 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_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”集。

返回：
objscls 实例列表

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

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

第 i 个元素是测试中 objs 的第 i 个实例的名称。如果实例多于一个，命名约定为 {cls.__name__}-{i}，否则为 {cls.__name__}`。

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

将转换器拟合到 X，可选地拟合到 y。

状态改变

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

写入自身

  • 设置以“_”结尾的已拟合模型属性，已拟合属性可通过 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 组成的 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 的转换后版本。

状态改变

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

写入自身：_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 组成的 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-row) | | 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，则返回是一个 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_name字符串

标签值的名称。

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

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

get_config()[source]#

获取对象的配置标志。

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

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

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

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

返回：
config_dict字典

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

get_fitted_params(deep=True)[source]#

获取拟合参数。

所需状态

要求状态为“已拟合”（fitted）。

参数：
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 方法。

所需状态

要求状态为“已拟合”（fitted）。

访问自身属性

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

  • self.is_fitted，必须为 True

参数：
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 组成的 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: bool

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

property is_fitted[source]#

fit 方法是否已被调用。

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

返回：
布尔值

估计器是否已经过 fit。

classmethod load_from_path(serial)[source]#

从文件位置加载对象。

参数：
serialZipFile(path).open(“object) 的结果
返回：
cls.save(path) 在 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”，则会在当前工作目录下生成一个 estimator.zip 的 zip 文件。

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

/home/stored/ 中存储一个 estimator.zip 的 zip 文件。

serialization_format：str，默认为 “pickle”

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

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

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

参数：
config_dict字典

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

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

jupyter kernel 如何显示自身的实例

  • “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”：bool，默认为 True；False 可防止 ray 在并行化后关闭

      并行化后关闭。

    • “logger_name”：str，默认为“ray”；要使用的 logger 名称。

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

设置此对象的参数。

该方法适用于简单的 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')[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指向自身的引用
set_tags(**tag_dict)[source]#

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

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

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

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

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

当前标签值可以通过 get_tags 或 get_tag 进行检查。

参数：
**tag_dictdict

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

返回：
自身

指向自身的引用。

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

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

所需状态

要求状态为“已拟合”（fitted）。

访问自身属性

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

  • self.is_fitted，必须为 True

参数：
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 组成的 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 标签

转换

X

-输出

返回类型

Series

原语

pd.DataFrame（1 行）

Panel

原语

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，则返回是一个 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。

所需状态

要求状态为“已拟合”（fitted）。

访问自身属性

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

  • 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 = 时间序列集合。具有 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估计器的已拟合实例