幂变换器#

class ExponentTransformer(power=0.5, offset='auto')[source]#

对时间序列应用逐元素的幂变换。

变换执行以下逐元素操作
  • 加上常数 offset (平移)

  • 提升到指定的 power 幂(指数化)

Offset=”auto” 计算偏移量,使其成为确保所有元素在指数化之前非负的最小偏移量。

参数:
powerint 或 float,默认为 0.5

输入时间序列要提升到的幂。

offset“auto”,int 或 float,默认为“auto”

在将时间序列提升到给定 power 之前添加到输入时间序列的偏移量。如果为“auto”,则检查序列以确定是否包含负值。如果找到负值,则偏移量将等于最负值的绝对值。如果没有负值,则偏移量设置为零。如果提供整数或浮点值,将使用该值作为偏移量。

属性:
powerint 或 float

用户提供的幂。

offsetint 或 float,或可迭代对象。

用户提供的偏移值。标量或 1D 可迭代对象,其值数量与变换中的 X 列数相同。

另请参阅

BoxCoxTransformer

应用 Box-Cox 幂变换。有助于数据归一化和压缩序列方差。

LogTransformer

使用自然对数变换输入数据。有助于数据归一化和压缩序列方差。

sktime.transformations.series.exponent.SqrtTransformer

对输入数据取平方根进行变换。有助于压缩输入序列的方差。

注释

对于输入序列 Z,幂变换定义为 \((Z + offset)^{power}\)

示例

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

检查对象是否由其他 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_setstr,默认为“default”

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

返回:
paramsdict 或 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]#

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

一个克隆是不同的对象,没有共享引用,处于初始化后状态。此函数等同于返回 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_names字符串或字符串列表,默认 = 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])

names字符串列表,长度与 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.Seriesnp.ndarray (1D 或 2D)

  • Panel scitype = 时间序列集合。具有两级行 MultiIndex (instance, time)pd.DataFrame3D np.ndarray (instance, variable, time),或 Series 类型 pd.DataFramelist

  • Hierarchical scitype = 层级时间序列集合。具有三级或更多级行 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)状态。

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

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

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

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

用于拟合变换的数据,以及要变换的数据。

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

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

  • Panel scitype = 时间序列集合。具有两级行 MultiIndex (instance, time)pd.DataFrame3D np.ndarray (instance, variable, time),或 Series 类型 pd.DataFramelist

  • Hierarchical scitype = 层级时间序列集合。具有三级或更多级行 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 行) | | 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 中的所有序列都单独进行去趋势处理

  • 如果 XSeriesPaneltransform-output

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

  • 如果 XSeriestransform-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_name字符串

标签值的名称。

tag_value_default任意类型

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

返回:
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_tags字典

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

get_config()[source]#

获取自身的配置标志。

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

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

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

配置在 clonereset 调用中保留。

返回:
config_dict字典

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

get_fitted_params(deep=True)[source]#

获取拟合参数。

所需状态

要求状态为“已拟合”(fitted)状态。

参数:
deep布尔值,默认=True

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

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

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

返回:
fitted_params以字符串为键的字典

已拟合参数字典,参数名 : 参数值 键值对包含

  • 总是包含:此对象的所有已拟合参数,通过 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以字符串为键的字典

参数字典,参数名 : 参数值 键值对包含

  • 总是包含:此对象的所有参数,通过 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_name字符串

要检索的标签名称

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

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

raise_error布尔值

未找到标签时是否引发 ValueError

返回:
tag_value任意类型

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

标签名称 : 标签值 对的字典。通过嵌套继承从 _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.Seriesnp.ndarray (1D 或 2D)

  • Panel scitype = 时间序列集合。具有两级行 MultiIndex (instance, time)pd.DataFrame3D np.ndarray (instance, variable, time),或 Series 类型 pd.DataFramelist

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

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

y可选,sktime 兼容数据格式的数据,默认=None

附加数据,例如用于变换的标签。有些转换器需要此数据,详细信息请参阅类文档字符串。

返回:
X 的逆变换版本

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

is_composite()[source]#

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

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

返回:
composite: 布尔值

对象是否包含任何值是 BaseObject 后代实例的参数。

property is_fitted[source]#

fit 方法是否已被调用。

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

返回:
布尔值

估计器是否已进行 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=None)[source]#

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

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

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

参数:
pathNone 或文件位置(字符串或 Path 对象)

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

  • path=”estimator”,则将在当前工作目录 (cwd) 下创建 zip 文件 estimator.zip

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

存储在 /home/stored/ 中。

serialization_format: 字符串,默认 = “pickle”

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

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

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

参数:
config_dict字典

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

display字符串,“diagram”(默认),或“text”

jupyter 内核如何显示 self 的实例

  • “diagram” = html 框图表示

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

print_changed_only布尔值,默认=True

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

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

注释

更改对象状态,将 config_dict 中的配置复制到 self._config_dynamic。

set_params(**params)[source]#

设置此对象的参数。

此方法适用于简单的 skbase 对象以及复合对象。参数键字符串 <component>__<parameter> 可用于复合对象(即包含其他对象的对象),以访问组件 <component> 中的 <parameter>。如果引用明确,也可以使用不带 <component>__ 的字符串 <parameter>,例如,没有两个组件参数具有相同的名称 <parameter>

参数:
**params字典

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_state整数,RandomState 实例或 None,默认=None

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

deep布尔值,默认=True

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

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

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

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

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

set_tags 方法只能在对象的 __init__ 方法中调用,即在构造过程中或通过 __init__ 直接构造之后调用。

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

参数:
**tag_dict字典

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

返回:
Self

对 self 的引用。

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

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

所需状态

要求状态为“已拟合”(fitted)状态。

访问 self 中的内容

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

  • self.is_fitted,必须为 True

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

要变换的数据。

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

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

  • Panel scitype = 时间序列集合。具有两级行 MultiIndex (instance, time)pd.DataFrame3D np.ndarray (instance, variable, time),或 Series 类型 pd.DataFramelist

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

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

y可选,sktime 兼容数据格式的数据,默认=None

附加数据,例如用于变换的标签。有些转换器需要此数据,详细信息请参阅类文档字符串。

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

变换

X

-输出

返回类型

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 中的所有序列都单独进行去趋势处理

  • 如果 XSeriesPaneltransform-output

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

  • 如果 XSeriestransform-outputPanel

则返回是 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_dataself._X 写入并用 X 中的值更新。

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

用于更新变换的数据

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

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

  • Panel scitype = 时间序列集合。具有两级行 MultiIndex (instance, time)pd.DataFrame3D np.ndarray (instance, variable, time),或 Series 类型 pd.DataFramelist

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

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

y可选,sktime 兼容数据格式的数据,默认=None

附加数据,例如用于变换的标签。有些转换器需要此数据,详细信息请参阅类文档字符串。

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