class AlignerDtwNumba(weighted: bool = False, derivative: bool = False, window=None, itakura_max_slope=None, bounding_matrix: ndarray = None, g: float = 0.0)[source]#
- sktime 原生 DTW 对齐器的接口,支持微分或加权。
简单动态时间规整(DTW)对齐的接口,以及以下加权/微分版本
WDTW - 加权动态时间规整 -
weighted=True, derivative=False
DDTW - 微分动态时间规整 -
weighted=False, derivative=True
WDDTW - 加权微分动态时间规整 -
weighted=True, derivative=True
sktime
对sktime.distances
中distance_alignment_path
提供的基于numba
的高效实现的接口。
该估计器提供了高效的时间规整实现,适用于: * 长度相等的时间序列 * 欧几里得成对距离
对于不等长的时间序列,请使用
sktime.aligners.AlignerDTW
。要使用任意成对距离,请使用sktime.aligners.AlignerDTWfromDist
。(对于微分 DTW,可将一个对齐距离与Differencer
组成流水线)这些距离也作为成对转换器在
sktime.dists_kernels.dtw
中提供。请注意,上面更灵活的选项性能可能较低。
DTW 最初在 [1] 中提出,DTW 通过在计算过程中考虑时间序列的对齐方式来计算两者之间的距离。这通过测量两个时间序列所有元素之间的点wise距离(通常使用欧几里得距离)然后使用动态规划寻找使重对齐时间序列总点wise距离最小的规整路径来实现。
DDTW 是 DTW 的一种变体,最初在 [2] 中提出。DDTW 试图通过更好地考虑时间序列的“形状”来改进 DTW。这是通过将 y 轴数据点视为“形状”的更高级特征来实现的。为此,首先计算序列的一阶导数,然后使用这个派生序列进行 DTW 计算。
WDTW 最初在 [3] 中提出,它基于规整距离添加了乘法权重惩罚。这意味着相位差较小的时间序列施加的权重较小(即施加的惩罚较少),而相位差较大的时间序列施加的权重较大(即施加的惩罚较大)。
WDDTW 最初在 [3] 中提出,作为 DDTW 的扩展。通过给导数添加权重,这意味着对齐不仅考虑时间序列的形状,还考虑相位。
参数:
- weightedbool,可选,默认=False
- 是否计算加权版本的距离。 False = 未修改的距离,即 DTW 距离或微分 DTW 距离。 True = 加权距离,即加权 DTW 或加权微分 DTW。
derivativebool,可选,默认=False
- 是否计算距离或微分距离。 False = 未修改的距离,即 DTW 距离或加权 DTW 距离。 True = 微分距离,即微分 DTW 距离或微分 WDTW。
window: int,默认 = None
- Sakoe-Chiba 窗口半径,指定边界矩阵的三种互斥方式之一。如果为 None,则不使用 Sakoe-Chiba 窗口。如果为 int,则使用半径为 window 的 Sakoe-Chiba 下界窗口。如果传递了 window,则 itakura_max_slope 将被忽略。
itakura_max_slope: float,介于 0. 和 1. 之间,默认=None
- Itakura 平行四边形斜率,指定边界矩阵的三种互斥方式之一。如果为 None,则不使用 Itakura 平行四边形下界。如果为 float,则使用斜率梯度为 itakura_max_slope 的 Itakura 平行四边形下界。
bounding_matrix: 可选,2D np.ndarray,默认=None
- 指定边界矩阵的三种互斥方式之一。形状必须为
(len(X), len(X2))
,len 表示时间点数量,其中 X、X2 是在 transform 中传入的两个时间序列。要使用的自定义边界矩阵。如果提供了此参数,则 window 和 itakura_max_slope 将被忽略。矩阵的结构应使得边界内考虑的索引值为 0,边界外的索引值为无穷大。 g: float,可选,默认=0。仅当
weighted=True
时使用。- 控制函数曲率(斜率)的常数;即,
g
控制对相位差较大的点施加的惩罚程度。 属性:
- is_fitted
fit
方法是否已被调用。参考文献
H. Sakoe, S. Chiba, “Dynamic programming algorithm optimization for spoken word recognition,” IEEE Transactions on Acoustics, Speech and Signal Processing, vol. 26(1), pp. 43–49, 1978.
[1]Keogh, Eamonn & Pazzani, Michael. (2002). Derivative Dynamic Time Warping. First SIAM International Conference on Data Mining. 1. 10.1137/1.9781611972719.1.
[2]Young-Seon Jeong, Myong K. Jeong, Olufemi A. Omitaomu, Weighted dynamic time
[3] (1,2)warping for time series classification, Pattern Recognition, Volume 44, Issue 9, 2011, Pages 2231-2240, ISSN 0031-3203, https://doi.org/10.1016/j.patcog.2010.09.022。
时间序列分类中的扭曲,Pattern Recognition,第 44 卷,第 9 期,2011 年,第 2231-2240 页,ISSN 0031-3203,https://doi.org/10.1016/j.patcog.2010.09.022。
示例
>>> from sktime.utils._testing.series import _make_series >>> from sktime.alignment.dtw_numba import AlignerDtwNumba >>> >>> X0 = _make_series(return_mtype="pd.DataFrame") >>> X1 = _make_series(return_mtype="pd.DataFrame") >>> d = AlignerDtwNumba(weighted=True, derivative=True) >>> align = d.fit([X0, X1]).get_alignment()
方法
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[, Z])根据要对齐的时间序列/序列进行拟合。
返回传入 fit 方法的序列的对齐版本。
返回传入 fit 方法的序列/时间序列的对齐(iloc 索引)。
返回传入 fit 方法的序列/时间序列的对齐(loc 索引)。
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])返回估计器的测试参数设置。
检查对象是否由其他 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)将实例级标签覆盖设置为给定值。
- classmethod get_test_params(parameter_set='default')[source]#
返回估计器的测试参数设置。
- weightedbool,可选,默认=False
- parameter_setstr,默认=”default”
要返回的测试参数集的名称,用于测试。如果未为值定义特殊参数,将返回
"default"
集。目前没有为对齐器保留的值。
- 返回:
- paramsdict 或 dict 列表,默认 = {}
用于创建类测试实例的参数。每个 dict 都是构造一个“有趣的”测试实例的参数,即
MyClass(**params)
或MyClass(**params[i])
创建一个有效的测试实例。create_test_instance
使用params
中的第一个(或唯一的)字典。
- check_is_fitted(method_name=None)[source]#
检查估计器是否已拟合。
检查
_is_fitted
属性是否存在且为True
。is_fitted
属性应在调用对象的fit
方法时设置为True
。如果不是,则抛出
NotFittedError
。- weightedbool,可选,默认=False
- 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
查看。- weightedbool,可选,默认=False
- estimator:class:BaseObject 或派生类的一个实例
- tag_namesstr 或 str 列表,默认 = None
要克隆的标签名称。默认 (
None
) 克隆estimator
中的所有标签。
- 返回:
- self
对
self
的引用。
- classmethod create_test_instance(parameter_set='default')[source]#
使用第一个测试参数集构造类的一个实例。
- weightedbool,可选,默认=False
- parameter_setstr,默认=”default”
要返回的测试参数集的名称,用于测试。如果未为值定义特殊参数,将返回 “default” 集。
- 返回:
- instance具有默认参数的类实例
- classmethod create_test_instances_and_names(parameter_set='default')[source]#
创建所有测试实例的列表及其名称列表。
- weightedbool,可选,默认=False
- parameter_setstr,默认=”default”
要返回的测试参数集的名称,用于测试。如果未为值定义特殊参数,将返回 “default” 集。
- 返回:
- objscls 实例列表
第 i 个实例是
cls(**cls.get_test_params()[i])
- namesstr 列表,与 objs 长度相同
第 i 个元素是测试中 obj 的第 i 个实例的名称。如果实例多于一个,命名约定为
{cls.__name__}-{i}
,否则为{cls.__name__}
- fit(X, Z=None)[source]#
根据要对齐的时间序列/序列进行拟合。
- 状态变更
将状态更改为“已拟合”。
- 写入自身
将 self._is_fitted 标志设置为 True。将 X 和 Z 分别存储到 self._X 和 self._Z。设置以“_”结尾的已拟合模型属性。
- weightedbool,可选,默认=False
- X长度为 n 的 pd.DataFrame(Series)列表
要对齐的时间序列集合
- Z具有 n 行的 pd.DataFrame,可选
元数据,Z 的第 i 行对应于 X 的第 i 个元素
- get_aligned()[source]#
返回传入 fit 方法的序列的对齐版本。
- 行为:返回传入 fit 方法的 X 中未对齐序列的对齐版本
模型应处于已拟合状态,已拟合模型参数从 self 读取
- 所需状态
要求状态为“已拟合”。
- 访问自身属性
以“_”结尾的已拟合模型属性。self._is_fitted
- 返回:
- X_aligned_list: sequence 格式的 pd.DataFrame 列表
长度为 n,索引对应于传入 fit 方法的 X 的索引。第 i 个元素是 X[i] 的重新索引的对齐版本。
- get_alignment()[source]#
返回传入 fit 方法的序列/时间序列的对齐(iloc 索引)。
- 行为:返回传入 fit 方法的 X 中序列的对齐
模型应处于已拟合状态,已拟合模型参数从 self 读取
- 所需状态
要求状态为“已拟合”。
- 访问自身属性
以“_”结尾的已拟合模型属性。self._is_fitted
- 返回:
- alignment 格式的 pd.DataFrame,列名为 ‘ind’+str(i),其中 i 为整数
列包含 X[i] 映射到对齐坐标的 iloc 索引
- get_alignment_loc()[source]#
返回传入 fit 方法的序列/时间序列的对齐(loc 索引)。
- 行为:返回传入 fit 方法的 X 中序列的对齐
模型应处于已拟合状态,已拟合模型参数从 self 读取
- 所需状态
要求状态为“已拟合”。
- 访问自身属性
以“_”结尾的已拟合模型属性。self._is_fitted
- 返回:
- alignment 格式的 pd.DataFrame,列名为 ‘ind’+str(i),其中 i 为整数
列包含 X[i] 映射到对齐坐标的 loc 索引
- 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
方法代替。- weightedbool,可选,默认=False
- 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_distance()[source]#
返回对齐的总距离。
- 行为:返回对应于对齐的总距离
并非所有对齐器都会返回或实现此功能(可选)
- 所需状态
要求状态为“已拟合”。
- 访问自身属性
以“_”结尾的已拟合模型属性。self._is_fitted
- 返回:
- distance: float - 传入 fit 方法的 X 中所有元素之间的总距离
- get_distance_matrix()[source]#
返回对齐的距离矩阵。
- 行为:返回对齐距离的成对距离矩阵
并非所有对齐器都会返回或实现此功能(可选)
- 所需状态
要求状态为“已拟合”。
- 访问自身属性
以“_”结尾的已拟合模型属性。self._is_fitted
- 返回:
- distmat: 一个 (n x n) 的 float 类型 np.array,其中 n 是传入 fit 方法的 X 的长度
[i,j] 条目是传入 fit 方法的 X[i] 和 X[j] 之间的对齐距离
- get_fitted_params(deep=True)[source]#
获取已拟合参数。
- 所需状态
要求状态为“已拟合”。
- weightedbool,可选,默认=False
- deepbool,默认=True
是否返回组件的已拟合参数。
如果为 True,将返回此对象的参数名称 : 值 字典,包括可拟合组件(= BaseEstimator 类型参数)的已拟合参数。
如果为 False,将返回此对象的参数名称 : 值 字典,但不包括组件的已拟合参数。
- 返回:
- fitted_params带有 str 类型键的字典
已拟合参数字典,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]#
获取对象的参数名称。
- weightedbool,可选,默认=False
- sortbool,默认=True
是否按字母顺序排序返回参数名称 (True),或按它们在类
__init__
中出现的顺序返回 (False)。
- 返回:
- param_names: list[str]
cls
的参数名称列表。如果sort=False
,则按它们在类__init__
中出现的相同顺序排列。如果sort=True
,则按字母顺序排列。
- get_params(deep=True)[source]#
获取此对象的参数值字典。
- weightedbool,可选,默认=False
- deepbool,默认=True
是否返回组件的参数。
如果为
True
,将返回此对象的参数名称 : 值dict
,包括组件(=BaseObject
类型参数)的参数。如果为
False
,将返回此对象的参数名称 : 值dict
,但不包括组件的参数。
- 返回:
- params带有 str 类型键的字典
参数字典,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
属性中设置的标签,
按照继承顺序。
- weightedbool,可选,默认=False
- 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
对象属性获取任何覆盖和新标签。
- is_composite()[source]#
检查对象是否由其他 BaseObjects 组成。
复合对象是包含其他对象作为参数的对象。在实例上调用,因为这可能因实例而异。
- 返回:
- composite: bool
对象是否有任何参数的值是
BaseObject
的派生实例。
- property is_fitted[source]#
参考文献
检查对象的
_is_fitted` 属性,该属性在对象构造期间应初始化为 ``False
,并在调用对象的 fit 方法时设置为 True。- 返回:
- bool
估计器是否已被 fit。
- classmethod load_from_path(serial)[source]#
从文件位置加载对象。
- weightedbool,可选,默认=False
- serial
ZipFile(path).open("object")
的结果
- serial
- 返回:
- 反序列化 self,结果输出到
path
,即cls.save(path)
的输出
- 反序列化 self,结果输出到
- classmethod load_from_serial(serial)[source]#
从序列化的内存容器加载对象。
- weightedbool,可选,默认=False
- 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))`` 获得的对象相等。- 返回:
- self
将类的实例重置为干净的初始化后状态,但保留当前的超参数值。
- save(path=None, serialization_format='pickle')[source]#
将序列化的自身保存到字节类对象或到 (.zip) 文件。
行为:如果
path
为 None,返回内存中的序列化 self;如果path
是文件位置,则将 self 存储为该位置的 zip 文件保存的文件是包含以下内容的 zip 文件:_metadata - 包含 self 的类,即 type(self);_obj - 序列化 self。该类使用默认序列化(pickle)。
- weightedbool,可选,默认=False
- 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]#
将配置标志设置为给定值。
- weightedbool,可选,默认=False
- config_dictdict
config 名称 : config 值对的字典。有效的 config、值及其含义如下所示
- displaystr,“diagram”(默认)或 “text”
jupyter 内核如何显示 self 的实例
“diagram” = html 框图表示
“text” = 字符串打印输出
- print_changed_onlybool,默认=True
打印 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
在并行化后关闭。 shutting down after parallelization.
- “shutdown_ray”:bool,默认=True;False 防止
“logger_name”:str,默认=”ray”;要使用的日志记录器名称。
“mute_warnings”:bool,默认=False;如果为 True,则抑制警告
- 返回:
- self对 self 的引用。
注意
改变对象状态,将 config_dict 中的配置复制到 self._config_dynamic。
- set_params(**params)[source]#
设置此对象的参数。
此方法适用于简单的 skbase 对象以及复合对象。参数键字符串
<component>__<parameter>
可用于复合对象(即包含其他对象的对象),以访问组件<component>
中的<parameter>
。如果这使得引用明确,也可以使用不带<component>__
的字符串<parameter>
,例如组件中没有两个参数具有相同的名称<parameter>
。- weightedbool,可选,默认=False
- **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
参数的对象。- weightedbool,可选,默认=False
- 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
查看。- weightedbool,可选,默认=False
- **tag_dictdict
标签名称 : 标签值对的字典。
- 返回:
- Self
对 self 的引用。