BaseTimeSeriesLloyds#
- class BaseTimeSeriesLloyds(n_clusters: int = 8, init_algorithm: str | Callable = 'random', metric: str | Callable = 'euclidean', n_init: int = 10, max_iter: int = 300, tol: float = 1e-06, verbose: bool = False, random_state: int | RandomState = None, distance_params: dict = None)[source]#
实现了时间序列 Lloyds 算法的抽象类。
- 参数:
- n_clusters: int, 默认值 = 8
要形成的簇的数量以及要生成的中心点数量。
- init_algorithm: str, np.ndarray (形状为 (n_clusters, n_dimensions,
series_length)) 的 3 维数组), 默认值 = ‘forgy’ 初始化簇中心的方法或初始簇中心数组。以下字符串均有效:[‘kmeans++’, ‘random’, ‘forgy’]
- metric: str 或 Callable, 默认值 = ‘dtw’
用于计算时间序列之间相似度的距离度量。以下任何一个都有效:[‘dtw’, ‘euclidean’, ‘erp’, ‘edr’, ‘lcss’, ‘squared’, ‘ddtw’, ‘wdtw’, ‘wddtw’]
- n_init: int, 默认值 = 10
k-means 算法将使用不同的中心点种子运行的次数。最终结果将是 n_init 次连续运行中惯性最佳的输出。
- max_iter: int, 默认值 = 30
单次运行中 k-means 算法的最大迭代次数。
- tol: float, 默认值 = 1e-6
对于两次连续迭代中簇中心的差异的 Frobenius 范数的相对容忍度,用于声明收敛。
- verbose: bool, 默认值 = False
冗余模式。
- random_state: int 或 np.random.RandomState 实例或 None, 默认值 = None
确定中心点初始化的随机数生成。
- distance_params: dict, 默认值 = None
包含所使用距离度量的 kwargs 的字典。
- 属性:
- cluster_centers_: np.ndarray (形状为 (n_clusters, n_dimensions,
series_length)) 的 3 维数组) 表示每个簇中心的时间序列。如果算法在完全收敛之前停止,这些将与 labels_ 不一致。
- labels_: np.ndarray (形状为 (n_instance,)) 的 1 维数组)
表示每个时间序列所属簇索引的标签。
- inertia_: float
样本到其最近簇中心的平方距离之和,如果提供了样本权重,则按样本权重加权。
- n_iter_: int
运行的迭代次数。
方法
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])将时间序列聚类器拟合到训练数据。
fit_predict
(X[, y])计算簇中心并预测每个时间序列的簇索引。
get_class_tag
(tag_name[, tag_value_default])从类获取类标签值,具有来自父类的标签级别继承。
从类获取类标签,具有来自父类的标签级别继承。
获取 self 的配置标志。
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 对象的测试参数设置。
检查对象是否由其他 BaseObjects 组成。
load_from_path
(serial)从文件位置加载对象。
load_from_serial
(serial)从序列化内存容器加载对象。
predict
(X[, y])预测 X 中每个样本所属的最接近的簇。
预测 X 中序列的标签概率。
reset
()将对象重置为干净的初始化后状态。
save
([path, serialization_format])将序列化的 self 保存到字节类对象或 (.zip) 文件。
score
(X[, y])评估聚类器的质量。
set_config
(**config_dict)将配置标志设置为给定值。
set_params
(**params)设置此对象的参数。
set_random_state
([random_state, deep, ...])为 self 设置 random_state 伪随机种子参数。
set_tags
(**tag_dict)将实例级标签覆盖设置为给定值。
- check_is_fitted(method_name=None)[source]#
检查估计器是否已拟合。
检查估计器是否已拟合。
is_fitted
属性应在调用对象的fit
方法时设置为True
。如果未拟合,则引发
NotFittedError
。- 参数:
- method_namestr, 可选
调用此函数的方法的名称。如果提供,错误消息将包含此信息。
- 引发:
- NotFittedError
如果估计器尚未拟合。
- clone()[source]#
获取具有相同超参数和配置的对象的克隆。
克隆是一个没有共享引用、处于初始化后状态的不同对象。此函数等同于返回
self
的sklearn.clone
。等同于构造一个具有
self
参数的新type(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 或 list of 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])
。- nameslist of str, 与 objs 长度相同
第 i 个元素是测试中 obj 的第 i 个实例的名称。如果实例多于一个,命名约定为
{cls.__name__}-{i}
,否则为{cls.__name__}
。
- fit(X, y=None)[source]#
将时间序列聚类器拟合到训练数据。
- 状态改变
将状态更改为“已拟合”。
- 写入 self
将 self.is_fitted 设置为 True。设置以“_”结尾的拟合模型属性。
- 参数:
- XPanel scitype 的 sktime 兼容时间序列面板数据容器
用于拟合估计器的时间序列。
可以是
Panel
scitype 的任何 mtype,例如pd-multiindex: 列为变量,索引为 pd.MultiIndex 的 pd.DataFrame,其中第一级为实例索引,第二级为时间索引
numpy3D: 形状为 [n_instances, n_dimensions, series_length] 的 3D np.array (任意维数,等长序列)
或任何其他支持的
Panel
mtype
mtype 列表,请参见
datatypes.SCITYPE_REGISTER
具体规范,请参见
examples/AA_datatypes_and_datasets.ipynb
并非所有估计器都支持具有多元或不等长序列的面板,详细信息请参见标签参考。
- y被忽略,存在是为了 API 一致性。
- 返回:
- self对 self 的引用。
- fit_predict(X, y=None) ndarray [source]#
计算簇中心并预测每个时间序列的簇索引。
便捷方法;等同于先调用 fit(X) 再调用 predict(X)
- 参数:
- XPanel scitype 的 sktime 兼容时间序列面板数据容器
要聚类的时间序列。
可以是
Panel
scitype 的任何 mtype,例如pd-multiindex: 列为变量,索引为 pd.MultiIndex 的 pd.DataFrame,其中第一级为实例索引,第二级为时间索引
numpy3D: 形状为 [n_instances, n_dimensions, series_length] 的 3D np.array (任意维数,等长序列)
或任何其他支持的
Panel
mtype
mtype 列表,请参见
datatypes.SCITYPE_REGISTER
具体规范,请参见
examples/AA_datatypes_and_datasets.ipynb
并非所有估计器都支持具有多元或不等长序列的面板,详细信息请参见标签参考。
- y: 被忽略,存在是为了 API 一致性。
- 返回:
- np.ndarray (形状为 (n_instances,)) 的 1 维数组)
X 中每个时间序列所属簇的索引。
- 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 的配置标志。
配置是
self
的键值对,通常用作控制行为的瞬态标志。get_config
返回动态配置,这些配置会覆盖默认配置。默认配置在类或其父类的类属性
_config
中设置,并被通过set_config
设置的动态配置覆盖。配置在
clone
或reset
调用中被保留。- 返回:
- config_dictdict
配置名称:配置值对的字典。通过嵌套继承从_config类属性收集,然后从_onfig_dynamic对象属性获取任何覆盖和新标签。
- get_fitted_params(deep=True)[source]#
获取已拟合的参数。
- 所需状态
要求状态为“已拟合”(fitted)。
- 参数:
- deepbool, default=True
是否返回组件的已拟合参数。
如果为 True,则返回此对象的参数名称 : 值字典,包括可拟合组件(= BaseEstimator 类型参数)的已拟合参数。
如果为 False,则返回此对象的参数名称 : 值字典,但不包括组件的已拟合参数。
- 返回:
- fitted_paramsdict with str-valued keys
已拟合参数的字典,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, default=True
是否按字母顺序(True)或按它们在类
__init__
中出现的顺序(False)返回参数名称。
- 返回:
- param_names: list[str]
cls
的参数名称列表。如果sort=False
,则按它们在类__init__
中出现的相同顺序排列。如果sort=True
,则按字母顺序排列。
- get_params(deep=True)[source]#
获取此对象的参数值字典。
- 参数:
- deepbool, default=True
是否返回组件的参数。
如果为
True
,则返回此对象的参数名称 : 值dict
,包括组件(=BaseObject
类型参数)的参数。如果为
False
,则返回此对象的参数名称 : 值dict
,但不包括组件的参数。
- 返回:
- paramsdict with str-valued keys
参数字典,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任意类型,可选; 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
,或者一个list
ofdict
。每个
dict
都是用于测试的参数配置,可用于构造一个“有趣”的测试实例。对于get_test_params
返回中的所有字典params
,调用cls(**params)
应该是有效的。get_test_params
不必返回固定的字典列表,它也可以返回动态或随机的参数设置。- 参数:
- parameter_setstr, 默认值=”default”
要返回的测试参数集的名称,用于测试。如果某个值没有定义特殊参数,将返回 “default” 集。
- 返回:
- paramsdict or list of dict, default = {}
用于创建类的测试实例的参数。每个字典都是构造一个“有趣”的测试实例的参数,即MyClass(**params)或MyClass(**params[i])创建一个有效的测试实例。create_test_instance使用params中的第一个(或唯一一个)字典
- 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)
输出的第一个元素
- serial
- 返回:
- 反序列化的 self,结果是
cls.save(None)
输出的serial
- 反序列化的 self,结果是
- predict(X, y=None) ndarray [source]#
预测 X 中每个样本所属的最接近的簇。
- 参数:
- XPanel scitype 的 sktime 兼容时间序列面板数据容器
要聚类的时间序列。
可以是
Panel
scitype 的任何 mtype,例如pd-multiindex: 列为变量,索引为 pd.MultiIndex 的 pd.DataFrame,其中第一级为实例索引,第二级为时间索引
numpy3D: 形状为 [n_instances, n_dimensions, series_length] 的 3D np.array (任意维数,等长序列)
或任何其他支持的
Panel
mtype
mtype 列表,请参见
datatypes.SCITYPE_REGISTER
具体规范,请参见
examples/AA_datatypes_and_datasets.ipynb
并非所有估计器都支持具有多元或不等长序列的面板,详细信息请参见标签参考。
- y: 被忽略,存在是为了 API 一致性。
- 返回:
- np.ndarray (形状为 (n_instances,)) 的 1 维数组)
X 中每个时间序列所属簇的索引。
- predict_proba(X)[source]#
预测 X 中序列的标签概率。
默认行为是调用 _predict 并将预测的类概率设置为 1,其他类概率设置为 0。如果可以获得更好的估计值,则覆盖此方法。
- 参数:
- XPanel scitype 的 sktime 兼容时间序列面板数据容器
要聚类的时间序列。
可以是
Panel
scitype 的任何 mtype,例如pd-multiindex: 列为变量,索引为 pd.MultiIndex 的 pd.DataFrame,其中第一级为实例索引,第二级为时间索引
numpy3D: 形状为 [n_instances, n_dimensions, series_length] 的 3D np.array (任意维数,等长序列)
或任何其他支持的
Panel
mtype
mtype 列表,请参见
datatypes.SCITYPE_REGISTER
具体规范,请参见
examples/AA_datatypes_and_datasets.ipynb
并非所有估计器都支持具有多元或不等长序列的面板,详细信息请参见标签参考。
- 返回:
- y形状为 [n_instances, n_classes] 的 2D 数组 - 预测的类概率
第 1 维索引对应于 X 中的实例索引;第 2 维索引对应于可能的标签(整数);(i, j) 项表示第 i 个实例属于类别 j 的预测概率
- 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]#
将序列化的 self 保存到字节类对象或 (.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
。- serialization_format: str, default = “pickle”
用于序列化的模块。可用选项有“pickle”和“cloudpickle”。请注意,非默认格式可能需要安装其他软依赖项。
- 返回:
- 如果
path
为 None - 内存中的序列化 self - 如果
path
是文件位置 - 引用该文件的 ZipFile
- 如果
- score(X, y=None) float [source]#
评估聚类器的质量。
- 参数:
- Xnp.ndarray (2d 或 3d 数组,形状为 (n_instances, series_length) 或
形状为 (n_instances, n_dimensions, series_length)) 或 pd.DataFrame (其中每列是一个维度,每个单元格是一个 pd.Series (任意数量的维度,相等或不等长的序列))。用于训练聚类器,然后返回每个时间序列实例所属的索引。
- y: 被忽略,存在是为了 API 一致性。
- 返回:
- scorefloat
聚类器的分数。
- set_config(**config_dict)[source]#
将配置标志设置为给定值。
- 参数:
- config_dictdict
配置名称 : 配置值对的字典。有效的配置、值及其含义如下所示:
- displaystr, “diagram” (默认), 或 “text”
jupyter 内核如何显示 self 的实例
“diagram” = html 框图表示
“text” = 字符串打印输出
- print_changed_onlybool, default=True
打印 self 时是否只列出自参数与默认值不同的参数(False),还是列出所有参数名称和值(False)。不嵌套,即仅影响 self,不影响组件估计器。
- warningsstr, “on” (默认), 或 “off”
是否发出警告,仅影响来自 sktime 的警告
“on” = 将发出来自 sktime 的警告
“off” = 将不发出来自 sktime 的警告
- backend:parallelstr, optional, default=”None”
广播/矢量化时用于并行化的后端,以下之一:
“None”:顺序执行循环,简单的列表推导
“loky”、“multiprocessing”和“threading”:使用
joblib.Parallel
“joblib”:自定义和第三方
joblib
后端,例如spark
“dask”:使用
dask
,环境需要dask
包“ray”:使用
ray
,环境需要ray
包
- backend:parallel:paramsdict, optional, default={} (未传递参数)
作为配置传递给并行化后端的附加参数。有效键取决于
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,default=True;False 可防止
ray
在并行化后关闭。 “logger_name”:str,default=”ray”;要使用的日志记录器名称。
- “shutdown_ray”:bool,default=True;False 可防止
“mute_warnings”:bool,default=False;如果为 True,则抑制警告
将警告
- 返回:
- 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]#
为 self 设置 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, default=None
控制随机整数生成的伪随机数生成器。传入 int 以在多次函数调用中获得可重现的输出。
- deepbool, default=True
是否在 skbase 对象值参数(即组件估计器)中设置随机状态。
如果为 False,则仅设置
self
的random_state
参数(如果存在)。如果为 True,则也会在组件对象中设置
random_state
参数。
- self_policystr, “copy”, “keep”, “new” 之一, default=”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 的引用。