CNTCRegressor#

class CNTCRegressor(n_epochs=2000, batch_size=16, filter_sizes=(16, 8), kernel_sizes=(1, 1), rnn_size=64, lstm_size=8, dense_size=64, callbacks=None, verbose=False, loss='mean_squared_error', metrics=None, random_state=0)[source]#

上下文时间序列神经网络回归器 (CNTC),如 [1] 中所述。

改编自 Fullah 等人的实现 AmaduFullah/CNTC_MODEL

参数:
n_epochsint, default = 2000训练模型的 epoch 数

训练模型的轮数

batch_sizeint, default = 16每次梯度更新的样本数。

每次梯度更新的样本数量。

filter_sizestuple of shape (2), default = (16, 8)CCNN 分支中 CNN 的滤波器大小。

CCNN 分支中 CNN 的滤波器尺寸。

kernel_sizestwo-tuple, default = (1, 1)CCNN 分支中 CNN 的一维卷积窗口长度。

CCNN 分支中 CNN 的一维卷积窗口长度。

rnn_sizeint, default = 64CCNN 分支中 RNN 单元的数量。

CCNN 分支中 RNN 单元的数量。

lstm_sizeint, default = 8CLSTM 分支中 LSTM 单元的数量。

CLSTM 分支中 LSTM 单元的数量。

dense_sizeint, default = 64CNTC 中全连接层的维度。

CNTC 中全连接层的维度。

random_stateint or None, default=None随机数生成的种子。

用于生成随机数的种子。

verboseboolean, default = False是否输出额外信息

是否输出额外信息

lossstring, default=”mean_squared_error”用于 Keras 模型的拟合参数

Keras 模型拟合参数

optimizerkeras.optimizer, default=keras.optimizers.Adam(),
metricslist of strings, default=[“accuracy”],
属性:
is_fitted

是否已调用 fit

参考文献

[1]
网络最初定义在

@article{FULLAHKAMARA202057, title = {Combining contextual neural networks for time series classification}, journal = {Neurocomputing}, volume = {384}, pages = {57-66}, year = {2020}, issn = {0925-2312}, doi = {https://doi.org/10.1016/j.neucom.2019.10.113}, url = {https://www.sciencedirect.com/science/article/pii/S0925231219316364}, author = {Amadu {Fullah Kamara} and Enhong Chen and Qi Liu and Zhen Pan}, keywords = {时间序列分类, 上下文卷积神经网络

networks, Contextual long short-term memory, Attention, Multilayer perceptron},

}

方法

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

获取自身的配置标志。

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

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

load_from_path(serial)

从文件位置加载对象。

load_from_serial(serial)

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

predict(X)

预测 X 中序列的标签。

prepare_input(X)

为模型的 CLSTM 分支准备输入。

reset()

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

save([path])

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

score(X, y[, multioutput])

根据 X 上的真实标签评估预测标签的分数。

set_config(**config_dict)

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

set_params(**params)

设置此对象的参数。

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

为自身设置 random_state 伪随机种子参数。

set_tags(**tag_dict)

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

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

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

在 sktime 中,时间序列存储在 shape 为 (d,m) 的 NumPy 数组中,其中 d 是维度数,m 是序列长度。

参数:
input_shapetuple输入到输入层的数据形状,应为 (d,m)

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

返回:
outputa compiled Keras Model一个已编译的 Keras 模型
prepare_input(X)[source]#

为模型的 CLSTM 分支准备输入。

根据论文

时间序列数据同时输入到 CLSTM 和 CCNN 网络中,并以不同的方式感知。在 CLSTM 块中,输入数据被视为具有单个时间戳的多元时间序列。相比之下,CCNN 块接收具有多个时间戳的单变量数据

返回:
trainXtuple,

输入到 CNTC 的两个分支。

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

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

参数:
parameter_setstr, default=”default”要返回的测试参数集名称,用于测试。如果未为某个值定义特殊参数,将返回 “default” 集。对于分类器,应提供一组 “default” 参数用于通用测试,如果通用集无法产生适合比较的概率,则提供一组 “results_comparison” 参数用于与先前记录的结果进行比较。

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

返回:
paramsdict or list of dict, default={}用于创建类测试实例的参数。每个 dict 是用于构造一个“有趣的”测试实例的参数,即 MyClass(**params)MyClass(**params[i]) 创建一个有效的测试实例。create_test_instance 使用 params 中的第一个(或唯一一个)字典。

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

check_is_fitted(method_name=None)[source]#

检查估计器是否已拟合。

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

如果不是,则抛出 NotFittedError

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

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

抛出:
NotFittedError

如果估计器尚未拟合。

clone()[source]#

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

克隆是另一个没有共享引用、处于初始化后状态的对象。此函数等同于返回自身的 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)[source]#

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

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

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

将动态标签覆盖从另一个对象 estimator 设置到自身。

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

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

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

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

参数:
estimator:class:BaseObject 或派生类的实例
tag_namesstr 或 list of str, default = None要克隆的标签名称。默认值 (None) 克隆 estimator 中的所有标签。

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

返回:
self

自身的引用。

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

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

参数:
parameter_setstr, default=”default”要返回的测试参数集名称,用于测试。如果未为某个值定义特殊参数,将返回 “default” 集。对于分类器,应提供一组 “default” 参数用于通用测试,如果通用集无法产生适合比较的概率,则提供一组 “results_comparison” 参数用于与先前记录的结果进行比较。

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

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

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

参数:
parameter_setstr, default=”default”要返回的测试参数集名称,用于测试。如果未为某个值定义特殊参数,将返回 “default” 集。对于分类器,应提供一组 “default” 参数用于通用测试,如果通用集无法产生适合比较的概率,则提供一组 “results_comparison” 参数用于与先前记录的结果进行比较。

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

返回:
objslist of instances of cls

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

nameslist of str, same length as objs

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

fit(X, y)[source]#

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

状态改变

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

写入自身

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

参数:
Xsktime 兼容的时间序列面板数据容器,Panel scitype要拟合估计器的时间序列。

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

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

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

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

  • 或任何其他支持的 Panel mtype

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

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

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

ysktime 兼容的表格数据容器,Table scitype形状为 [n_instances] 的一维可迭代对象,或形状为 [n_instances, n_dimensions] 的二维可迭代对象,用于拟合的类别标签,第 0 个索引对应 X 中的实例索引,第 1 个索引(如果适用)对应 X 中的多输出向量索引 支持的 sktime 类型:np.ndarray (1D, 2D), pd.Series, pd.DataFrame

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

返回:
self自身的引用。

注意

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

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_defaultany type, optional; default=None

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

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

获取自身的配置标志。

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

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

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

配置在 clonereset 调用下保留。

返回:
config_dictdict

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

get_fitted_params(deep=True)[source]#

获取拟合参数。

所需状态

要求状态为“已拟合”

参数:
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_dictdict[str, Any]

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

classmethod get_param_names(sort=True)[source]#

获取对象的参数名称。

参数:
sortbool, default=True

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

返回:
param_nameslist[str]

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

get_params(deep=True)[source]#

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

参数:
deepbool, default=True

是否返回组件的参数。

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

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

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

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

在实例构造时。

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

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

按继承顺序。

参数:
tag_namestr标签值的名称。

要检索的标签名称

tag_value_defaultany type, optional; 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]#

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

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

返回:
compositebool

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

property is_fitted[source]#

是否已调用 fit

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

返回:
bool

估计器是否已 fit

classmethod load_from_path(serial)[source]#

从文件位置加载对象。

参数:
serialZip 文件名。
返回:
反序列化的自身,结果输出在 cls.save(path)path 位置
classmethod load_from_serial(serial)[source]#

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

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

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

返回:
反序列化的自身,结果输出 serial,即 cls.save(None) 的输出
predict(X) ndarray[source]#

预测 X 中序列的标签。

参数:
Xsktime 兼容的时间序列面板数据容器,Panel scitype要拟合估计器的时间序列。

要预测标签的时间序列。

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

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

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

  • 或任何其他支持的 Panel mtype

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

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

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

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

预测的回归标签

形状为 [n_instances] 的一维可迭代对象,或形状为 [n_instances, n_dimensions] 的二维可迭代对象。

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

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

reset()[source]#

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

将自身设置为构造函数调用后的状态,保留相同的超参数。通过 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)[source]#

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

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

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

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

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

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

根据 X 上的真实标签评估预测标签的分数。

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

pd-multiindex: pd.DataFrame,其中列 = 变量,索引 = pd.MultiIndex,第一层 = 实例索引,第二层 = 时间索引 numpy3D: 3D np.array (任意维度数,等长序列),shape 为 [n_instances, n_dimensions, series_length] 或任何其他支持的 Panel mtype 有关 mtype 列表,请参见 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 中的实例索引

用于拟合的索引对应于 X 中的实例索引 或 形状为 [n_instances] 的一维整型 np.array - 用于拟合的回归标签对应于 X 中的实例索引

multioutputstr, optional (default=”uniform_average”){“raw_values”, “uniform_average”, “variance_weighted”},形状为 (n_outputs,) 的数组状对象或 None,默认值=”uniform_average”。定义多输出分数的聚合方式。数组状值定义用于平均分数的权重。

{“raw_values”, “uniform_average”, “variance_weighted”},形状为 (n_outputs,) 的类数组对象或 None,默认值为 “uniform_average”。定义如何聚合多个输出分数。类数组值定义用于平均分数的权重。

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

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

set_config(**config_dict)[source]#

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

参数:
config_dictdict

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

displaystr, “diagram” (default), or “text”

jupyter kernel 如何显示自身的实例

  • “diagram” = HTML 框图表示

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

print_changed_onlybool, default=True

打印自身时是否只列出自参数与默认值不同的参数 (False),或者列出所有参数名称和值 (False)。不嵌套,即仅影响自身,不影响组件估计器。

warningsstr, “on” (default), or “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”:布尔类型,默认为 True;False 可阻止 ray

      在并行化后关闭。

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

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

返回:
selfself 的引用。

注意

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

set_params(**params)[source]#

设置此对象的参数。

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

参数:
**params字典

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

返回:
selfself 的引用(参数设置后)
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, default=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,并且通常与其不同

返回:
selfself 的引用
set_tags(**tag_dict)[source]#

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

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

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

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

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

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

参数:
**tag_dict字典

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

返回:
Self

self 的引用。