RepeatBootstrapTransformer#
- class RepeatBootstrapTransformer(n_series=10)[source]#
重复自举法,将给定的时间序列完全相同地重复
n_series
次。可用作基线方法,或用于模型的随机重新初始化。
- 参数:
- n_seriesint,可选
将生成的重复次数,默认为 10。
- 属性:
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])返回估计器的测试参数设置。
inverse_transform
(X[, y])逆变换 X 并返回逆变换后的版本。
检查对象是否由其他 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 或 list of dict,默认为 {}
用于创建类测试实例的参数。每个 dict 都是构造一个“有趣的”测试实例的参数,即 MyClass(**params) 或 MyClass(**params[i]) 创建一个有效的测试实例。create_test_instance 使用 params 中的第一个(或唯一的)字典。
- 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
设置动态标签覆盖。clone_tags
方法应仅在对象的__init__
方法中、构造期间或通过__init__
构造后立即调用。动态标签被设置为
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 个元素是测试中 objs 中第 i 个实例的名称。命名约定为如果实例多于一个则为
{cls.__name__}-{i}
,否则为{cls.__name__}
- fit(X, y=None)[source]#
将转换器拟合到 X,可选地拟合到 y。
- 状态变化
将状态更改为“已拟合”。
写入 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
中传递,不是可选的。有关所需格式,请参阅类文档字符串了解详细信息。
- 返回:
- self估计器的已拟合实例
- fit_transform(X, y=None)[source]#
拟合数据,然后对其进行变换。
将转换器拟合到 X 和 y,并返回 X 的转换版本。
- 状态变化
将状态更改为“已拟合”。
写入 self:_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 = 时间序列集合。具有 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 的类型和 scitype:transform-output 标签
- X | tf-output | 返回类型 |
|----------|————–|------------------------| | Series | 基本类型 | pd.DataFrame (1 行) | | 面板数据 | 基本类型 | pd.DataFrame | | Series | Series | Series | | 面板数据 | Series | 面板数据 | | Series | 面板数据 | 面板数据 |
- 返回中的实例对应于 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
是
基本类型
,则返回一个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_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]#
获取自身的配置标志。
配置是
self
的键值对,通常用作控制行为的瞬时标志。get_config
返回动态配置,动态配置会覆盖默认配置。默认配置在类或其父类的类属性
_config
中设置,并被通过set_config
设置的动态配置覆盖。配置在
clone
或reset
调用后会被保留。- 返回:
- config_dictdict
配置名:配置值对的字典。通过嵌套继承从 _config 类属性收集,然后加上 _config_dynamic 对象属性中的任何覆盖和新标签。
- get_fitted_params(deep=True)[source]#
获取拟合后的参数。
- 所需状态
需要状态为“已拟合”。
- 参数:
- deepbool,默认为 True
是否返回组件的已拟合参数。
如果为 True,将返回此对象的参数名:参数值字典,包括可拟合组件(= BaseEstimator 值参数)的已拟合参数。
如果为 False,将返回此对象的参数名:参数值字典,但不包括组件的已拟合参数。
- 返回:
- fitted_params键为 str 值的字典
已拟合参数的字典,键值对包括参数名 : 参数值
始终包括:此对象的所有已拟合参数,通过 get_param_names 获得的值为此对象该键的已拟合参数值
如果 deep=True,还包含组件参数的键/值对,组件参数的索引为 [组件名]__[参数名],组件名 的所有参数以 参数名 及其值的形式出现
如果 deep=True,还包含任意层级的组件递归,例如,[组件名]__[组件组件名]__[参数名] 等
- 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 值的字典
参数字典,键值对包括参数名 : 参数值
始终包括:此对象的所有参数,通过
get_param_names
获得的值为此对象该键的参数值,这些值总是与构造时传递的值相同如果
deep=True
,还包含组件参数的键/值对,组件参数的索引为[组件名]__[参数名]
,组件名
的所有参数以参数名
及其值的形式出现如果
deep=True
,还包含任意层级的组件递归,例如,[组件名]__[组件组件名]__[参数名]
等
- 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
对象属性中的任何覆盖和新标签。
- inverse_transform(X, y=None)[source]#
逆变换 X 并返回逆变换后的版本。
- 目前假定只有标签为
“scitype:transform-input”=”Series”,”scitype:transform-output”=”Series”,
的转换器具有 inverse_transform。
- 所需状态
需要状态为“已拟合”。
访问 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 的类型相同,并符合 mtype 格式规范
- is_composite()[source]#
检查对象是否由其他 BaseObjects 组成。
复合对象是指参数值为对象的对象。在实例上调用,因为这可能因实例而异。
- 返回:
- 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,结果是
cls.save(path)
在path
处的输出
- 反序列化的 self,结果是
- classmethod load_from_serial(serial)[source]#
从序列化的内存容器加载对象。
- 参数:
- serial`cls.save(None)` 输出的第 1 个元素
- 返回:
- 反序列化的 self,结果是
cls.save(None)
的输出serial
- 反序列化的 self,结果是
- 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”,则会在当前工作目录创建 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 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 的引用。
Notes
更改对象状态,将 config_dict 中的配置复制到 self._config_dynamic。
- set_params(**params)[source]#
设置此对象的参数。
此方法适用于简单的 skbase 对象以及复合对象。可以使用参数键字符串
<component>__<parameter>
来访问复合对象(即包含其他对象的对象)中组件<component>
的<parameter>
。如果引用是明确的(例如,没有两个组件参数的名称都是<parameter>
),也可以使用字符串<parameter>
,不带<component>__
。- 参数:
- **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 并返回变换后的版本。
- 所需状态
需要状态为“已拟合”。
访问 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 的类型和 scitype:transform-output 标签
转换
X
-输出
返回类型
Series
基本类型
pd.DataFrame (1 行)
面板数据
基本类型
pd.DataFrame
Series
Series
Series
面板数据
Series
面板数据
Series
面板数据
面板数据
- 返回中的实例对应于 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
是
基本类型
,则返回一个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 中的属性
以“_”结尾的已拟合模型属性。
self.is_fitted
,必须为 True
写入 self
以“_”结尾的已拟合模型属性。
如果
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 = 时间序列集合。具有 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估计器的已拟合实例