TimeSeriesKvisibility#

class TimeSeriesKvisibility(n_clusters=5, init='k-means++', n_init=4)[源]#

用于时间序列聚类的 Kvisibility。

kvisibility 是一种基于可见性图的时间序列聚类技术。该算法基于将时间序列转换为图,并利用所创建图的度量来创建 Kmeans 聚类。

基于论文 [1]

参数:
init{'k-means++','random'}、可调用对象或

形状为 (n_clusters, n_features) 的类数组对象,默认为 'k-means++' 初始化方法:'k-means++':根据点的贡献对总体惯性的经验概率分布进行采样,选择初始聚类中心。该技术加快了收敛速度。实现的算法是“贪心 k-means++”。它与普通的 k-means++ 的不同之处在于,在每个采样步骤中进行多次尝试,并从中选择最佳中心。'random':从数据中随机选择 n_clusters 个观测值(行)作为初始中心。如果传入一个数组,其形状应为 (n_clusters, n_features),并给出初始中心。如果传入一个可调用对象,它应该接受参数 X、n_clusters 和一个随机状态,并返回一个初始化结果。

n_init'auto' 或 int,默认为 'auto'

k-means 算法使用不同中心种子运行的次数。最终结果是 n_init 次连续运行中在惯性方面的最佳输出。对于稀疏高维问题,建议进行多次运行。当 n_init='auto' 时,运行次数取决于 init 的值:如果使用 init='random' 或 init 是可调用对象,则为 10 次;如果使用 init='k-means++' 或 init 是类数组对象,则为 1 次。

n_clustersint,默认为 5

要形成的聚类数量以及要生成的中心数量。

属性:
core_sample_indices_形状为 (n_core_samples,) 的 ndarray

核心样本的索引。

components_形状为 (n_core_samples, n_features) 的 ndarray

训练找到的每个核心样本的副本。

labels_形状为 (n_samples) 的 ndarray

fit() 中给定数据集中每个点的聚类标签。噪声样本被赋予标签 -1。

参考

方法

check_is_fitted([方法名])

检查估计器是否已拟合。

clone()

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

clone_tags(估计器[, 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])

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

is_composite()

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

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)

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

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

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

参数:
parameter_setstr,默认为 “default”

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

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

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

check_is_fitted(method_name=None)[源]#

检查估计器是否已拟合。

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

如果不是,则引发 NotFittedError

参数:
method_namestr,可选

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

引发:
NotFittedError

如果估计器尚未拟合。

clone()[源]#

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

克隆是一个不同的对象,没有共享引用,处于初始化后状态。此函数等同于返回自身的 sklearn.clone

等同于使用自身的参数构造 type(self) 的新实例,即 type(self)(**self.get_params(deep=False))

如果在自身上设置了配置,克隆也将具有与原始对象相同的配置,等同于调用 cloned_self.set_config(**self.get_config())

其值也等同于调用 self.reset,不同之处在于 clone 返回一个新对象,而不是像 reset 那样改变自身。

引发:
如果由于 __init__ 错误导致克隆不符合要求,则引发 RuntimeError。
clone_tags(estimator, tag_names=None)[源]#

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

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

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

clone_tags 从另一个对象(estimator)设置动态标签覆盖。

clone_tags 方法只能在对象的 __init__ 方法中、构造期间或通过 __init__ 直接构造后调用。

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

tag_names 的默认设置是将 estimator 中的所有标签写入自身。

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

参数:
estimator:class:BaseObject 或派生类的实例
tag_namesstr 或 str 列表,默认为 None

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

返回:
self

对自身的引用。

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

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

参数:
parameter_setstr,默认为 “default”

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

返回:
instance具有默认参数的类实例
classmethod create_test_instances_and_names(parameter_set='default')[源]#

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

参数:
parameter_setstr,默认为 “default”

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

返回:
objscls 实例列表

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

namesstr 列表,与 objs 长度相同

第 i 个元素是测试中第 i 个 obj 实例的名称。如果实例多于一个,命名约定为 {cls.__name__}-{i},否则为 {cls.__name__}

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

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

状态改变

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

写入自身

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

参数:
Xsktime 兼容的时间序列面板数据容器,Panel scitype

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

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

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

  • 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对自身的引用。
fit_predict(X, y=None) ndarray[源]#

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

便捷方法;等同于调用 fit(X) 后再调用 predict(X)

参数:
Xsktime 兼容的时间序列面板数据容器,Panel scitype

要聚类的时间序列。

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

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

  • 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,) 的 1d 数组)

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

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

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

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

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

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

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

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

按继承顺序排列。

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

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

参数:
tag_namestr

标签值的名称。

tag_value_default任意类型

如果未找到标签,则为默认/回退值。

返回:
tag_value

自身中 tag_name 标签的值。如果未找到,则返回 tag_value_default

classmethod get_class_tags()[源]#

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

每个 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()[源]#

获取自身的配置标志。

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

get_config 返回动态配置,它们会覆盖默认配置。

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

配置在 clonereset 调用下保留。

返回:
config_dictdict

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

get_fitted_params(deep=True)[源]#

获取已拟合参数。

所需状态

要求状态为“已拟合”。

参数:
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()[源]#

获取对象的参数默认值。

返回:
default_dict: dict[str, Any]

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

classmethod get_param_names(sort=True)[源]#

获取对象的参数名称。

参数:
sortbool,默认为 True

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

返回:
param_names: list[str]

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

get_params(deep=True)[源]#

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

参数:
deepbool,默认为 True

是否返回组件的参数。

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

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

返回:
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)[源]#

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

每个 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

自身中 tag_name 标签的值。如果未找到,如果 raise_error 为 True 则引发错误,否则返回 tag_value_default

引发:
ValueError,如果 raise_errorTrue

如果 tag_name 不在 self.get_tags().keys() 中,则引发 ValueError

get_tags()[源]#

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

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

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

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

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

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

在实例构造时。

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

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

按继承顺序排列。

返回:
collected_tagsdict

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

is_composite()[源]#

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

组合对象是包含其他对象作为参数的对象。在实例上调用,因为这可能因实例而异。

返回:
composite: bool

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

property is_fitted[源]#

fit 是否已被调用。

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

返回:
bool

估计器是否已拟合。

classmethod load_from_path(serial)[源]#

从文件位置加载对象。

参数:
serialZipFile(path).open(“object) 的结果
返回:
反序列化的自身,结果输出到 path,来自 cls.save(path)
classmethod load_from_serial(serial)[源]#

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

参数:
serialcls.save(None) 输出的第一个元素
返回:
反序列化的自身,结果输出为 serial,来自 cls.save(None)
predict(X, y=None) ndarray[源]#

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

参数:
Xsktime 兼容的时间序列面板数据容器,Panel scitype

要聚类的时间序列。

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

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

  • 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,) 的 1d 数组)

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

predict_proba(X)[源]#

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

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

参数:
Xsktime 兼容的时间序列面板数据容器,Panel scitype

要聚类的时间序列。

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

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

  • 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 数组 - 预测的类别概率

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

reset()[源]#

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

结果是将自身设置为构造函数调用后的状态,具有相同的超参数。通过 set_config 设置的配置值也会保留。

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

  • 超参数 = 写入自身的 __init__ 参数,例如 self.paramname,其中 paramname__init__ 的一个参数

  • 包含双下划线的对象属性,即字符串“__”。例如,名为“__myattr”的属性会保留。

  • 配置属性,配置会保留不变。也就是说,reset 前后 get_config 的结果是相同的。

类和对象方法以及类属性也不受影响。

等同于 clone,不同之处在于 reset 修改自身而不是返回一个新对象。

调用 self.reset() 后,自身的值和状态与构造函数调用``type(self)(**self.get_params(deep=False))`` 后获得的对象相同。

返回:
self

将类的实例重置到干净的初始化后状态,但保留当前的超参数值。

save(path=None, serialization_format='pickle')[源]#

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

行为:如果 path 为 None,则返回一个内存中的序列化自身;如果 path 是文件位置,则将自身存储在该位置为 zip 文件

保存的文件是 zip 文件,包含以下内容: _metadata - 包含自身的类,即 type(self) _obj - 序列化的自身。此类使用默认序列化 (pickle)。

参数:
pathNone 或文件位置 (str 或 Path)

如果为 None,自身保存为内存对象;如果是文件位置,自身保存到该文件位置。如果

  • path=”estimator”,则会在当前工作目录创建 zip 文件 estimator.zip

  • path=”/home/stored/estimator”,则会在 /home/stored/

存储 zip 文件 estimator.zip

序列化格式: str, 默认 = “pickle”

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

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

评估聚类器的质量。

参数:
Xnp.ndarray (形状为 (n_instances, series_length) 的 2d 或 3d 数组,或形状为

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

y: 被忽略,存在是为了 API 一致性。
返回:
scorefloat

聚类器的得分。

set_config(**config_dict)[source]#

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

参数:
config_dictdict

配置名称 : 配置值 对的字典。有效的配置、值及其含义列于下方

displaystr, “diagram”(默认)或 “text”

jupyter kernel 如何显示 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 在并行化后

      关闭。

    • “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>。如果参数名称在 `get_params` 返回的所有键中是唯一的,则可以直接使用参数名称(即 <parameter> 部分)作为别名。

参数:
**paramsdict

BaseObject 参数,键必须是 <component>__<parameter> 形式的字符串。如果参数名称在 `get_params` 键中唯一,则可以直接使用参数名称(即 <parameter>)作为别名。

返回:
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 可在多次函数调用中获得可复现的输出。

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对 self 的引用
set_tags(**tag_dict)[source]#

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

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

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

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

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

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

参数:
**tag_dictdict

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

返回:
Self

对 self 的引用。