STDBSCAN#

STDBSCAN(eps1=0.5, eps2=10, min_samples=5, metric='euclidean', sparse_matrix_threshold=20000, frame_size=None, frame_overlap=None, n_jobs=-1)[source]#

时空 DBSCAN 聚类。

STDBSCAN 的实现,由 Birant 等人 [1] 提出。部分基于 Cakmak 等人 [3] 的实现。

根据指定的空间和时间接近度阈值对数据进行聚类。

假定所有变量都是空间坐标。

参数:
eps1浮点数, default=0.5

点被视为相关联的最大空间距离。

eps2浮点数, default=10

点被视为相关联的最大时间距离 [1]。

min_samples整数, default=5

形成核心点所需的最小样本数。

metric字符串, default=’euclidean’

要使用的距离指标;选项包括 ‘euclidean’, ‘manhattan’, ‘chebyshev’ 等。

sparse_matrix_threshold整数, default=20_000

设置算法可以通过全矩阵方法高效计算距离的样本数上限。超过此阈值的数据集将使用稀疏矩阵方法处理。

frame_size浮点数 或 None, default=None

如果不为 None,数据集将被分割成帧 [2, 3];frame_size 是帧中的时间点数量。

frame_overlap浮点数 或 None, default=eps2

如果设置了 frame_size,帧之间将存在重叠,以便之后合并聚类 [2, 3];仅在 frame_size 不为 None 时使用。

n_jobs整数 或 None, default=-1

用于距离计算的并行作业数;-1 表示使用所有核心。

属性:
labels_形状为 (n_samples,) 的 np.ndarray

每个点的聚类标签;噪声点被标记为 -1。

参考文献

[1]

Birant, D., & Kut, A. “ST-DBSCAN: An algorithm for clustering spatial-temporal data.” Data Knowl. Eng., vol. 60, no. 1, pp. 208-221, Jan. 2007, doi: [10.1016/j.datak.2006.01.013](https://doi.org/10.1016/j.datak.2006.01.013)。

[2]

Peca, I., Fuchs, G., Vrotsou, K., Andrienko, N., and Andrienko, G., “Scalable Cluster Analysis of Spatial Events” 2012, The Eurographics Association doi: [10.2312/PE/EUROVAST/EUROVA12/019-023](https://doi.org/10.2312/PE/EUROVAST/EUROVA12/019-023)。

[3]

Cakmak, E., Plank, M., Calovi, D. S., Jordan, A., & Keim, D. “Spatio-temporal clustering benchmark for collective animal behavior.” ACM, Nov. 2021, pp. 5-8. doi: [10.1145/3486637.3489487](https://doi.org/10.1145/3486637.3489487)。

示例

>>> from sktime.clustering.spatio_temporal import STDBSCAN
>>> from sktime.clustering.utils.toy_data_generation._make_moving_blobs import (
... make_moving_blobs)
>>> X, y_true = make_moving_blobs(n_times=20)
>>> st_dbscan = STDBSCAN(
...     eps1=0.5, eps2=3, min_samples=5, metric="euclidean", n_jobs=-1
... )
>>> st_dbscan.fit(X)
>>> predicted_labels = st_dbscan.labels_

方法

check_is_fitted([方法名])

检查估计器是否已拟合。

clone()

获取具有相同超参数和配置的对象的克隆。

clone_tags(估计器[, 标签名])

从另一个对象克隆标签作为动态覆盖。

create_test_instance([参数集])

使用第一个测试参数集构建类的实例。

create_test_instances_and_names([参数集])

创建所有测试实例的列表及其名称列表。

fit(X[, y])

将时间序列聚类器拟合到训练数据。

fit_predict(X[, y])

计算聚类中心并预测每个时间序列的聚类索引。

get_class_tag(标签名[, 标签默认值])

从类中获取类标签值,并继承父类的标签级别。

get_class_tags()

从类中获取类标签,并继承父类的标签级别。

get_config()

获取 self 的配置标志。

get_fitted_params([deep])

获取已拟合的参数。

get_param_defaults()

获取对象的默认参数。

get_param_names([sort])

获取对象的参数名称。

get_params([deep])

获取此对象的参数值字典。

get_tag(标签名[, 标签默认值, ...])

从实例获取标签值,具有标签级别继承和覆盖。

get_tags()

从实例获取标签,具有标签级别继承和覆盖。

get_test_params([参数集])

返回估计器的测试参数设置。

is_composite()

检查对象是否由其他 BaseObjects 组成。

load_from_path(serial)

从文件位置加载对象。

load_from_serial(serial)

从序列化内存容器加载对象。

predict(X[, y])

预测 X 中每个样本所属的最接近的聚类。

predict_proba(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)

将实例级标签覆盖设置为给定值。

classmethod get_test_params(parameter_set='default')[source]#

返回估计器的测试参数设置。

参数:
parameter_set字符串, default=”default”

要返回的测试参数集名称,用于测试。如果没有为某个值定义特殊参数,将返回“default”集。当前没有为聚类器保留的值。

返回:
params字典 或 字典列表, default = {}

用于创建类测试实例的参数。每个字典都是用于构造一个“有趣的”测试实例的参数,即 MyClass(**params)MyClass(**params[i]) 创建一个有效的测试实例。create_test_instance 使用 params 中的第一个(或唯一的)字典。

check_is_fitted(method_name=None)[source]#

检查估计器是否已拟合。

检查 _is_fitted 属性是否存在且为 Trueis_fitted 属性应在调用对象的 fit 方法时设置为 True

如果不是,则抛出 NotFittedError

参数:
method_name字符串, 可选

调用此方法的函数名称。如果提供,错误消息将包含此信息。

抛出:
NotFittedError

如果估计器尚未拟合。

clone()[source]#

获取具有相同超参数和配置的对象的克隆。

克隆是与原始对象没有共享引用、处于初始化后状态的另一个对象。此函数等同于返回 selfsklearn.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 中的所有标签。

当前的标签值可以通过 get_tagsget_tag 查看。

参数:
estimator:class:BaseObject 或其派生类的实例
tag_names字符串 或 字符串列表, default = None

要克隆的标签名称。默认值 (None) 会克隆 estimator 中的所有标签。

返回:
self

self 的引用。

classmethod create_test_instance(parameter_set='default')[source]#

使用第一个测试参数集构建类的实例。

参数:
parameter_set字符串, default=”default”

要返回的测试参数集名称,用于测试。如果没有为某个值定义特殊参数,将返回“default”集。

返回:
instance使用默认参数的类实例
classmethod create_test_instances_and_names(parameter_set='default')[source]#

创建所有测试实例的列表及其名称列表。

参数:
parameter_set字符串, default=”default”

要返回的测试参数集名称,用于测试。如果没有为某个值定义特殊参数,将返回“default”集。

返回:
objscls 实例列表

第 i 个实例是 cls(**cls.get_test_params()[i])

names字符串列表,长度与 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.DataFrame,列 = 变量,索引 = pd.MultiIndex,第一级 = 实例索引,第二级 = 时间索引

  • numpy3D: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.DataFrame,列 = 变量,索引 = pd.MultiIndex,第一级 = 实例索引,第二级 = 时间索引

  • numpy3D:3D np.array(任意维数,等长序列),形状为 [实例数, 维数, 序列长度]

  • 或任何其他支持的 Panel mtype

有关 mtype 列表,请参见 datatypes.SCITYPE_REGISTER

有关规范,请参见 examples/AA_datatypes_and_datasets.ipynb

并非所有估计器都支持包含多变量或不等长序列的面板,详情请参阅标签参考

y:被忽略,存在是为了 API 一致性。
返回:
np.ndarray(形状为 (实例数,) 的 1d 数组)

X 中每个时间序列所属聚类的索引。

classmethod get_class_tag(tag_name, tag_value_default=None)[source]#

从类中获取类标签值,并继承父类的标签级别。

每个 scikit-base 兼容对象都有一个标签字典,用于存储有关对象的元数据。

get_class_tag 方法是一个类方法,它仅考虑类级别的标签值和覆盖,检索标签的值。

它从对象中返回名为 tag_name 的标签值,按以下优先级降序考虑标签覆盖

  1. 在类的 _tags 属性中设置的标签。

  2. 在父类的 _tags 属性中设置的标签,

按继承顺序。

不考虑在实例上设置的动态标签覆盖,这些标签是通过 set_tagsclone_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 属性的键。

值是相应的标签值,覆盖按以下优先级降序排列

  1. 在类的 _tags 属性中设置的标签。

  2. 在父类的 _tags 属性中设置的标签,

按继承顺序。

实例可以根据超参数覆盖这些标签。

要检索具有潜在实例覆盖的标签,请改用 get_tags 方法。

不考虑在实例上设置的动态标签覆盖,这些标签是通过 set_tagsclone_tags 在实例上定义的。

对于包含来自动态标签的覆盖,请使用 get_tags

collected_tags字典

标签名:标签值对的字典。通过嵌套继承从 _tags 类属性收集。不会被通过 set_tagsclone_tags 设置的动态标签覆盖。

get_config()[source]#

获取 self 的配置标志。

配置是 self 的键值对,通常用作控制行为的瞬时标志。

get_config 返回动态配置,这些配置会覆盖默认配置。

默认配置在类或其父类的类属性 _config 中设置,并通过通过 set_config 设置的动态配置进行覆盖。

配置在 clonereset 调用下保留。

返回:
config_dict字典

配置名:配置值对的字典。通过嵌套继承从 _config 类属性收集,然后是来自 _onfig_dynamic 对象属性的任何覆盖和新标签。

get_fitted_params(deep=True)[source]#

获取已拟合的参数。

所需状态

需要状态为“已拟合”。

参数:
deep布尔值, default=True

是否返回组件的已拟合参数。

  • 如果为 True,将返回此对象的参数名:值字典,包括可拟合组件(= BaseEstimator 值的参数)的已拟合参数。

  • 如果为 False,将返回此对象的参数名:值字典,但不包括组件的已拟合参数。

返回:
fitted_params键为字符串的字典

已拟合参数字典,参数名:参数值键值对包括

  • 总是:此对象的所有已拟合参数,如通过 get_param_names 获取的值为此对象的该键的已拟合参数值

  • 如果 deep=True,还包含组件参数的键/值对,组件的参数索引为 [组件名]__[参数名],组件名的所有参数都以 paramname 及其值的形式出现

  • 如果 deep=True,还包含任意级别的组件递归,例如 [组件名]__[组件组件名]__[参数名] 等。

classmethod get_param_defaults()[source]#

获取对象的默认参数。

返回:
default_dict: dict[str, Any]

键是 cls 中所有在 __init__ 中定义了默认值的参数。值是在 __init__ 中定义的默认值。

classmethod get_param_names(sort=True)[source]#

获取对象的参数名称。

参数:
sort布尔值, default=True

是否按字母顺序排序返回参数名称(True),或按它们在类的 __init__ 中出现的顺序返回(False)。

返回:
param_names: list[str]

cls 的参数名称列表。如果 sort=False,则按它们在类的 __init__ 中出现的相同顺序。如果 sort=True,则按字母顺序排序。

get_params(deep=True)[source]#

获取此对象的参数值字典。

参数:
deep布尔值, default=True

是否返回组件的参数。

  • 如果为 True,将返回此对象的参数名:值字典,包括组件(= BaseObject 值的参数)的参数。

  • 如果为 False,将返回此对象的参数名:值字典,但不包括组件的参数。

返回:
params键为字符串的字典

参数字典,参数名:参数值键值对包括

  • 总是:此对象的所有参数,如通过 get_param_names 获取的值为此对象的该键的参数值,其值始终与构造时传入的值相同

  • 如果 deep=True,还包含组件参数的键/值对,组件的参数索引为 [组件名]__[参数名],组件名的所有参数都以 paramname 及其值的形式出现

  • 如果 deep=True,还包含任意级别的组件递归,例如 [组件名]__[组件组件名]__[参数名] 等。

get_tag(tag_name, tag_value_default=None, raise_error=True)[source]#

从实例获取标签值,具有标签级别继承和覆盖。

每个 scikit-base 兼容对象都有一个标签字典。标签可用于存储有关对象的元数据,或控制对象的行为。

标签是特定于实例 self 的键值对,它们是静态标志,在对象构建后不会改变。

get_tag 方法从实例中检索名为 tag_name 的单个标签值,按以下优先级降序考虑标签覆盖

  1. 在实例上通过 set_tagsclone_tags 设置的标签,

在实例构造时设置的标签。

  1. 在类的 _tags 属性中设置的标签。

  2. 在父类的 _tags 属性中设置的标签,

按继承顺序。

参数:
tag_name字符串

要检索的标签名称

tag_value_default任意类型,可选;default=None

如果找不到标签,则使用的默认/回退值

raise_error布尔值

当找不到标签时是否抛出 ValueError

返回:
tag_value任意类型

self 中 tag_name 标签的值。如果找不到,并且 raise_error 为 True,则抛出错误,否则返回 tag_value_default

抛出:
ValueError,如果 raise_errorTrue

如果 tag_name 不在 self.get_tags().keys() 中,则抛出 ValueError

get_tags()[source]#

从实例获取标签,具有标签级别继承和覆盖。

每个 scikit-base 兼容对象都有一个标签字典。标签可用于存储有关对象的元数据,或控制对象的行为。

标签是特定于实例 self 的键值对,它们是静态标志,在对象构建后不会改变。

get_tags 方法返回一个标签字典,其键是类或其任何父类中设置的任何 _tags 属性的键,或通过 set_tagsclone_tags 设置的标签的键。

值是相应的标签值,覆盖按以下优先级降序排列

  1. 在实例上通过 set_tagsclone_tags 设置的标签,

在实例构造时设置的标签。

  1. 在类的 _tags 属性中设置的标签。

  2. 在父类的 _tags 属性中设置的标签,

按继承顺序。

返回:
collected_tags字典

标签名:标签值对的字典。通过嵌套继承从 _tags 类属性收集,然后是来自 _tags_dynamic 对象属性的任何覆盖和新标签。

is_composite()[source]#

检查对象是否由其他 BaseObjects 组成。

复合对象是包含其他对象作为参数的对象。在实例上调用,因为不同实例可能有所不同。

返回:
composite布尔值

对象是否具有值是 BaseObject 后代实例的任何参数。

property is_fitted[source]#

是否已调用 fit 方法。

检查对象在构造期间应初始化为 False` 并在调用对象的 fit 方法时设置为 True_is_fitted 属性。

返回:
布尔值

估计器是否已 fit

classmethod load_from_path(serial)[source]#

从文件位置加载对象。

参数:
serialZipFile(path).open(“object) 的结果
返回:
cls.save(path) 在 path 生成的输出的反序列化 self
classmethod load_from_serial(serial)[source]#

从序列化内存容器加载对象。

参数:
serialcls.save(None) 输出的第一个元素
返回:
cls.save(None) 生成输出 serial 的反序列化 self
predict(X, y=None) ndarray[source]#

预测 X 中每个样本所属的最接近的聚类。

参数:
XPanel scitype 的 sktime 兼容时间序列面板数据容器

要聚类的时间序列。

可以是 Panel scitype 的任何 mtype,例如

  • pd-multiindex:pd.DataFrame,列 = 变量,索引 = pd.MultiIndex,第一级 = 实例索引,第二级 = 时间索引

  • numpy3D:3D np.array(任意维数,等长序列),形状为 [实例数, 维数, 序列长度]

  • 或任何其他支持的 Panel mtype

有关 mtype 列表,请参见 datatypes.SCITYPE_REGISTER

有关规范,请参见 examples/AA_datatypes_and_datasets.ipynb

并非所有估计器都支持包含多变量或不等长序列的面板,详情请参阅标签参考

y:被忽略,存在是为了 API 一致性。
返回:
np.ndarray(形状为 (实例数,) 的 1d 数组)

X 中每个时间序列所属聚类的索引。

predict_proba(X)[source]#

预测 X 中序列的标签概率。

默认行为是调用 _predict 并将预测的类别概率设置为 1,其他类别概率设置为 0。如果能获得更好的估计,请覆盖此方法。

参数:
XPanel scitype 的 sktime 兼容时间序列面板数据容器

要聚类的时间序列。

可以是 Panel scitype 的任何 mtype,例如

  • pd-multiindex:pd.DataFrame,列 = 变量,索引 = pd.MultiIndex,第一级 = 实例索引,第二级 = 时间索引

  • numpy3D:3D np.array(任意维数,等长序列),形状为 [实例数, 维数, 序列长度]

  • 或任何其他支持的 Panel mtype

有关 mtype 列表,请参见 datatypes.SCITYPE_REGISTER

有关规范,请参见 examples/AA_datatypes_and_datasets.ipynb

并非所有估计器都支持包含多变量或不等长序列的面板,详情请参阅标签参考

返回:
y形状为 [实例数, 类别数] 的 2D 数组 - 预测的类别概率

第一维索引对应于 X 中的实例索引,第二维索引对应于可能的标签(整数),(i, j) 处的条目是第 i 个实例属于类别 j 的预测概率。

reset()[source]#

将对象重置为干净的初始化后状态。

将 self 设置为其在构造函数调用后直接拥有的状态,具有相同的超参数。通过 set_config 设置的配置值也会保留。

reset 调用会删除所有对象属性,除了

  • 超参数 = 写入 self 的 __init__ 的参数,例如 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 或文件位置(字符串或 Path)

如果为 None,self 将保存到内存对象;如果为文件位置,self 将保存到该文件位置。如果

  • path=”estimator” 则会在当前工作目录 (cwd) 创建一个 zip 文件 estimator.zip。

  • path=”/home/stored/estimator”,则会在 /home/stored/ 目录创建一个 zip 文件 estimator.zip

存储在 /home/stored/ 中。

serialization_format字符串, default = “pickle”

用于序列化的模块。可用选项是“pickle”和“cloudpickle”。请注意,非默认格式可能需要安装其他软依赖项。

返回:
如果 path 为 None - 内存中的序列化 self
如果 path 为文件位置 - 引用该文件的 ZipFile 对象
score(X, y=None) float[source]#

评估聚类器的质量。

参数:
Xnp.ndarray(形状为 (实例数, 序列长度) 或形状为

(实例数, 维数, 序列长度) 的 2d 或 3d 数组)或 pd.DataFrame(其中每列是一个维度,每个单元格是一个 pd.Series(任意维数,等长或不等长序列))。用于训练聚类器的时间序列实例,然后返回每个实例所属的索引。

y:被忽略,存在是为了 API 一致性。
返回:
score浮点数

聚类器的得分。

set_config(**config_dict)[source]#

将配置标志设置为给定值。

参数:
config_dict字典

配置名:配置值对的字典。有效的配置、值及其含义如下所示

display字符串,“diagram”(默认)或“text”

jupyter kernel 如何显示 self 的实例

  • “diagram” = html 框图表示

  • “text” = 字符串输出

print_changed_only布尔值, default=True

打印 self 时是仅列出与默认值不同的 self 参数 (True),还是列出所有参数名称和值 (False)。不进行嵌套,即仅影响 self 而不影响组件估计器。

warnings字符串,“on”(默认)或“off”

是否触发警告,仅影响来自 sktime 的警告

  • “on” = 将触发来自 sktime 的警告

  • “off” = 不会触发来自 sktime 的警告

backend:parallel字符串,可选,default=”None”

广播/向量化时用于并行的后端,选项包括

  • “None”:按顺序执行循环,简单的列表推导

  • “loky”, “multiprocessing” 和 “threading”:使用 joblib.Parallel

  • “joblib”:自定义和第三方 joblib 后端,例如 spark

  • “dask”:使用 dask,需要在环境中安装 dask

  • “ray”:使用 ray,需要在环境中安装 ray

backend:parallel:params字典,可选,default={}(不传递参数)

作为配置传递给并行化后端的额外参数。有效键取决于 backend:parallel 的值

  • “None”:没有额外参数,backend_params 被忽略

  • “loky”, “multiprocessing” 和 “threading”: 默认的 joblib 后端。joblib.Parallel 的任何有效参数都可以在此处传递,例如 n_jobs,例外是 backend,它由外部的 backend 参数直接控制。如果未传递 n_jobs,它将默认为 -1,其他参数将默认为 joblib 的默认值。

  • “joblib”: 定制和第三方 joblib 后端,例如 sparkjoblib.Parallel 的任何有效参数都可以在此处传递,例如 n_jobs。在此情况下,必须将 backend 作为 backend_params 的一个键传递。如果未传递 n_jobs,它将默认为 -1,其他参数将默认为 joblib 的默认值。

  • “dask”: dask.compute 的任何有效参数都可以传递,例如 scheduler

  • “ray”: 可以传递以下参数

    • “ray_remote_args”: ray.init 的有效参数字典

    • “shutdown_ray”: 布尔值,默认为 True;False 会阻止 ray 在并行化后

      关闭。

    • “logger_name”: 字符串,默认为“ray”;要使用的日志记录器名称。

    • “mute_warnings”: 布尔值,默认为 False;如果为 True,则抑制警告

返回:
自身对自身的引用。

注意事项

改变对象状态,将 config_dict 中的配置复制到 self._config_dynamic

set_params(**params)[source]#

设置此对象的参数。

此方法适用于简单的 skbase 对象以及复合对象。参数键字符串 <component>__<parameter> 可用于复合对象(即包含其他对象的对象),以访问组件 <component> 中的参数 <parameter>。如果这种引用方式是明确的(例如,没有两个组件的参数名称相同),则也可以使用参数字符串 <parameter>,而不带 <component>__ 前缀。

参数:
参数dict

BaseObject 参数,键必须是 <component>__<parameter> 格式的字符串。如果在 get_params 键中是唯一的,则 __ 后缀可以作为完整字符串的别名。

返回:
自身对自身的引用(设置参数后)
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 参数的对象。

参数:
随机状态int, RandomState 实例或 None, 默认为 None

用于控制随机整数生成的伪随机数生成器。传递整数可在多次函数调用中获得可重现的输出。

deep布尔值, default=True

是否在 skbase 对象值的参数(即组件估计器)中设置随机状态。

  • 如果为 False,则仅设置 selfrandom_state 参数(如果存在)。

  • 如果为 True,则也会在组件对象中设置 random_state 参数。

自身策略字符串,可选值为 {“copy”, “keep”, “new”} 之一,默认为“copy”
  • “copy”:将 self.random_state 设置为输入的 random_state

  • “keep”:保持 self.random_state 不变

  • “new”:将 self.random_state 设置为一个新的随机状态,

该状态从输入的 random_state 派生,通常与输入状态不同

返回:
自身对自身的引用
set_tags(**tag_dict)[source]#

将实例级标签覆盖设置为给定值。

每个 scikit-base 兼容对象都有一个标签字典,用于存储有关对象的元数据。

标签是特定于实例 self 的键值对,它们是对象构建后不会改变的静态标志。它们可用于元数据检查或控制对象的行为。

set_tags 将动态标签覆盖设置为 tag_dict 中指定的值,其中键是标签名称,字典值是要设置的标签值。

set_tags 方法只能在对象的 __init__ 方法中,即在对象构建期间,或通过 __init__ 构建完成后直接调用。

当前的标签值可以通过 get_tagsget_tag 查看。

参数:
标签字典dict

标签名称:标签值 对的字典。

返回:
自身

对自身的引用。