BaseClusterer#

class BaseClusterer(n_clusters: int = None)[source]#

时间序列聚类器的抽象基类。

参数:
n_clusters: int, 默认为 None

模型的聚类数量。

属性:
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])

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

fit_predict(X[, y])

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

get_class_tag(tag_name[, tag_value_default])

从类中获取类标签值,具有来自父类的标签级别继承。

get_class_tags()

从类中获取类标签,具有来自父类的标签级别继承。

get_config()

获取对象的配置标志。

get_fitted_params([deep])

获取已拟合参数。

get_param_defaults()

获取对象的参数默认值。

get_param_names([sort])

获取对象的参数名称。

get_params([deep])

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

get_tag(tag_name[, tag_value_default, ...])

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

get_tags()

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

get_test_params([parameter_set])

返回 skbase 对象的测试参数设置。

is_composite()

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

load_from_path(serial)

从文件位置加载对象。

load_from_serial(serial)

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

predict(X[, y])

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

predict_proba(X)

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

reset()

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

save([path, serialization_format])

将序列化的对象保存到类字节对象或 (.zip) 文件。

score(X[, y])

评估聚类器的质量。

set_config(**config_dict)

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

set_params(**params)

设置此对象的参数。

set_random_state([random_state, deep, ...])

为对象设置 random_state 伪随机种子参数。

set_tags(**tag_dict)

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

fit(X, y=None)[source]#

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

状态更改

将状态更改为“已拟合”。

写入对象自身

将 self.is_fitted 设置为 True。设置以“_”结尾的已拟合模型属性。

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

用于拟合估计器的时间序列。

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

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

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

  • 或任何其他支持的 Panel mtype

mtype 列表请参见 datatypes.SCITYPE_REGISTER

具体规范请参见 examples/AA_datatypes_and_datasets.ipynb

并非所有估计器都支持多元或不等长序列的面板数据,详细信息请参见标签参考

y忽略,仅为保持 API 一致性。
返回:
self对象自身的引用。
predict(X, y=None) ndarray[source]#

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

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

要聚类的时间序列。

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

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

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

  • 或任何其他支持的 Panel mtype

mtype 列表请参见 datatypes.SCITYPE_REGISTER

具体规范请参见 examples/AA_datatypes_and_datasets.ipynb

并非所有估计器都支持多元或不等长序列的面板数据,详细信息请参见标签参考

y: 忽略,仅为保持 API 一致性。
返回:
np.ndarray (形状为 (n_instances,) 的 1d 数组)

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

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 (任意维度数量,等长序列),形状为 [n_instances, n_dimensions, series_length]

  • 或任何其他支持的 Panel mtype

mtype 列表请参见 datatypes.SCITYPE_REGISTER

具体规范请参见 examples/AA_datatypes_and_datasets.ipynb

并非所有估计器都支持多元或不等长序列的面板数据,详细信息请参见标签参考

y: 忽略,仅为保持 API 一致性。
返回:
np.ndarray (形状为 (n_instances,) 的 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 (任意维度数量,等长序列),形状为 [n_instances, n_dimensions, series_length]

  • 或任何其他支持的 Panel mtype

mtype 列表请参见 datatypes.SCITYPE_REGISTER

具体规范请参见 examples/AA_datatypes_and_datasets.ipynb

并非所有估计器都支持多元或不等长序列的面板数据,详细信息请参见标签参考

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

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

score(X, y=None) float[source]#

评估聚类器的质量。

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

(n_instances, n_dimensions, series_length)) or pd.DataFrame (where each column is a dimension, each cell is a pd.Series (any number of dimensions, equal or unequal length series)). Time series instances to train clusterer and then have indexes each belong to return.

y: 忽略,仅为保持 API 一致性。
返回:
scorefloat 类型

聚类器的得分。

check_is_fitted(method_name=None)[source]#

检查估计器是否已拟合。

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

如果不是,则抛出 NotFittedError

参数:
method_namestr 类型,可选

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

抛出异常:
未拟合错误

如果估计器尚未拟合。

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 设置动态标签覆盖。

应仅在对象的 __init__ 方法中(构造期间)或通过 __init__ 直接构造后调用 clone_tags 方法。

动态标签被设置为 estimator 中标签的值,其名称在 tag_names 中指定。

tag_names 的默认值将 estimator 中的所有标签写入 self

当前标签值可以通过 get_tagsget_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 个元素是测试中第 i 个 obj 实例的名称。命名约定是如果实例多于一个,则为 {cls.__name__}-{i},否则为 {cls.__name__}

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_namestr 类型

标签值的名称。

tag_value_default任意类型,可选

如果未找到标签,则为默认/备用值。

返回:
tag_value

selftag_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_tagsdict 类型

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

get_config()[source]#

获取对象的配置标志。

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

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

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

配置在 clonereset 调用下保留。

返回:
config_dictdict 类型

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

get_fitted_params(deep=True)[source]#

获取已拟合参数。

所需状态

需要状态为“已拟合”。

参数:
deepbool 类型,默认为 True

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

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

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

返回:
fitted_params键为 str 类型的 dict

已拟合参数字典,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 类型,默认为 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 类型的 dict

参数字典,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 的单个标签的值,考虑标签覆盖,优先级从高到低依次为

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

在实例构造时。

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

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

按照继承顺序。

参数:
tag_namestr 类型

要检索的标签名称

tag_value_default任意类型,可选;默认为 None

如果未找到标签,则为默认/备用值

raise_errorbool 类型

未找到标签时是否抛出 ValueError

返回:
tag_valueAny 类型

selftag_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_tagsdict 类型

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

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

返回 skbase 对象的测试参数设置。

get_test_params 是一个统一的接口点,用于存储测试目的的参数设置。此函数也用于 create_test_instancecreate_test_instances_and_names 来构造测试实例。

get_test_params 应返回一个单独的 dict,或一个 dictlist

每个 dict 都是一个用于测试的参数配置,可用于构造一个“有趣”的测试实例。调用 cls(**params)get_test_params 返回的所有 params 字典都应该是有效的。

get_test_params 不需要返回固定的字典列表,它也可以返回动态或随机参数设置。

参数:
parameter_setstr 类型,默认为“default”

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

返回:
paramsdict 或 dict 列表,默认为 {}

用于创建类测试实例的参数。每个 dict 都是构造一个“有趣”测试实例的参数,即 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,结果输出到 path,即 cls.save(path) 的输出
classmethod load_from_serial(serial)[source]#

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

参数:
serialcls.save(None) 输出的第一个元素
返回:
反序列化的 self,结果输出 serial,即 cls.save(None) 的输出
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]#

将序列化的对象保存到类字节对象或 (.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 kernels 如何显示实例

  • “diagram” = html 方框图表示

  • “text” = 字符串打印输出

print_changed_onlybool,默认值为 True

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

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 在并行化后

      关闭。

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

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

返回:
self对自身的引用。

备注

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

set_params(**params)[source]#

设置此对象的参数。

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

参数:
**paramsdict

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

返回:
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,将仅设置 selfrandom_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对自身的引用
set_tags(**tag_dict)[source]#

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

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

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

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

set_tags 方法应仅在对象的 __init__ 方法中、构建期间或通过 __init__ 直接调用后调用。

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

参数:
**tag_dictdict

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

返回:
自身

对自身的引用。