MatrixProfile#

class MatrixProfile(m=10)[source]#

返回数据集中每个时间序列的 MatrixProfile 和索引 profile。

用法示例:# Xt = MatrixProfile(m).transform(X) X 是一个 pandas DataFrame,代表数据集。m 是一个整数,代表要使用的期望子序列长度。Xt 是转换后的 X,即一个行数与 X 相同的 pandas DataFrame,其中每一行包含对应时间序列的 MatrixProfile。

属性:
is_fitted

是否已调用 fit

方法

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

返回 skbase 对象的测试参数设置。

inverse_transform(X[, y])

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

is_composite()

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

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。

check_is_fitted(method_name=None)[source]#

检查估计器是否已拟合。

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

如果不是,则抛出 NotFittedError

参数:
method_namestr,可选

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

抛出:
未拟合错误

如果估计器尚未拟合。

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

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

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

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

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

tag_names 的默认设置是将 estimator 中的所有标签写入 self

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

参数:
estimator:class:BaseObject 或派生类的实例
tag_namesstr 或 list[str],默认为 None

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

返回:
self

self 的引用。

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

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

参数:
parameter_setstr,默认为“default”

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

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

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

参数:
parameter_setstr,默认为“default”

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

返回:
classmethod create_test_instances_and_names(parameter_set='default')[source]#

objscls 实例列表

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

namesstr 列表,与 objs 长度相同

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

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

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

状态变化

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

  • 写入 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.Seriesnp.ndarray (1D 或 2D)

  • Panel scitype = 时间序列集合。pd.DataFrame 带 2 级行 MultiIndex (instance, time)3D np.ndarray (instance, variable, time)listSeries 类型 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]#

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

状态变化

将转换器拟合到 X 和 y,并返回 X 的转换版本。

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

如果可能,可能通过引用强制转换为内部类型或 update_data 兼容类型

参数:
如果 self.get_tag("remember_data")True,则将 X 记忆为 self._X,强制转换为 self.get_tag("X_inner_mtype") 指定的类型。

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

用于拟合转换器的数据。

  • sktime 中的个体数据格式是所谓的 mtype 规范,每个 mtype 实现一个抽象的 scitype

  • Series scitype = 个体时间序列。pd.DataFrame, pd.Seriesnp.ndarray (1D 或 2D)

  • Panel scitype = 时间序列集合。pd.DataFrame 带 2 级行 MultiIndex (instance, time)3D np.ndarray (instance, variable, time)listSeries 类型 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 标签

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 实例)。示例:面板中的所有时间序列都单独进行去趋势

如果 XSeriesPaneltransform-output

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

如果 XSeriestransform-outputPanel

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

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

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

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

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

  1. 它从对象中返回名称为 tag_name 的标签的值,考虑标签覆盖,按以下优先级降序排列

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

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

按继承顺序。

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

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

tag_namestr

标签值的名称。

tag_value_default任意类型

返回:
如果找不到标签的默认/备用值。

tag_value

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

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

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

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

classmethod get_class_tags()[source]#

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

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

  1. 它从对象中返回名称为 tag_name 的标签的值,考虑标签覆盖,按以下优先级降序排列

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

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

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

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

按继承顺序。

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

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

collected_tagsdict

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

获取 self 的配置标志。

get_config()[source]#

配置是 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 的 dict

  • 已拟合参数字典,参数名称:参数值 键值对包括

  • 始终:此对象的所有已拟合参数,如同通过 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

  • 参数字典,参数名称:参数值 键值对包括

  • 始终:此对象的所有参数,如同通过 get_param_names 获取的值是此对象该键的参数值,这些值始终与构造时传递的值相同

  • 如果 deep=True,还包含组件参数的键值对,组件参数的索引格式为 [componentname]__[paramname]componentname 的所有参数显示为 paramname 及其值

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

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

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

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

get_tag(tag_name, tag_value_default=None, raise_error=True)[source]#

  1. get_tag 方法从实例中检索名称为 tag_name 的单个标签的值,考虑标签覆盖,按以下优先级降序排列

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

  1. 它从对象中返回名称为 tag_name 的标签的值,考虑标签覆盖,按以下优先级降序排列

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

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

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

在实例构造时。

要检索的标签名称

tag_value_default任意类型,可选;默认为 None

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

raise_errorbool

返回:
当找不到标签时是否抛出 ValueError

tag_valueAny

抛出:
tag_name 标签在 self 中的值。如果找不到,并且 raise_error 为 True,则抛出错误,否则返回 tag_value_default

ValueError,如果 raise_errorTrue

tag_name 不在 self.get_tags().keys() 中时,将抛出 ValueError

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

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

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

get_tags()[source]#

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

  1. get_tag 方法从实例中检索名称为 tag_name 的单个标签的值,考虑标签覆盖,按以下优先级降序排列

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

  1. 它从对象中返回名称为 tag_name 的标签的值,考虑标签覆盖,按以下优先级降序排列

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

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

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

collected_tagsdict

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

返回 skbase 对象的测试参数设置。

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

get_test_params 是用于存储测试参数设置的统一接口点。此函数也用于 create_test_instancecreate_test_instances_and_names 来构造测试实例。

get_test_params 应返回单个 dictdict 列表。

每个 dict 都是用于测试的参数配置,可用于构造一个“有趣的”测试实例。对于 get_test_params 返回中的所有字典 params,调用 cls(**params) 应有效。

参数:
parameter_setstr,默认为“default”

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

返回:
get_test_params 不需要返回固定的字典列表,它也可以返回动态或随机的参数设置。

paramsdict 或 list[dict],默认为 {}

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

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

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

目前假设只有带有标签的转换器

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

get_fitted_params(deep=True)[source]#

所需状态

才具有 inverse_transform。

  • 访问 self 中的内容

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

参数:
如果 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.Seriesnp.ndarray (1D 或 2D)

  • Panel scitype = 时间序列集合。pd.DataFrame 带 2 级行 MultiIndex (instance, time)3D np.ndarray (instance, variable, time)listSeries 类型 pd.DataFrame

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

有关数据格式的更多详细信息,请参阅 mtype 术语表。有关用法,请参阅转换器教程 examples/03_transformers.ipynb

self.is_fitted,必须为 True

返回:
额外数据,例如转换的标签。一些转换器需要此项,请参阅类文档字符串获取详细信息。

X 的逆转换版本

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

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

is_composite()[source]#

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

composite: bool

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

是否已调用 fit

property is_fitted[source]#

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

bool

估计器是否已 fit

从文件位置加载对象。

参数:
classmethod load_from_path(serial)[source]#
返回:
serialZipFile(path).open(“object) 的结果
反序列化的 self,产生 cls.save(path)path 的输出

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

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

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

reset()[source]#

结果是将 self 设置为其构造函数调用后的状态,具有相同的超参数。set_config 设置的配置值也保留。

  • reset 调用会删除所有对象属性,除了

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

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

配置属性,配置保留不变。也就是说,reset 前后 get_config 的结果相等。

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

等同于 clone,区别在于 reset 改变 self 而不是返回一个新对象。

返回:
self

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

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

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

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

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

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

pathNone 或文件位置 (str 或 Path)

  • 如果为 None,self 保存到内存对象中;如果是文件位置,self 保存到该文件位置。如果

  • path=”estimator”,则会在当前工作目录创建 zip 文件 estimator.zip

path=”/home/stored/estimator”,则会在 /home/stored/ 中存储 zip 文件 estimator.zip

。 (补全上一行的句子)

serialization_format: str,默认为 “pickle”

返回:
用于序列化的模块。可用选项有“pickle”和“cloudpickle”。请注意,非默认格式可能需要安装其他软依赖项。
如果 path 为 None - 内存中的序列化 self
如果 path 是文件位置 - ZipFile,引用该文件

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

参数:
配置在 clonereset 调用下保留。

set_config(**config_dict)[source]#

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

displaystr,“diagram”(默认)或“text”

  • jupyter kernel 如何显示 self 的实例

  • “diagram” = html 框图表示

“text” = 字符串打印输出

是否只列出自参数中与默认值不同的参数(False),还是列出所有参数名称和值(False)。不进行嵌套,即只影响自身,不影响组件估计器。

warnings字符串,“on”(默认)或“off”

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

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

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

backend:parallel字符串,可选,默认值=“None”

在广播/向量化时用于并行化的后端,可以是以下之一

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

  • “loky”、“multiprocessing”和“threading”:使用 joblib.Parallel

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

  • “dask”:使用 dask,需要在环境中安装 dask

  • “ray”:使用 ray,需要在环境中安装 ray

backend:parallel:params字典,可选,默认值={}(未传递参数)

作为配置传递给并行化后端的额外参数。有效键取决于 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_conversion字符串,可以是“on”(默认)、“off”或有效的 mtype 字符串之一

控制输入检查和转换,适用于 _fit_transform_inverse_transform_update

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

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

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

output_conversion字符串,可以是“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>

参数:
**params字典

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

返回:
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_state整型,RandomState 实例或 None,默认=None

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

要求状态为“已拟合”。

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

  • 如果为 False,则仅设置 selfrandom_state 参数(如果存在)。

  • 如果为 True,则也会在组件对象中设置 random_state 参数。

self_policy字符串,可以是 {“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]#

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

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

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

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

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

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

参数:
**tag_dict字典

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

返回:
Self

对自身的引用。

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

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

get_fitted_params(deep=True)[source]#

所需状态

才具有 inverse_transform。

  • 访问 self 中的内容

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

参数:
如果 self.get_tag("remember_data")True,则将 X 记忆为 self._X,强制转换为 self.get_tag("X_inner_mtype") 指定的类型。

要转换的数据。

用于拟合转换器的数据。

  • sktime 中的个体数据格式是所谓的 mtype 规范,每个 mtype 实现一个抽象的 scitype

  • Series scitype = 个体时间序列。pd.DataFrame, pd.Seriesnp.ndarray (1D 或 2D)

  • Panel scitype = 时间序列集合。pd.DataFrame 带 2 级行 MultiIndex (instance, time)3D np.ndarray (instance, variable, time)listSeries 类型 pd.DataFrame

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

有关数据格式的更多详细信息,请参阅 mtype 术语表。有关用法,请参阅转换器教程 examples/03_transformers.ipynb

self.is_fitted,必须为 True

返回:
用于拟合转换器和进行转换的数据。
X 的转换版本

转换

X

-输出

返回类型

Series

Primitives

pd.DataFrame (1行)

Panel

Primitives

pd.DataFrame

Series

Series

Series

Panel

Series

Panel

Series

Panel

Panel

|----------|————–|------------------------| | 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 实例)。示例:面板中的所有时间序列都单独进行去趋势

如果 XSeriesPaneltransform-output

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

如果 XSeriestransform-outputPanel

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

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

get_fitted_params(deep=True)[source]#

所需状态

才具有 inverse_transform。

  • 访问 self 中的内容

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

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

  • 访问 self 中的内容

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

参数:
如果 self.get_tag("remember_data")True,则将 X 记忆为 self._X,强制转换为 self.get_tag("X_inner_mtype") 指定的类型。

用于更新转换的数据

用于拟合转换器的数据。

  • sktime 中的个体数据格式是所谓的 mtype 规范,每个 mtype 实现一个抽象的 scitype

  • Series scitype = 个体时间序列。pd.DataFrame, pd.Seriesnp.ndarray (1D 或 2D)

  • Panel scitype = 时间序列集合。pd.DataFrame 带 2 级行 MultiIndex (instance, time)3D np.ndarray (instance, variable, time)listSeries 类型 pd.DataFrame

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

有关数据格式的更多详细信息,请参阅 mtype 术语表。有关用法,请参阅转换器教程 examples/03_transformers.ipynb

self.is_fitted,必须为 True

返回:
额外数据,例如转换的标签。如果 self.get_tag("requires_y")True,则必须在 fit 中传递,不是可选的。有关所需格式,请参阅类文档字符串获取详细信息。