InvertAugmenter#
- class InvertAugmenter[source]#
通过将时间序列乘以 -1 来反转时间序列的增强器。
如果
transform
接收到时间序列 \(X={x_1, x_2, ... , x_n}\),则返回 \(X_t={-x_1, -x_2, ... , -x_n}\)。- 属性:
is_fitted
是否已调用
fit
。
示例
>>> from sktime.transformations.series.augmenter import InvertAugmenter >>> import pandas as pd >>> X = pd.Series([1,2,3,4,5]) >>> augmenter = InvertAugmenter() >>> Xt = augmenter.fit_transform(X) >>> Xt 0 -1 1 -2 2 -3 3 -4 4 -5 dtype: int64
方法
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_fitted_params
([deep])获取拟合参数。
获取对象的默认参数。
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 进行逆转换,并返回逆转换后的版本。
检查对象是否由其他 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。
- check_is_fitted(method_name=None)[source]#
检查估计器是否已拟合。
检查
_is_fitted
属性是否存在且为True
。应在调用对象的fit
方法时将is_fitted
属性设置为True
。如果不是,则引发
NotFittedError
异常。- 参数:
- method_name字符串,可选
调用此方法的名称。如果提供,错误消息将包含此信息。
- 引发:
- NotFittedError
如果估计器尚未拟合。
- clone()[source]#
获取具有相同超参数和配置的对象克隆。
克隆是一个没有共享引用、处于初始化后状态的不同对象。此函数等同于返回
self
的sklearn.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
设置动态标签覆盖。应仅在对象的
__init__
方法中调用clone_tags
方法,即在构造期间或通过__init__
直接构造之后。动态标签的值设置为
estimator
中标签的值,其名称在tag_names
中指定。tag_names
的默认值是将estimator
中的所有标签写入self
。当前标签值可以通过
get_tags
或get_tag
进行检查。- 参数:
- estimator:class:BaseObject 或派生类的实例
- tag_names字符串或字符串列表,默认 = None
要克隆的标签名称。默认值 (
None
) 克隆estimator
中的所有标签。
- 返回:
- self
self
的引用。
- classmethod create_test_instance(parameter_set='default')[source]#
使用第一个测试参数集构造类的实例。
- 参数:
- parameter_set字符串,默认=”default”
要返回的测试参数集的名称,用于测试。如果未为某个值定义特殊参数,将返回 “default” 集。
- 返回:
- instance具有默认参数的类实例
- classmethod create_test_instances_and_names(parameter_set='default')[source]#
创建所有测试实例列表及其名称列表。
- 参数:
- parameter_set字符串,默认=”default”
要返回的测试参数集的名称,用于测试。如果未为某个值定义特殊参数,将返回 “default” 集。
- 返回:
- objscls 实例列表
第 i 个实例是
cls(**cls.get_test_params()[i])
- names字符串列表,与 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")
。
- 参数:
- X
sktime
兼容数据容器格式的时间序列 用于拟合转换的数据。
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
- 返回:
- self估计器的已拟合实例
- fit_transform(X, y=None)[source]#
拟合数据,然后进行转换。
将转换器拟合到 X 和 y,并返回 X 的转换版本。
- 状态改变
将状态更改为“已拟合”。
写入自身:_is_fitted : 标志设为 True。_X : X,X 的强制副本,如果 remember_data 标签为 True
如果可能,可能会通过引用强制转换为内部类型或 update_data 兼容类型
模型属性(以“_”结尾):取决于估计器
- 参数:
- X
sktime
兼容数据容器格式的时间序列 用于拟合转换的数据,以及要转换的数据。
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 的转换版本
- 类型取决于 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
的标签值,考虑标签覆盖,优先级从高到低如下类 的
_tags
属性中设置的标签。父类 的
_tags
属性中设置的标签,
按继承顺序。
不考虑通过
set_tags
或clone_tags
在实例上设置的动态标签覆盖。要检索可能包含实例覆盖的标签值,请改用
get_tag
方法。- 参数:
- tag_name字符串
标签值的名称。
- tag_value_default任意类型
如果未找到标签的默认/备用值。
- 返回:
- tag_value
self
中tag_name
标签的值。如果未找到,则返回tag_value_default
。
- classmethod get_class_tags()[source]#
从类中获取类标签,并继承父类的标签级别。
每个兼容
scikit-base
的对象都有一个标签字典。标签可用于存储对象的元数据,或控制对象的行为。标签是特定于实例
self
的键值对,它们是对象构造后不会更改的静态标志。get_class_tags
方法是一个类方法,它检索标签值时仅考虑类级别的标签值和覆盖。它返回一个字典,其中的键是类或其任何父类中设置的
_tags
的任何属性的键。值是相应的标签值,优先级从高到低如下
类 的
_tags
属性中设置的标签。父类 的
_tags
属性中设置的标签,
按继承顺序。
实例可以根据超参数覆盖这些标签。
要检索可能包含实例覆盖的标签,请改用
get_tags
方法。不考虑通过
set_tags
或clone_tags
在实例上设置的动态标签覆盖。要包含来自动态标签的覆盖,请使用
get_tags
。- collected_tags字典
标签名称 : 标签值 对的字典。通过嵌套继承从
_tags
类属性收集。不会被通过set_tags
或clone_tags
设置的动态标签覆盖。
- get_config()[source]#
获取自身的配置标志。
配置是
self
的键值对,通常用作控制行为的瞬时标志。get_config
返回动态配置,它们会覆盖默认配置。默认配置在类或其父类的
_config
类属性中设置,并通过set_config
设置的动态配置覆盖。配置在
clone
或reset
调用下保留。- 返回:
- config_dict字典
配置名称 : 配置值 对的字典。通过嵌套继承从 _config 类属性收集,然后收集 _onfig_dynamic 对象属性中的任何覆盖和新标签。
- get_fitted_params(deep=True)[source]#
获取拟合参数。
- 所需状态
要求状态为“已拟合”。
- 参数:
- deep布尔值,默认=True
是否返回组件的拟合参数。
如果为 True,将返回此对象的参数名 : 参数值字典,包括可拟合组件(= BaseEstimator 类型参数)的拟合参数。
如果为 False,将返回此对象的参数名 : 参数值字典,但不包括组件的拟合参数。
- 返回:
- fitted_params键为字符串的字典
拟合参数字典,paramname : paramvalue 键值对包括
始终:此对象的所有拟合参数,通过 get_param_names 获取,值为此对象该键的拟合参数值
如果 deep=True,还包含组件参数的键/值对,组件参数索引为 [componentname]__[paramname],componentname 的所有参数以 paramname 及其值出现
如果 deep=True,还包含任意级别的组件递归,例如 [componentname]__[componentcomponentname]__[paramname] 等
- classmethod get_param_defaults()[source]#
获取对象的默认参数。
- 返回:
- default_dict: 字典[str, Any]
键是
cls
中在__init__
中定义了默认值的所有参数。值是默认值,如__init__
中定义的那样。
- classmethod get_param_names(sort=True)[source]#
获取对象的参数名称。
- 参数:
- sort布尔值,默认=True
是否按字母顺序返回参数名称 (True),或按其在类
__init__
中出现的顺序返回 (False)。
- 返回:
- param_names: 列表[str]
cls
的参数名称列表。如果sort=False
,则按它们在类__init__
中出现的相同顺序。如果sort=True
,则按字母顺序排列。
- get_params(deep=True)[source]#
获取此对象的参数值字典。
- 参数:
- deep布尔值,默认=True
是否返回组件的参数。
如果为
True
,将返回此对象的参数名 : 参数值dict
,包括组件(=BaseObject
类型参数)的参数。如果为
False
,将返回此对象的参数名 : 参数值dict
,但不包括组件的参数。
- 返回:
- params键为字符串的字典
参数字典,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]#
从实例中获取标签值,并应用标签级别继承和覆盖。
每个兼容
scikit-base
的对象都有一个标签字典。标签可用于存储对象的元数据,或控制对象的行为。标签是特定于实例
self
的键值对,它们是对象构造后不会更改的静态标志。get_tag
方法从实例中检索名称为tag_name
的单个标签的值,考虑标签覆盖,优先级从高到低如下通过
set_tags
或clone_tags
在实例上设置的标签,
在实例构造时。
类 的
_tags
属性中设置的标签。父类 的
_tags
属性中设置的标签,
按继承顺序。
- 参数:
- tag_name字符串
要检索的标签名称
- tag_value_default任意类型,可选;默认=None
如果未找到标签的默认/备用值
- raise_error布尔值
未找到标签时是否引发
ValueError
- 返回:
- tag_value任意类型
self
中tag_name
标签的值。如果未找到,并且raise_error
为 True,则引发错误,否则返回tag_value_default
。
- 引发:
- ValueError,如果
raise_error
为True
。 如果
tag_name
不在self.get_tags().keys()
中,则会引发ValueError
异常。
- ValueError,如果
- get_tags()[source]#
从实例中获取标签,并应用标签级别继承和覆盖。
每个兼容
scikit-base
的对象都有一个标签字典。标签可用于存储对象的元数据,或控制对象的行为。标签是特定于实例
self
的键值对,它们是对象构造后不会更改的静态标志。get_tags
方法返回一个标签字典,其中的键是类或其任何父类中设置的_tags
的任何属性的键,或者通过set_tags
或clone_tags
设置的标签。值是相应的标签值,优先级从高到低如下
通过
set_tags
或clone_tags
在实例上设置的标签,
在实例构造时。
类 的
_tags
属性中设置的标签。父类 的
_tags
属性中设置的标签,
按继承顺序。
- 返回:
- collected_tags字典
标签名称 : 标签值 对的字典。通过嵌套继承从
_tags
类属性收集,然后收集_tags_dynamic
对象属性中的任何覆盖和新标签。
- classmethod get_test_params(parameter_set='default')[source]#
返回 skbase 对象的测试参数设置。
get_test_params
是一个统一的接口点,用于存储测试目的的参数设置。此函数也用于create_test_instance
和create_test_instances_and_names
来构造测试实例。get_test_params
应返回单个dict
,或dict
的list
。每个
dict
是一个用于测试的参数配置,可用于构造一个“有趣的”测试实例。对于get_test_params
返回值中的所有字典params
,调用cls(**params)
都应有效。get_test_params
不需要返回固定的字典列表,它也可以返回动态或随机参数设置。- 参数:
- parameter_set字符串,默认=”default”
要返回的测试参数集的名称,用于测试。如果未为某个值定义特殊参数,将返回 “default” 集。
- 返回:
- params字典或字典列表,默认 = {}
用于创建类测试实例的参数。每个字典都是构造一个“有趣的”测试实例的参数,即 MyClass(**params) 或 MyClass(**params[i]) 创建一个有效的测试实例。create_test_instance 使用 params 中的第一个(或唯一一个)字典
- inverse_transform(X, y=None)[source]#
对 X 进行逆转换,并返回逆转换后的版本。
- 目前假定只有带有以下标签的转换器
“scitype:transform-input”=”Series”, “scitype:transform-output”=”Series”,
才具有 inverse_transform 方法。
- 所需状态
要求状态为“已拟合”。
自身访问
以“_”结尾的拟合模型属性。
self.is_fitted
,必须为 True
- 参数:
- X
sktime
兼容数据容器格式的时间序列 用于拟合转换的数据。
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 的逆转换版本
与 X 类型相同,并符合 mtype 格式规范
- is_composite()[source]#
检查对象是否由其他 BaseObject 组成。
组合对象是包含其他对象作为参数的对象。在实例上调用,因为这可能因实例而异。
- 返回:
- composite: 布尔值
对象是否有任何参数的值是
BaseObject
的派生实例。
- property is_fitted[source]#
是否已调用
fit
。检查对象的
_is_fitted` 属性,该属性在对象构造期间应初始化为 ``False``,并在调用对象的 fit 方法时设置为 True。
- 返回:
- 布尔值
估计器是否已 fit。
- classmethod load_from_path(serial)[source]#
从文件位置加载对象。
- 参数:
- serialZipFile(path).open(“object”) 的结果
- 返回:
- 反序列化的自身,结果输出到
path
,即cls.save(path)
的输出
- 反序列化的自身,结果输出到
- classmethod load_from_serial(serial)[source]#
从序列化内存容器加载对象。
- 参数:
- serial
cls.save(None)
输出的第一个元素
- serial
- 返回:
- 反序列化的自身,结果输出
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,则返回一个内存中的序列化 self;如果path
是文件位置,则将 self 存储在该位置作为一个 zip 文件保存的文件是 zip 文件,包含以下内容: _metadata - 包含 self 的类,即 type(self) _obj - 序列化的 self。此类别使用默认序列化 (pickle)。
- 参数:
- pathNone 或文件位置 (str 或 Path)
如果为 None,self 将保存到内存对象;如果为文件位置,self 将保存到该文件位置。如果
path=”estimator”,则会在当前工作目录 (cwd) 中创建一个名为
estimator.zip
的 zip 文件。path=”/home/stored/estimator”,则会将一个名为
estimator.zip
的 zip 文件
存储在
/home/stored/
中。- serialization_format: str, 默认 = “pickle”
用于序列化的模块。可用选项包括 “pickle” 和 “cloudpickle”。请注意,非默认格式可能需要安装其他软依赖项。
- 返回:
- 如果
path
为 None - 内存中的序列化 self - 如果
path
为文件位置 - 带有文件引用的 ZipFile
- 如果
- set_config(**config_dict)[source]#
将配置标志设置为给定值。
- 参数:
- config_dict字典
配置名称:配置值 对的字典。有效的配置、值及其含义如下所示
- displaystr, “diagram” (默认), 或 “text”
jupyter kernel 如何显示 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
在并行化后 关闭。
- “shutdown_ray”: bool, 默认=True; False 可防止
“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 可在多次函数调用中获得可复现的输出。
- deep布尔值,默认=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 并返回转换后的版本。
- 所需状态
要求状态为“已拟合”。
自身访问
以“_”结尾的拟合模型属性。
self.is_fitted
,必须为 True
- 参数:
- X
sktime
兼容数据容器格式的时间序列 要转换的数据。
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 的转换版本
- 类型取决于 X 的类型和 scitype:transform-output 标签
transform
X
-输出
返回类型
序列
基本类型
pd.DataFrame (1行)
面板
基本类型
pd.DataFrame
序列
序列
序列
面板
序列
面板
序列
面板
面板
- 返回值中的实例对应于 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。
- 所需状态
要求状态为“已拟合”。
自身访问
以“_”结尾的拟合模型属性。
self.is_fitted
,必须为 True
写入自身
以“_”结尾的拟合模型属性。
如果
remember_data
标签为 True,则通过update_data
,将self._X
更新为X
中的值。
- 参数:
- X
sktime
兼容数据容器格式的时间序列 用于更新转换的数据
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
- 返回:
- self估计器的已拟合实例