SubsequenceExtractionTransformer#

class SubsequenceExtractionTransformer(aggregate_fn, subseq_len, kwargs=None, selector='max')[source]#

基于滚动聚合提取指定长度的连续子序列。

一个用于基于最大/最小滚动窗口聚合提取指定长度连续子序列的转换器。

给定一个序列 \(\\{x_1, x_2, \cdots, x_n \\}\) 以及整数 subseq_len \(k\) 使得 \(0 < k \leq n\),转换器的任务是找到满足条件的索引 \(i\) 满足 \(1 \leq i \leq i + k - 1 \leq n\) 以便对于给定的 aggregate_fn \(A: \mathbb{R}^k \longrightarrow \mathbb{R}\)

  1. \(A(x_{i}, \cdots, x_{i+k-1})\)selector = 'max' 时最大,并且

  2. \(A(x_{i}, \cdots, x_{i+k-1})\)selector = 'min' 时最小。

最大子数组问题 是一个特殊情况,可以通过设置 aggregate_fn = np.sumselector = 'max' 来获得。

参数:
aggregate_fn签名可调用对象 np.ndarray -> float

numpy 中用于将连续子序列中的值聚合为标量的可调用函数。

subseq_lenint

.iloc 单位下的子序列长度。必须小于所有输入序列的长度。

kwargsdict, 默认: None

要传递给 aggregate_fn 的其他关键字参数字典。

selector{‘max’, ‘min’}, 默认: ‘max’

用于决定从一组标量或基本类型中返回哪个子序列的函数。

属性:
is_fitted

fit 是否已被调用。

参考文献

Jon Bentley. 1984. Programming pearls: algorithm design techniques. Commun. ACM 27, 9 (Sept. 1984), 865-873. https://doi.org/10.1145/358234.381162

示例

>>> import numpy as np
>>> from sktime.transformations.series.subsequence_extraction import (
...     SubsequenceExtractionTransformer
... )
>>> from sktime.utils._testing.hierarchical import _make_hierarchical
>>> X = _make_hierarchical(same_cutoff=False)
>>> subseq_extract = SubsequenceExtractionTransformer(
...     aggregate_fn = np.sum,
...     subseq_len = 3,
... )
>>> subseq_extract.fit(X)
SubsequenceExtractionTransformer(...)
>>> X_transformed = subseq_extract.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()

获取 self 的配置标志。

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()

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

load_from_path(serial)

从文件位置加载对象。

load_from_serial(serial)

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

reset()

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

save([path, serialization_format])

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

set_config(**config_dict)

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

set_params(**params)

设置此对象的参数。

set_random_state([random_state, deep, ...])

为 self 设置 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 或 list of dict, 默认 = {}

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

check_is_fitted(method_name=None)[source]#

检查估计器是否已拟合。

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

如果不是,则引发 NotFittedError

参数:
method_namestr, 可选

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

引发:
NotFittedError

如果估计器尚未拟合。

clone()[source]#

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

克隆是一个不同的对象,没有共享引用,处于后初始化状态。此函数等同于返回 sklearn.cloneself

等同于构造 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 设置动态标签覆盖。

应仅在对象的 __init__ 方法中,构造期间或直接在 __init__ 后调用 clone_tags 方法。

动态标签设置为 estimator 中标签的值,名称由 tag_names 指定。

tag_names 的默认值是将 estimator 的所有标签写入 self

可以通过 get_tagsget_tag 检查当前的标签值。

estimator:class:`BaseObject` 或派生类的一个实例

参数:
tag_namesstr 或 list of str, 默认 = None
要克隆的标签名称。默认值 (None) 克隆 estimator 中的所有标签。

self

返回:
self 的引用。

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

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

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

参数:
parameter_setstr, 默认=”default”

instance带有默认参数的类实例

返回:
classmethod create_test_instances_and_names(parameter_set='default')[source]#
objscls 实例列表

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

参数:
parameter_setstr, 默认=”default”

instance带有默认参数的类实例

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

nameslist of str, 与 objs 长度相同

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

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

状态改变

将转换器拟合到 X,可选择拟合到 y。

将状态更改为“fitted”。

写入 self

设置以“_”结尾的拟合模型属性,拟合属性可通过 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.DataFramelist

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

拟合数据,然后转换它。

写入 self: _is_fitted : 标志设置为 True。 _X : X 的强制复制,如果 remember_data 标签为 True

将状态更改为“fitted”。

写入 self

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

模型属性(以“_”结尾):取决于估计器

要拟合转换的数据,以及要转换的数据。

参数:
要拟合转换的数据。

X 的转换版本

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.DataFramelist

  • 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估计器的拟合实例

返回:
类型取决于 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 中的实例

表格中未列出的组合目前不受支持
明确地,带示例
如果 XSeries (例如, pd.DataFrame)
  • 并且 transform-outputSeries, 则返回是相同 mtype 的单个 Series。示例: 对单个序列进行去趋势

如果 XPanel (例如, pd-multiindex) 并且 transform-output

  • Series, 则返回是具有与 X 相同数量实例的 Panel (转换器应用于每个输入 Series 实例)。示例: Panel 中的所有序列都被单独去趋势

如果 XSeriesPanel 并且 transform-output

  • Primitives, 则返回是 pd.DataFrame,其行数与 X 中的实例数相同。示例: 返回的第 i 行具有第 i 个序列的均值和方差

如果 XSeries 并且 transform-outputPanel,

  • 则返回是一个 Panel 对象,类型为 pd-multiindex。示例: 输出的第 i 个实例是运行在 X 上的第 i 个窗口

classmethod get_class_tag(tag_name, tag_value_default=None)[source]#

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

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

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

它返回名称为 tag_name 的标签值,考虑了标签覆盖,优先级从高到低如下:

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

  1. 在其父类的 _tags 属性中设置的标签,

  2. 按继承顺序。

不考虑在实例上通过 set_tagsclone_tags 设置的实例动态标签覆盖。

要检索带有潜在实例覆盖的标签值,请使用 get_tag 方法代替。

tag_namestr

参数:
标签名称。

tag_value_default任何类型

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

tag_value

返回:
selftag_name 标签的值。如果未找到,返回 tag_value_default

classmethod get_class_tags()[source]#

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

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

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

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

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

值是相应的标签值,覆盖优先级从高到低如下:

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

  1. 在其父类的 _tags 属性中设置的标签,

  2. 按继承顺序。

不考虑在实例上通过 set_tagsclone_tags 设置的实例动态标签覆盖。

要检索带有潜在实例覆盖的标签,请使用 get_tags 方法代替。

要包含动态标签的覆盖,请使用 get_tags

要检索带有潜在实例覆盖的标签值,请使用 get_tag 方法代替。

collected_tagsdict

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

get_config()[source]#

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

获取 self 的配置标志。

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

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

配置在 clonereset 调用后保留。

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]

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

是否返回组件的参数。

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

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

如果为 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]#

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

从实例中获取标签值,带有标签级别继承和覆盖。

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

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

在实例上通过 set_tagsclone_tags 设置的标签,

  1. 在实例构建时。

要检索的标签名称

  1. 在其父类的 _tags 属性中设置的标签,

  2. 按继承顺序。

不考虑在实例上通过 set_tagsclone_tags 设置的实例动态标签覆盖。

参数:
标签名称。

tag_value_default任何类型, 可选; 默认=None

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

raise_errorbool

如果未找到标签是否引发 ValueError

tag_valueAny

返回:
selftag_name 标签的值。如果未找到,且 raise_error 为 True,则引发错误,否则返回 tag_value_default

ValueError,如果 raise_errorTrue

引发:
如果 tag_name 不在 self.get_tags().keys() 中,则会引发 ValueError

get_tags()[source]#

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

从实例中获取标签,带有标签级别继承和覆盖。

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

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

collected_tagsdict

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

  1. 在实例构建时。

要检索的标签名称

  1. 在其父类的 _tags 属性中设置的标签,

  2. 按继承顺序。

不考虑在实例上通过 set_tagsclone_tags 设置的实例动态标签覆盖。

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

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

目前假定只有标签为

逆转换 X 并返回一个逆转换后的版本。

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

的转换器才有 inverse_transform。

访问 self 中的内容

需要状态为“拟合”。

deepbool, 默认=True

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

  • self.is_fitted,必须为 True

  • 额外数据,例如用于转换的标签。一些转换器需要此项,详情请参阅类文档字符串。

参数:
要拟合转换的数据。

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.DataFramelist

  • 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 相同,并符合 mtype 格式规范

is_composite()[source]#

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

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

composite: bool

返回:
对象是否包含任何参数,其值是 BaseObject 后代实例。

property is_fitted[source]#

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

fit 是否已被调用。

bool

返回:
估计器是否已 fit

classmethod load_from_path(serial)[source]#

serialZipFile(path).open("object") 的结果

从文件位置加载对象。

参数:
输出在 path 的反序列化 self,即 cls.save(path) 的输出
返回:
classmethod load_from_serial(serial)[source]#
serialcls.save(None) 输出的第一个元素

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

参数:
输出 serial 的反序列化 self,即 cls.save(None) 的输出
返回:
reset()[source]#
结果是将 self 设置为直接在构造函数调用之后的状态,具有相同的超参数。通过 set_config 设置的配置值也会保留。

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

reset 调用会删除任何对象属性,除了

超参数 = 写入 self__init__ 参数,例如 self.paramname,其中 paramname__init__ 的参数

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

  • 配置属性,配置将保留不变。也就是说,get_configreset 前后的结果相同。

  • 类方法和对象方法,以及类属性也不受影响。

等同于 clone,不同之处在于 reset 修改 self 而不是返回新对象。

self.reset() 调用后,self 的值和状态等同于通过构造函数调用 ``type(self)(**self.get_params(deep=False))`` 获取的对象。

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

返回:
self 的引用。

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

行为:如果 path 为 None,则返回内存中的序列化 self;如果 path 是文件位置,则将 self 作为 zip 文件存储在该位置

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

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

pathNone 或文件位置 (str 或 Path)

参数:
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 类属性收集,然后是来自 _onfig_dynamic 对象属性的任何覆盖和新标签。

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

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,可选,默认={}(不传递参数)

作为配置传递给并行化后端的附加参数。有效键取决于 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>。如果引用明确,也可以使用不带 <component>__ 的字符串 <parameter>,例如没有两个组件参数同名为 <parameter>

参数:
**paramsdict

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

返回:
self指向 self 的引用(设置参数后)
set_random_state(random_state=None, deep=True, self_policy='copy')[source]#

为 self 设置 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 以便在多次函数调用中获得可重现的输出。

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

是否在 skbase 对象值参数(即组件评估器)中设置随机状态。

  • 如果为 False,则仅设置 selfrandom_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]#

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

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

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

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

set_tags 方法只能在对象的 __init__ 方法中(构造期间)或通过 __init__ 直接在构造后调用。

estimator:class:`BaseObject` 或派生类的一个实例

参数:
**tag_dictdict

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

返回:
Self

指向 self 的引用。

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

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

需要状态为“拟合”。

deepbool, 默认=True

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

  • self.is_fitted,必须为 True

  • 额外数据,例如用于转换的标签。一些转换器需要此项,详情请参阅类文档字符串。

参数:
要拟合转换的数据。

要进行转换的数据。

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.DataFramelist

  • 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 | 返回类型 |

transform

X

-输出

返回类型

Series

Primitives

pd.DataFrame (1 行)

Panel

Primitives

pd.DataFrame

Series

Series

Series

Panel

Series

Panel

Series

Panel

Panel

表格中未列出的组合目前不受支持
明确地,带示例
如果 XSeries (例如, pd.DataFrame)
  • 并且 transform-outputSeries, 则返回是相同 mtype 的单个 Series。示例: 对单个序列进行去趋势

如果 XPanel (例如, pd-multiindex) 并且 transform-output

  • Series, 则返回是具有与 X 相同数量实例的 Panel (转换器应用于每个输入 Series 实例)。示例: Panel 中的所有序列都被单独去趋势

如果 XSeriesPanel 并且 transform-output

  • Primitives, 则返回是 pd.DataFrame,其行数与 X 中的实例数相同。示例: 返回的第 i 行具有第 i 个序列的均值和方差

如果 XSeries 并且 transform-outputPanel,

  • 则返回是一个 Panel 对象,类型为 pd-multiindex。示例: 输出的第 i 个实例是运行在 X 上的第 i 个窗口

classmethod get_class_tag(tag_name, tag_value_default=None)[source]#

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

用 X 更新转换器,可选择更新 y。

需要状态为“拟合”。

deepbool, 默认=True

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

  • self.is_fitted,必须为 True

  • 额外数据,例如用于转换的标签。一些转换器需要此项,详情请参阅类文档字符串。

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

  • self.is_fitted,必须为 True

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

参数:
要拟合转换的数据。

用于更新转换的数据

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.DataFramelist

  • 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 的逆转换版本

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