CNNRegressor#

CNNRegressor(n_epochs=2000, batch_size=16, kernel_size=7, avg_pool_size=3, n_conv_layers=2, callbacks=None, verbose=False, loss='mean_squared_error', metrics=None, random_state=0, activation='linear', use_bias=True, optimizer=None, filter_sizes=None, padding='auto')[source]#

时间序列卷积神经网络 (CNN),如 [1] 中所述。

改编自 Fawaz 等人的实现 hfawaz/dl-4-tsc

参数:
n_epochsint, 默认 = 2000

模型训练的 epoch 数

batch_sizeint, 默认 = 16

每次梯度更新的样本数。

kernel_sizeint, 默认 = 7

1D 卷积窗口的长度

avg_pool_sizeint, 默认 = 3

平均池化窗口的大小

n_conv_layersint, 默认 = 2

卷积层加上平均池化层的数量

callbackslist of keras.callbacks, 默认 = None
verboseboolean, 默认 = False

是否输出额外信息

lossstring, 默认=”mean_squared_error”

keras 模型的 fit 参数

metricslist of strings, 默认=[“accuracy”],
random_stateint or None, 默认=None

随机数生成的种子。

activationstring or a tf callable, 默认=”softmax”

输出线性层中使用的激活函数。可用激活函数的列表: https://keras.org.cn/api/layers/activations/

use_biasboolean, 默认 = True

层是否使用偏置向量。

optimizerkeras.optimizers object, 默认 = Adam(lr=0.01)

指定要使用的优化器和学习率。

filter_sizesarray of shape (n_conv_layers) default = [6, 12]
paddingstring, 默认 = “auto”

控制卷积层的填充逻辑,即是否将 'valid''same' 传递给 Conv1D 层。

- “auto”: 根据原始实现,如果输入层的 input_shape[0] < 60,则传递 "same",否则传递 "valid"

  • “valid”、“same” 和其他值直接传递给 Conv1D

属性:
is_fitted

是否已拟合 (fit 是否已被调用)。

注意事项

改编自 Fawaz 等人的实现 hfawaz/dl-4-tsc

参考文献

[1]

Zhao et. al, Convolutional neural networks for

time series classification, Journal of Systems Engineering and Electronics, 28(1):2017.

示例

>>> from sktime.datasets import load_unit_test
>>> from sktime.regression.deep_learning.cnn import CNNRegressor
>>> X_train, y_train = load_unit_test(return_X_y=True, split="train")
>>> X_test, y_test = load_unit_test(return_X_y=True, split="test")
>>> regressor = CNNRegressor() 
>>> regressor.fit(X_train, y_train) 
CNNRegressor(...)
>>> y_pred = regressor.predict(X_test) 

方法

build_model(input_shape, **kwargs)

构建一个已编译、未训练的 keras 模型,可用于训练。

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)

将时间序列回归器拟合到训练数据。

get_class_tag(tag_name[, tag_value_default])

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

get_class_tags()

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

get_config()

获取 self 的配置标志。

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)

预测 X 中序列的标签。

reset()

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

save([path])

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

score(X, y[, multioutput])

比较 X 上的预测标签与真实标签。

set_config(**config_dict)

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

set_params(**params)

设置此对象的参数。

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

设置 self 的 random_state 伪随机种子参数。

set_tags(**tag_dict)

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

build_model(input_shape, **kwargs)[source]#

构建一个已编译、未训练的 keras 模型,可用于训练。

在 sktime 中,时间序列存储在形状为 (d,m) 的 numpy 数组中,其中 d 是维度数,m 是序列长度。Keras/tensorflow 假定数据形状为 (m,d)。此方法也假定形状为 (m,d)。转置应在 fit 中进行。

参数:
input_shapetuple

输入层的数据形状,应为 (m,d)

返回:
output一个已编译的 Keras 模型
classmethod get_test_params(parameter_set='default')[source]#

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

参数:
parameter_setstr, 默认=”default”

要返回的测试参数集的名称,用于测试中。如果未为值定义特殊参数,将返回 "default" 集。对于分类器,应提供一组“default”参数用于一般测试,如果一般集未产生适合比较的概率,则提供一组“results_comparison”参数用于比较之前记录的结果。

返回:
paramsdict or list of dict, 默认={}

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

check_is_fitted(method_name=None)[source]#

检查估计器是否已拟合。

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

如果不存在,则引发 NotFittedError

参数:
method_namestr, 可选

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

引发:
NotFittedError

如果估计器尚未拟合。

clone()[source]#

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

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

等同于构造一个 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_tagsget_tag 进行检查。

参数:
estimator:class:BaseObject 或派生类的实例
tag_namesstr or 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])

namesstr 列表,与 objs 长度相同

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

fit(X, y)[source]#

将时间序列回归器拟合到训练数据。

状态变更

将状态变更为“fitted”。

写入 self

将 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

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

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

并非所有估计器都支持多元或不等长序列的面板,详情请参见 tag reference

ysktime 兼容的表格数据容器,Table scitype

1D 可迭代对象,形状为 [n_instances] 或 2D 可迭代对象,形状为 [n_instances, n_dimensions]。用于拟合的类标签 0 级索引对应于 X 中的实例索引 1 级索引(如果适用)对应于 X 中的多输出向量索引 支持的 sktime 类型:np.ndarray (1D, 2D), pd.Series, pd.DataFrame

返回:
self对 self 的引用。

注意事项

通过创建一个已拟合的模型来改变状态,该模型更新以“_”结尾的属性并将 is_fitted 标志设置为 True。

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

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

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

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

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

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

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

按继承顺序。

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

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

参数:
tag_namestr

标签值的名称。

tag_value_defaultany type

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

返回:
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 的配置标志。

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

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

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

配置在 clonereset 调用后保留。

返回:
config_dictdict

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

get_fitted_params(deep=True)[source]#

获取已拟合的参数。

所需状态

需要状态为“fitted”。

参数:
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 对象属性的任何覆盖和新标签进行收集。

is_composite()[source]#

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

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

返回:
composite: bool

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

property is_fitted[source]#

是否已拟合 (fit 是否已被调用)。

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

返回:
bool

估计器是否已 fit

classmethod load_from_path(serial)[source]#

从文件位置加载对象。

参数:
serialZip 文件的名称。
返回:
产生的反序列化 self,输出位于 path,由 cls.save(path) 生成。
classmethod load_from_serial(serial)[source]#

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

参数:
serial: ``cls.save(None)`` 输出的第 1 个元素。

这是一个大小为 3 的元组。第一个元素代表 pickle 序列化的实例。第二个元素代表 h5py 序列化的 keras 模型。第三个元素代表 pickle 序列化的 .fit() 历史记录。

返回:
产生的反序列化 self,输出为 serial,由 cls.save(None) 生成。
predict(X) ndarray[source]#

预测 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

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

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

并非所有估计器都支持多元或不等长序列的面板,详情请参见 tag reference

返回:
y_predsktime 兼容的表格数据容器,Table scitype

预测的回归标签

1D 可迭代对象,形状为 [n_instances],或 2D 可迭代对象,形状为 [n_instances, n_dimensions]。

0 级索引对应于 X 中的实例索引,1 级索引(如果适用)对应于 X 中的多输出向量索引。

如果 y 是单变量(一维),则为 1D np.npdarray;否则,与 fit 中传递的 y 类型相同。

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)[source]#

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

行为:如果 path 为 None,则返回内存中的序列化 self 如果 path 是文件,则在指定位置存储 zip 文件。zip 文件的内容包括: _metadata - 包含 self 的类,即 type(self)。_obj - 序列化的 self。此类使用默认序列化 (pickle)。keras/ - 模型、优化器和状态存储在此目录中。history - 序列化的 history 对象。

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

如果为 None,self 保存到内存中的对象 如果是文件位置,self 保存到该文件位置。例如:

path=”estimator” 则在当前工作目录创建 zip 文件 estimator.zip。path=”/home/stored/estimator” 则在 /home/stored/ 中存储 zip 文件 estimator.zip

返回:
如果 path 为 None - 内存中的序列化 self
如果 path 是文件位置 - 指向文件的 ZipFile
score(X, y, multioutput='uniform_average') float[source]#

比较 X 上的预测标签与真实标签。

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

pd-multiindex: pd.DataFrame,列为变量,索引为 pd.MultiIndex,第一级为实例索引,第二级为时间索引 numpy3D: 形状为 [n_instances, n_dimensions, series_length] 的 3D np.array(任意维度数,等长序列)或任何其他受支持的 Panel mtype 有关 mtypes 列表,请参见 datatypes.SCITYPE_REGISTER 有关规范,请参见 examples/AA_datatypes_and_datasets.ipynb

y形状为 [n_instances, n_dimensions] 的 2D np.array of int - 回归标签

用于拟合的索引对应于 X 中的实例索引,或形状为 [n_instances] 的 1D np.array of int - 用于拟合的回归标签 索引对应于 X 中的实例索引。

multioutputstr, 可选 (默认=”uniform_average”)

{“raw_values”, “uniform_average”, “variance_weighted”},形状为 (n_outputs,) 的 array-like 或 None,默认=”uniform_average”。定义聚合多个输出分数的方式。Array-like 值定义用于平均分数的权重。

返回:
float (默认) 或 1D np.array of float

predict(X) 与 y 之间的 R-squared 分数 如果 multioutput=”uniform_average” 或 “variance_weighted”,或 y 是单变量,则为 float;如果 multioutput=”raw_values” 且 y 是多元变量,则为 1D np.array。

set_config(**config_dict)[source]#

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

参数:
config_dictdict

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

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

jupyter 内核如何显示自身的实例

  • “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>。如果这种引用是明确的,即没有两个组件参数具有相同的名称 <parameter>,则也可以使用不带 <component>__ 的字符串 <parameter>

参数:
**paramsdict

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

返回:
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, 默认=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

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

返回:
自身

对自身的引用。