布林带#

class Bollinger(window, k=1, memory='all')[source]#

将布林带应用于时间序列。

该转换适用于单变量和多变量时间序列。

参数:
windowint

计算移动平均和标准差的窗口大小。

k: float, 默认值 = 1

乘数，用于确定上下界距离移动平均有多少个标准差。

memorystr, 可选, 默认值 = “all”

记住多少之前见过的 X，以便精确重建反向转换。

  • “all” : 估计器记住所有 X，反向转换对所有已见索引都正确

  • “latest” : 估计器只记住未来需要的最新的 X

重建。拟合后的任何时间戳的反向转换都正确，但过去的时间戳不正确。

  • “none” : 估计器不记住任何 X，反向转换是直接累加

属性:
is_fitted

是否已调用 fit。

示例

>>> from sktime.transformations.series.bollinger import Bollinger
>>> from sktime.datasets import load_airline
>>> y = load_airline()
>>> transformer = Bollinger(window=12, k=1)
>>> 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" 集。转换器当前没有保留值。

返回:
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, 可选

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

引发:
未拟合错误

如果估计器尚未拟合。

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 的引用。

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” 集。

返回:
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。

状态变更

将状态更改为“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 = 时间序列集合。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 的转换版本。

状态变更

将状态更改为“fitted”。

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

如果可能，可能强制转换为内部类型或通过引用强制转换为 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，则返回是与 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_namestr

标签值的名称。

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

获取拟合参数。

所需状态

要求状态为“fitted”。

参数:
deepbool, 默认值=True

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

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

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

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

拟合参数字典，参数名：参数值键值对包括

  • 总是：此对象的所有拟合参数，如通过 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]#

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

参数:
deepbool, 默认值=True

是否返回组件的参数。

  • 如果为 True，将返回此对象的参数名：值 dict，包括组件（= BaseObject 值参数）的参数。

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

返回:
params键为 str 类型的 dict

参数字典，参数名：参数值键值对包括

  • 总是：此对象的所有参数，如通过 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。

所需状态

要求状态为“fitted”。

访问 self 中的属性

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

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

检查对象是否由其他 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”) 的结果
返回:
反序列化的 self，其结果在 path 处输出，来自 cls.save(path)
classmethod load_from_serial(serial)[source]#

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

参数:
serialcls.save(None) 输出的第一个元素
返回:
反序列化的 self，其结果为 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”，则会在当前工作目录创建 zip 文件 estimator.zip。

  • path=”/home/stored/estimator”，则会在 /home/stored/ 目录创建 zip 文件 estimator.zip。

存储在 /home/stored/ 中。

serialization_format: str, 默认值 = “pickle”

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

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

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

参数:
config_dictdict

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

displaystr，"diagram"（默认）或 "text"

jupyter 内核如何显示 self 的实例

  • “diagram” = html 框图表示

  • “text” = 字符串输出

print_changed_onlybool，默认值=True

打印 self 时是否只列出自参数中与默认值不同的部分 (True)，还是列出所有参数名称和值 (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>。如果引用明确（例如，没有两个组件参数同名为 <parameter>），也可以使用不带 <component>__ 的字符串 <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 并返回转换后的版本。

所需状态

要求状态为“fitted”。

访问 self 中的属性

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

  • 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，则返回是与 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 中的属性

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

  • self.is_fitted，必须为 True

写入 self

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

  • 如果 remember_data 标签为 True，则通过 update_data 将 X 中的值写入并更新到 self._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估计器的已拟合实例