RBFTransformer#
- class RBFTransformer(centers=None, gamma=1.0, rbf_type='gaussian', apply_to='index', use_torch=False)[source]#
一个用于将径向基函数 (RBF) 应用于时间序列数据的自定义转换器。
该转换器允许用户将各种 RBF 核函数应用于时间序列数据,例如高斯核、多二次函数核和逆多二次函数核。该转换器基于时间点和指定中心点之间的距离生成新特征来增强输入数据,为机器学习模型提供了一种灵活且非线性的特征表示。
此实现受到 scikit-lego 包中的 RepeatingBasisFunction 转换器的启发:koaning/scikit-lego
数学背景:考虑一个时间序列,其时间戳为 \(t_1, t_2, \dots, t_N\)。
转换计算时间点和一组预定义“中心点”\(c_1, \dots, c_K\) 之间的核距离。对于每个时间点 \(t_i\),计算 \(t_i\) 和每个中心点 \(c_k\) 之间的 RBF,生成一个转换值矩阵。每个核函数取决于时间点和中心点之间的距离。
在数学上,高斯 RBF 的转换定义为
\(\phi(t_i, c_k) = \exp(-\gamma (t_i - c_k)^2)\)
其中 \(\gamma\) 是控制 RBF 扩散的缩放因子。
还提供其他类型的 RBF:
- 多二次函数核
\(\phi(t_i, c_k) = \sqrt{1 + \gamma (t_i - c_k)^2}\)
- 逆多二次函数核
\(\phi(t_i, c_k) = \frac{1}{\sqrt{1 + \gamma (t_i - c_k)^2}}\)
这些转换会为每个时间点生成新特征,通过添加考虑与中心点接近度的非线性转换来增强数据的表示能力。
- 参数:
- centers类似数组, 形状 (n_centers,), 可选 (默认=None)
RBF 的中心点 \(c_k\)。这些中心点定义了用于衡量输入数据距离的参考点。如果为 None,则中心点将均匀分布在输入数据的范围内。
- gamma浮点数, 可选 (默认=1.0)
扩散或缩放因子 \(\gamma\),控制每个 RBF 中心的影响范围。较大的 \(\gamma\) 值使 RBF 更尖锐(扩散范围更小),而较小的值使 RBF 更平滑。
- rbf_type{“gaussian”, “multiquadric”, “inverse_multiquadric”},
可选 (默认=”gaussian”)
要应用的径向基函数类型
“gaussian”:\(\exp(-\gamma (t - c)^2)\)
“multiquadric”:\(\sqrt{1 + \gamma (t - c)^2}\)
“inverse_multiquadric”:\(\frac{1}{\sqrt{1 + \gamma (t - c)^2}}\)
- apply_to{“index”, “values”}, 可选 (默认=”index”)
确定是将 RBF 应用于时间索引还是时间序列的值。
“index”:将 RBF 应用于时间索引。
“values”:将 RBF 应用于时间序列的值。
- use_torch布尔值, 可选 (默认=False)
计算 RBF 时是否使用 torch。如果为 True,则转换器(如果存在 PyTorch)将使用 PyTorch 进行 RBF 计算。如果不存在,将回退到 NumPy。如果为 False,则将使用 NumPy。
- 属性:
- fitted_centers_类似数组, 形状 (n_centers_,)
用于 RBF 转换的中心点。这些中心点由用户提供或在拟合期间从数据中计算得出。
- torch_available_布尔值
指示 PyTorch 是否可用。这在拟合期间检查。
方法
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
()从实例获取标签,并考虑标签级别的继承和覆盖。
返回转换器的测试参数集。
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 可选。
- classmethod get_test_params()[source]#
返回转换器的测试参数集。
提供用于单元测试或实验的示例参数。
- 返回:
- paramsdict 列表
每个字典表示一组用于初始化转换器的参数。
- 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
设置动态标签覆盖。clone_tags
方法只能在对象的__init__
方法中、构造期间或通过__init__
直接构造后调用。动态标签被设置为
estimator
中标签的值,名称在tag_names
中指定。tag_names
的默认值将estimator
的所有标签写入self
。当前标签值可以通过
get_tags
或get_tag
检查。- 参数:
- estimator:class:BaseObject 或派生类的实例
- tag_names字符串或字符串列表, 默认 = None
要克隆的标签名称。默认值 (
None
) 克隆estimator
中的所有标签。
- 返回:
- 自身
对
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 个元素是测试中 objs 的第 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
(实例, 时间)
,3D np.ndarray
(实例, 变量, 时间)
,Series
类型pd.DataFrame
的list
Hierarchical
scitype = 分层时间序列集合。pd.DataFrame
具有 3 个或更多级行MultiIndex
(层次_1, ..., 层次_n, 时间)
有关数据格式的更多详细信息,请参阅 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
(实例, 时间)
,3D np.ndarray
(实例, 变量, 时间)
,Series
类型pd.DataFrame
的list
Hierarchical
scitype = 分层时间序列集合。pd.DataFrame
具有 3 个或更多级行MultiIndex
(层次_1, ..., 层次_n, 时间)
有关数据格式的更多详细信息,请参阅 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
,则返回是 Panel,其实例数量与X
相同(转换器应用于每个输入的 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: 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键为字符串值的字典
参数字典,键值对包括 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_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 = 时间序列集合。pd.DataFrame
具有 2 级行MultiIndex
(实例, 时间)
,3D np.ndarray
(实例, 变量, 时间)
,Series
类型pd.DataFrame
的list
Hierarchical
scitype = 分层时间序列集合。pd.DataFrame
具有 3 个或更多级行MultiIndex
(层次_1, ..., 层次_n, 时间)
有关数据格式的更多详细信息,请参阅 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”) 的结果
- 返回:
- 反序列化的 self,结果在
path
处,是cls.save(path)
的输出
- 反序列化的 self,结果在
- classmethod load_from_serial(serial)[source]#
从序列化内存容器加载对象。
- 参数:
- serial
cls.save(None)
输出的第一个元素
- serial
- 返回:
- 反序列化的 self,结果是
serial
,是cls.save(None)
的输出
- 反序列化的 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))`` 后获得的对象。- 返回:
- 自身
类实例被重置为干净的初始化后状态,但保留当前的超参数值。
- 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) 创建一个 zip 文件
estimator.zip
。path=”/home/stored/estimator”,则将在
/home/stored/
中存储一个 zip 文件estimator.zip
。- serialization_format: str, 默认 = “pickle”
用于序列化的模块。可用选项为“pickle”和“cloudpickle”。请注意,非默认格式可能需要安装其他软依赖项。
- 返回:
- 如果
path
为 None - 内存中的序列化 self - 如果
path
为文件位置 - 引用该文件的 ZipFile
- 如果
- set_config(**config_dict)[source]#
将配置标志设置为给定值。
- 参数:
- config_dict字典
配置名:配置值对的字典。下方列出了有效的配置、值及其含义
- displaystr,“diagram”(默认)或“text”
jupyter 内核如何显示 self 的实例
“diagram” = html 框图表示
“text” = 字符串打印输出
- print_changed_onlybool, 默认=True
打印 self 时是只列出与默认值不同的 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
在并行化后关闭。 并行化后正在关闭。
- “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>
。不带<component>__
的字符串<parameter>
也可使用,如果这使得引用明确(例如,组件中没有两个参数同名为<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 中的项
以“_”结尾的拟合模型属性。
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
(实例, 时间)
,3D np.ndarray
(实例, 变量, 时间)
,Series
类型pd.DataFrame
的list
Hierarchical
scitype = 分层时间序列集合。pd.DataFrame
具有 3 个或更多级行MultiIndex
(层次_1, ..., 层次_n, 时间)
有关数据格式的更多详细信息,请参阅 mtype 的术语表。有关用法,请参阅转换器教程
examples/03_transformers.ipynb
- y可选,sktime 兼容数据格式的数据,默认=None
附加数据,例如转换的标签。一些转换器需要此项,详细信息请参阅类文档字符串。
- X
- 返回:
- 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 中的实例
- 表中未列出的组合目前不支持
- 明确地说,带示例
如果
X
是Series
(例如,pd.DataFrame
)
并且
transform-output
是Series
,则返回是相同 mtype 的单个 Series。示例:对单个序列进行去趋势如果
X
是Panel
(例如,pd-multiindex
) 并且transform-output
是
Series
,则返回是 Panel,其实例数量与X
相同(转换器应用于每个输入的 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 中的项
以“_”结尾的拟合模型属性。
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
(实例, 时间)
,3D np.ndarray
(实例, 变量, 时间)
,Series
类型pd.DataFrame
的list
Hierarchical
scitype = 分层时间序列集合。pd.DataFrame
具有 3 个或更多级行MultiIndex
(层次_1, ..., 层次_n, 时间)
有关数据格式的更多详细信息,请参阅 mtype 的术语表。有关用法,请参阅转换器教程
examples/03_transformers.ipynb
- y可选,sktime 兼容数据格式的数据,默认=None
附加数据,例如转换的标签。一些转换器需要此项,详细信息请参阅类文档字符串。
- X
- 返回:
- self估计器的已拟合实例