SlopeTransformer#
- class SlopeTransformer(num_intervals=8)[source]#
按段斜率变换。
一个对时间序列数据框执行斜率变换的类。它将时间序列分割成 num_intervals 个片段。然后,在每个片段内,执行全最小二乘回归以提取该片段的梯度。
- 参数:
- num_intervalsint,大致相等片段的数量
将时间序列分割成的片段数量。
- 属性:
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_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_namestr,可选
调用此函数的方法的名称。如果提供,错误消息将包含此信息。
- 引发:
- NotFittedError
如果估计器尚未拟合。
- 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
设置动态标签覆盖。只能在对象的
__init__
方法中、构造期间或通过__init__
构造后直接调用clone_tags
方法。动态标签被设置为
estimator
中标签的值,其名称在tag_names
中指定。tag_names
的默认值是将estimator
中的所有标签写入self
。当前标签值可以通过
get_tags
或get_tag
检查。- 参数:
- estimator:class:BaseObject 或派生类的实例
- tag_namesstr 或 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 个元素是测试中 obj 的第 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")
。
- 参数:
- X符合
sktime
数据容器格式的时间序列 用于拟合变换的数据。
sktime
中的各种数据格式是所谓的 mtype 规范,每种 mtype 都实现了一个抽象的 scitype。Series
scitype = 单个时间序列。pd.DataFrame
,pd.Series
或np.ndarray
(1D 或 2D)Panel
scitype = 时间序列集合。 具有 2 级行MultiIndex
(实例, 时间)
的pd.DataFrame
,3D np.ndarray
(实例, 变量, 时间)
, 或list
形式的Series
类型pd.DataFrame
Hierarchical
scitype = 分层时间序列集合。 具有 3 级或更多行MultiIndex
(层级 1, ..., 层级 n, 时间)
的pd.DataFrame
有关数据格式的更多详细信息,请参阅 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 的变换版本。
- 状态改变
将状态更改为“fitted”。
写入 self: _is_fitted : 标志设置为 True。 _X : X,如果 remember_data 标签为 True,则为 X 的强制类型副本
如果可能,通过引用强制转换为内部类型或 update_data 兼容类型
模型属性(以“_”结尾):取决于估计器
- 参数:
- X符合
sktime
数据容器格式的时间序列 用于拟合变换的数据,以及要变换的数据。
sktime
中的各种数据格式是所谓的 mtype 规范,每种 mtype 都实现了一个抽象的 scitype。Series
scitype = 单个时间序列。pd.DataFrame
,pd.Series
或np.ndarray
(1D 或 2D)Panel
scitype = 时间序列集合。 具有 2 级行MultiIndex
(实例, 时间)
的pd.DataFrame
,3D np.ndarray
(实例, 变量, 时间)
, 或list
形式的Series
类型pd.DataFrame
Hierarchical
scitype = 分层时间序列集合。 具有 3 级或更多行MultiIndex
(层级 1, ..., 层级 n, 时间)
的pd.DataFrame
有关数据格式的更多详细信息,请参阅 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-row) | | 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 实例)。示例:Panel 中的所有时间序列都被单独去趋势如果
X
是Series
或Panel
,并且transform-output
是
Primitives
,则返回是与X
中实例数量相同行数的pd.DataFrame
。示例:返回的第 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_namestr
标签值的名称。
- 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_tagsdict
标签名称:标签值对的字典。通过嵌套继承从
_tags
类属性收集。不受通过set_tags
或clone_tags
设置的动态标签的覆盖。
- get_config()[source]#
获取自身的配置标志。
Configs 是
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 值键的 dict
拟合参数字典, paramname : paramvalue 键值对包括
始终:此对象的所有拟合参数,通过 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
参数字典, 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_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
。
- ValueError,如果
- get_tags()[source]#
从实例获取标签,并考虑标签级别的继承和覆盖。
每个兼容
scikit-base
的对象都有一个标签字典。标签可用于存储对象的元数据或控制对象的行为。标签是特定于实例
self
的键值对,它们是对象构造后不会改变的静态标志。get_tags
方法返回一个标签字典,其键是类或其任何父类中设置的_tags
属性的任何键,或者通过set_tags
或clone_tags
设置的标签。值是相应的标签值,按以下降序优先级覆盖
通过
set_tags
或clone_tags
在实例上设置的标签,
在实例构造时。
在类的
_tags
属性中设置的标签。在父类的
_tags
属性中设置的标签,
按继承顺序。
- 返回:
- collected_tagsdict
标签名称:标签值对的字典。通过嵌套继承从
_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
列表。每个
dict
都是用于测试的参数配置,可用于构造一个“有趣的”测试实例。对于get_test_params
返回中的所有字典params
,调用cls(**params)
应该有效。get_test_params
不需要返回固定的字典列表,它也可以返回动态或随机的参数设置。- 参数:
- parameter_setstr,默认值=”default”
要返回的测试参数集的名称,用于测试。如果未为值定义特殊参数,将返回 “default” 集。
- 返回:
- paramsdict 或 dict 列表,默认值 = {}
用于创建类测试实例的参数。每个 dict 都是构造一个“有趣的”测试实例的参数,即 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 方法。
- 所需状态
要求状态为“fitted”。
访问 self 中的属性
以“_”结尾的拟合模型属性。
self.is_fitted
,必须为 True
- 参数:
- X符合
sktime
数据容器格式的时间序列 用于拟合变换的数据。
sktime
中的各种数据格式是所谓的 mtype 规范,每种 mtype 都实现了一个抽象的 scitype。Series
scitype = 单个时间序列。pd.DataFrame
,pd.Series
或np.ndarray
(1D 或 2D)Panel
scitype = 时间序列集合。 具有 2 级行MultiIndex
(实例, 时间)
的pd.DataFrame
,3D np.ndarray
(实例, 变量, 时间)
, 或list
形式的Series
类型pd.DataFrame
Hierarchical
scitype = 分层时间序列集合。 具有 3 级或更多行MultiIndex
(层级 1, ..., 层级 n, 时间)
的pd.DataFrame
有关数据格式的更多详细信息,请参阅 mtype 词汇表。有关用法,请参阅变换器教程
examples/03_transformers.ipynb
- y可选,符合 sktime 数据格式的数据,默认值=None
附加数据,例如用于变换的标签。某些变换器需要此数据,详细信息请参阅类文档字符串。
- X符合
- 返回:
- 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]#
从序列化内存容器加载对象。
- 参数:
- 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=None)[source]#
将序列化的自身保存到字节类对象或到 (.zip) 文件。
行为:如果
path
为 None,则返回一个内存中的序列化自身;如果path
是文件位置,则将自身存储在该位置作为 zip 文件保存的文件是 zip 文件,包含以下内容:_metadata - 包含自身的类,即 type(self);_obj - 序列化的自身。此类别使用默认的序列化方式 (pickle)。
- 参数:
- path None 或文件位置 (str 或 Path)
如果为 None,则将自身保存到内存对象中;如果为文件位置,则将自身保存到该文件位置。如果
path=”estimator”,则会在当前工作目录 (cwd) 创建一个 zip 文件
estimator.zip
。path=”/home/stored/estimator”,则会在
存储在
/home/stored/
。- serialization_format: str, 默认值 = “pickle”
用于序列化的模块。可用选项包括 “pickle” 和 “cloudpickle”。请注意,非默认格式可能需要安装其他可选依赖项。
- 返回:
- 如果
path
为 None - 内存中的序列化自身 - 如果
path
是文件位置 - 包含文件引用的 ZipFile
- 如果
- set_config(**config_dict)[source]#
将配置标志设置为给定值。
- 参数:
- config_dictdict
配置名称:配置值对的字典。有效的配置、值及其含义如下所列
- display str,“diagram”(默认)或“text”
jupyter kernel 如何显示自身实例
“diagram” = html 框图表示
“text” = 字符串输出
- print_changed_only bool, 默认值=True
打印自身时是否只列出与默认值不同的自身参数 (False),还是列出所有参数名称和值 (False)。不进行嵌套,即只影响自身而不影响组件估计器。
- warnings str,“on”(默认)或“off”
是否引发警告,只影响来自 sktime 的警告
“on” = 将引发来自 sktime 的警告
“off” = 将不会引发来自 sktime 的警告
- backend:parallel str,可选,默认值=”None”
广播/向量化时用于并行化的后端,以下之一:
“None”:顺序执行循环,简单的列表推导式
“loky”、“multiprocessing” 和 “threading”:使用
joblib.Parallel
“joblib”:自定义和第三方
joblib
后端,例如spark
“dask”:使用
dask
,需要在环境中安装dask
包“ray”:使用
ray
,需要在环境中安装ray
包
- backend:parallel:params dict,可选,默认值={}(不传递参数)
作为配置传递给并行化后端的附加参数。有效键取决于
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_conversion str,“on”(默认)、“off”或有效的 mtype 字符串之一
控制
_fit
、_transform
、_inverse_transform
、_update
的输入检查和转换"on"
- 执行输入检查和转换"off"
- 在将数据传递给内部方法之前,不执行输入检查和转换有效的 mtype 字符串 - 输入被假定为指定的 mtype,执行转换但不进行检查
- output_conversion str,“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 dict
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_state int, RandomState 实例或 None, 默认值=None
伪随机数生成器,用于控制随机整数的生成。传入 int 可确保多次函数调用输出可重现。
- deepbool,默认值=True
是否在 skbase 对象值参数(即组件估计器)中设置随机状态。
如果为 False,则仅设置
self
的random_state
参数(如果存在)。如果为 True,则也会设置组件对象中的
random_state
参数。
- self_policy str,{“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_tags
或get_tag
检查。- 参数:
- **tag_dict dict
标签名称:标签值对的字典。
- 返回:
- Self
指向自身的引用。
- transform(X, y=None)[source]#
变换 X 并返回变换后的版本。
- 所需状态
要求状态为“fitted”。
访问 self 中的属性
以“_”结尾的拟合模型属性。
self.is_fitted
,必须为 True
- 参数:
- X符合
sktime
数据容器格式的时间序列 要转换的数据。
sktime
中的各种数据格式是所谓的 mtype 规范,每种 mtype 都实现了一个抽象的 scitype。Series
scitype = 单个时间序列。pd.DataFrame
,pd.Series
或np.ndarray
(1D 或 2D)Panel
scitype = 时间序列集合。 具有 2 级行MultiIndex
(实例, 时间)
的pd.DataFrame
,3D np.ndarray
(实例, 变量, 时间)
, 或list
形式的Series
类型pd.DataFrame
Hierarchical
scitype = 分层时间序列集合。 具有 3 级或更多行MultiIndex
(层级 1, ..., 层级 n, 时间)
的pd.DataFrame
有关数据格式的更多详细信息,请参阅 mtype 词汇表。有关用法,请参阅变换器教程
examples/03_transformers.ipynb
- y可选,符合 sktime 数据格式的数据,默认值=None
附加数据,例如用于变换的标签。某些变换器需要此数据,详细信息请参阅类文档字符串。
- X符合
- 返回:
- 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 实例)。示例:Panel 中的所有时间序列都被单独去趋势如果
X
是Series
或Panel
,并且transform-output
是
Primitives
,则返回是与X
中实例数量相同行数的pd.DataFrame
。示例:返回的第 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
。
- 参数:
- X符合
sktime
数据容器格式的时间序列 用于更新转换的数据
sktime
中的各种数据格式是所谓的 mtype 规范,每种 mtype 都实现了一个抽象的 scitype。Series
scitype = 单个时间序列。pd.DataFrame
,pd.Series
或np.ndarray
(1D 或 2D)Panel
scitype = 时间序列集合。 具有 2 级行MultiIndex
(实例, 时间)
的pd.DataFrame
,3D np.ndarray
(实例, 变量, 时间)
, 或list
形式的Series
类型pd.DataFrame
Hierarchical
scitype = 分层时间序列集合。 具有 3 级或更多行MultiIndex
(层级 1, ..., 层级 n, 时间)
的pd.DataFrame
有关数据格式的更多详细信息,请参阅 mtype 词汇表。有关用法,请参阅变换器教程
examples/03_transformers.ipynb
- y可选,符合 sktime 数据格式的数据,默认值=None
附加数据,例如用于变换的标签。某些变换器需要此数据,详细信息请参阅类文档字符串。
- X符合
- 返回:
- self估计器的拟合实例