SqrtTransformer#

class SqrtTransformer(offset='auto')[source]#

对时间序列应用元素级别的平方根转换。

转换按元素执行以下操作:
  • 添加常数 offset (偏移量)

  • 应用平方根

Offset="auto" 计算最小的偏移量,确保在取平方根之前所有元素都非负。

参数:
offset“auto”, int or float, default=”auto”

在对输入时间序列求指定 power 次幂之前,添加到输入时间序列的偏移量。如果设置为“auto”,则会检查序列是否包含负值。如果发现负值,则偏移量将等于最负值的绝对值。如果不存在负值,则偏移量设为零。如果提供整数或浮点值,则将使用该值作为偏移量。

属性:
offsetint or float

用户提供的偏移值。

另请参阅

BoxCoxTransformer

应用 Box-Cox 幂转换。有助于规范化数据并压缩序列的方差。

LogTransformer

使用自然对数转换输入数据。有助于规范化数据并压缩序列的方差。

sktime.transformations.series.exponent.ExponentTransformer

通过将输入数据提高到指定的指数进行转换。如果提供的是小数指数,则有助于压缩序列的方差。

注意

对于输入序列 Z,平方根转换定义为 \((Z + offset)^{0.5}\)

示例

>>> from sktime.transformations.series.exponent import SqrtTransformer
>>> from sktime.datasets import load_airline
>>> y = load_airline()
>>> transformer = SqrtTransformer()
>>> y_transform = 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()

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

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_setstr, default=”default”

要返回的测试参数集的名称,用于测试。如果未为某个值定义特殊参数,则将返回 "default" 集。转换器目前没有保留值。

返回:
paramsdict or list of dict, default = {}

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

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

引发:
NotFittedError

如果估计器尚未拟合。

clone()[source]#

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

克隆是具有相同超参数和配置但没有共享引用的不同对象,处于初始化后的状态。此函数等效于返回 selfsklearn.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_tagsget_tag 检查。

参数:
estimator:class:BaseObject 或派生类的实例
tag_namesstr 或 list of str, default = None

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

返回:
self

self 的引用。

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

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

参数:
parameter_setstr, default=”default”

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

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

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

参数:
parameter_setstr, default=”default”

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

返回:
objscls 实例列表

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

namesstr 列表,长度与 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.DataFramepd.Seriesnp.ndarray (1D 或 2D)

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

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

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

yoptional, data in sktime compatible data format, default=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.DataFramepd.Seriesnp.ndarray (1D 或 2D)

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

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

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

yoptional, data in sktime compatible data format, default=None

额外数据,例如用于转换的标签。某些转换器需要此项,请参阅类文档字符串了解详细信息。如果 self.get_tag("requires_y")True,则必须在 fit 中传递,而不是可选的。有关所需格式,请参阅类文档字符串了解详细信息。

返回:
X 的转换版本
类型取决于 X 的类型和 scitype:transform-output 标签
X | 转换输出 | 返回类型 |

|----------|————–|------------------------| | Series | 基本类型 | pd.DataFrame (1 行) | | Panel | 基本类型 | 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 实例)。示例:面板中的所有序列都单独进行去趋势处理

  • 如果 XSeriesPanel 并且 transform-output

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

  • 如果 XSeries 并且 transform-outputPanel

则返回是一个 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_tagsclone_tags 在实例上设置的动态标签覆盖。

要检索具有潜在实例覆盖的标签值,请改用 get_tag 方法。

参数:
tag_namestr

标签值的名称。

tag_value_defaultany type

如果找不到标签,则使用的默认/回退值。

返回:
tag_value

selftag_name 标签的值。如果找不到,则返回 tag_value_default

classmethod get_class_tags()[source]#

从类中获取类标签,考虑父类的标签继承级别。

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

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

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

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

值是相应的标签值,覆盖优先级降序如下:

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

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

按继承顺序排列。

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

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

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

对于包含动态标签覆盖,请使用 get_tags

collected_tagsdict

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

get_config()[source]#

获取自身的配置标志。

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

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

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

配置在 clonereset 调用中保留。

返回:
config_dictdict

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

get_fitted_params(deep=True)[source]#

获取已拟合的参数。

所需状态

要求状态为“已拟合”。

参数:
deepbool, default=True

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

  • 如果为 True,将返回此对象的参数名称:值字典,包括可拟合组件(= BaseEstimator 值的参数)的已拟合参数。

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

返回:
fitted_paramsdict with str-valued keys

已拟合参数字典,键为参数名:参数值

  • 总是包含:此对象的所有已拟合参数,如通过 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, default=True

是否按字母顺序返回参数名称 (True),或按它们在类的 __init__ 中出现的顺序返回 (False)。

返回:
param_names: list[str]

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

get_params(deep=True)[source]#

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

参数:
deepbool, default=True

是否返回组件的参数。

  • 如果为 True,将返回此对象的参数名称:值 dict,包括组件(= BaseObject 值的参数)的参数。

  • 如果为 False,将返回此对象的参数名称:值 dict,但不包括组件的参数。

返回:
paramsdict with str-valued keys

参数字典,键为参数名:参数值

  • 总是包含:此对象的所有参数,如通过 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_tagsclone_tags 在实例上设置的标签,

在实例构造时设置。

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

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

按继承顺序排列。

参数:
tag_namestr

要检索的标签名称

tag_value_defaultany type, optional; 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]#

从实例中获取标签,考虑标签级别的继承和覆盖。

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

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

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

值是相应的标签值,覆盖优先级降序如下:

  1. 通过 set_tagsclone_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.DataFramepd.Seriesnp.ndarray (1D 或 2D)

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

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

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

yoptional, data in sktime compatible data format, default=None

额外数据,例如用于转换的标签。某些转换器需要此项,请参阅类文档字符串了解详细信息。

返回:
X 的逆向转换版本

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

is_composite()[source]#

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

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

返回:
composite: bool

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

property is_fitted[source]#

是否已调用 fit

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

返回:
bool

估计器是否已 fit

classmethod load_from_path(serial)[source]#

从文件位置加载对象。

参数:
serialZipFile(path).open(“object”) 的结果
返回:
反序列化自身,结果为 path 上的输出,即 cls.save(path) 的输出
classmethod load_from_serial(serial)[source]#

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

参数:
serialcls.save(None) 输出的第 1 个元素
返回:
反序列化自身,结果为输出 serial,即 cls.save(None) 的输出
reset()[source]#

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

self 设置为构造函数调用后直接的状态,具有相同的超参数。通过 set_config 设置的配置值也会保留。

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

  • 超参数 = __init__ 的参数,写入 self,例如 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 or file location (str or Path)

如果为 None,则将自身保存到内存对象中;如果是文件位置,则将自身保存到该文件位置。如果 path=”estimator”,则会在当前工作目录创建 zip 文件 estimator.zip

  • 如果 path=”/home/stored/estimator”,则 estimator.zip zip 文件将

  • 存储在 /home/stored/ 中。

存储在 /home/stored/ 中。

serialization_format: str, default = “pickle”

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

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

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

参数:
config_dictdict

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

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

jupyter 内核如何显示自身实例

  • “diagram” = html 框图表示

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

print_changed_onlybool, default=True

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

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,可以是“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>

参数:
**params字典

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 值可在多次函数调用中获得可重现的输出。

deepbool, default=True

是否在具有 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对自身的引用
set_tags(**tag_dict)[source]#

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

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

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

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

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

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

参数:
**tag_dict字典

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

返回:
Self

对自身的引用。

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

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

所需状态

要求状态为“已拟合”。

访问自身属性

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

  • self.is_fitted,必须为 True

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

要转换的数据。

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

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

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

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

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

yoptional, data in sktime compatible data format, default=None

额外数据,例如用于转换的标签。某些转换器需要此项,请参阅类文档字符串了解详细信息。

返回:
X 的转换版本
类型取决于 X 的类型和 scitype:transform-output 标签

转换

X

-输出

返回类型

时间序列

基本类型

pd.DataFrame (1行)

面板数据

基本类型

pd.DataFrame

时间序列

时间序列

时间序列

面板数据

时间序列

面板数据

时间序列

面板数据

面板数据

返回中的实例对应于 X 中的实例
表中未列出的组合目前不支持
具体示例
  • 如果 XSeries (例如,pd.DataFrame)

并且 transform-outputSeries,则返回是相同 mtype 的单个 Series。示例:对单个序列进行去趋势处理

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

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

  • 如果 XSeriesPanel 并且 transform-output

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

  • 如果 XSeries 并且 transform-outputPanel

则返回是一个 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.DataFramepd.Seriesnp.ndarray (1D 或 2D)

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

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

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

yoptional, data in sktime compatible data format, default=None

额外数据,例如用于转换的标签。某些转换器需要此项,请参阅类文档字符串了解详细信息。

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