CNTCClassifier#
- class CNTCClassifier(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='categorical_crossentropy', metrics=None, random_state=0)[source]#
上下文时间序列神经网络分类器(CNTC),如文献 [1] 所述。
改编自 Fullah 等人的实现 AmaduFullah/CNTC_MODEL
- 参数:
- n_epochsint, default = 2000
模型训练的轮次数
- batch_sizeint, default = 16
每个梯度更新的样本数。
- filter_sizes形状为 (2) 的元组,default = (16, 8)
CCNN 分支中 CNN 的过滤器大小。
- kernel_sizes二元组,default = (1, 1)
CCNN 分支中 CNN 的一维卷积窗口长度。
- rnn_sizeint, default = 64
CCNN 分支中 RNN 单元的数量。
- lstm_sizeint, default = 8
CLSTM 分支中 LSTM 单元的数量。
- dense_sizeint, default = 64
CNTC 中全连接层的维度。
- random_stateint 或 None, default=None
随机数生成的种子。
- verboseboolean, default = False
是否输出额外信息
- lossstring, default=”categorical_crossentropy”
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 = {Time series classification, Contextual convolutional neural
networks, Contextual long short-term memory, Attention, Multilayer perceptron},
}
示例
>>> from sktime.classification.deep_learning.cntc import CNTCClassifier >>> from sktime.datasets import load_unit_test >>> X_train, y_train = load_unit_test(split="train", return_X_y=True) >>> X_test, y_test = load_unit_test(split="test", return_X_y=True) >>> cntc = CNTCClassifier() >>> cntc.fit(X_train, y_train) CNTCClassifier(...)
方法
build_model
(input_shape, n_classes, **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)使用训练数据拟合时间序列分类器。
fit_predict
(X, y[, cv, change_state])拟合并预测 X 中序列的标签。
fit_predict_proba
(X, y[, cv, change_state])拟合并预测 X 中序列的标签概率。
get_class_tag
(tag_name[, tag_value_default])从类中获取类标签值,具有从父类继承的标签级别。
从类中获取类标签,具有从父类继承的标签级别。
获取自身的配置标志。
get_fitted_params
([deep])获取已拟合参数。
获取对象的默认参数。
get_param_names
([sort])获取对象的参数名称。
get_params
([deep])获取此对象的参数值字典。
get_tag
(tag_name[, tag_value_default, ...])从实例获取标签值,具有标签级别继承和覆盖。
get_tags
()从实例获取标签,具有标签级别继承和覆盖。
get_test_params
([parameter_set])返回评估器的测试参数设置。
检查对象是否由其他 BaseObjects 组成。
load_from_path
(serial)从文件位置加载对象。
load_from_serial
(serial)从序列化内存容器加载对象。
predict
(X)预测 X 中序列的标签。
预测 X 中序列的标签概率。
为模型的 CLSTM 分支准备输入。
reset
()将对象重置为初始化后的干净状态。
save
([path, serialization_format])将序列化后的自身保存到字节状对象或 (.zip) 文件。
score
(X, y)在 X 上根据真实标签对预测标签进行评分。
set_config
(**config_dict)将配置标志设置为给定值。
set_params
(**params)设置此对象的参数。
set_random_state
([random_state, deep, ...])为自身设置 random_state 伪随机种子参数。
set_tags
(**tag_dict)将实例级标签覆盖设置为给定值。
summary
()返回模型拟合的损失/指标的摘要函数。
- build_model(input_shape, n_classes, **kwargs)[source]#
构建一个已编译、未训练的 Keras 模型,可用于训练。
在 sktime 中,时间序列存储在形状为 (d,m) 的 numpy 数组中,其中 d 是维度数量,m 是序列长度。
- 参数:
- input_shapetuple
输入层接收的数据形状,应为 (d,m)
- n_classes: int
类别数量,即输出层的大小
- 返回值:
- output一个已编译的 Keras Model
- prepare_input(X)[source]#
为模型的 CLSTM 分支准备输入。
- 根据论文
- “
时间序列数据同时输入到 CLSTM 和 CCNN 网络并被区别对待。在 CLSTM 块中,输入数据被视为具有单个时间戳的多元时间序列。相比之下,CCNN 块接收具有多个时间戳的单变量数据
“
- 返回值:
- trainX: tuple,
馈送到 CNTC 两个分支的输入。
- check_is_fitted(method_name=None)[source]#
检查评估器是否已拟合。
检查评估器是否已拟合。应在调用对象的
fit
方法时将_is_fitted
属性设置为True
。如果未拟合,则抛出
NotFittedError
异常。- 参数:
- method_namestr, optional
调用此函数的方法的名称。如果提供,错误消息将包含此信息。
- 抛出异常:
- NotFittedError
如果评估器尚未拟合。
- clone()[source]#
获取对象的克隆,具有相同的超参数和配置。
克隆是一个不同的对象,没有共享引用,处于初始化后的状态。此函数等同于返回
sklearn.clone
的self
。等同于构造
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
设置动态标签覆盖。应仅在对象的
__init__
方法中,在构造期间或通过__init__
直接在构造后调用clone_tags
方法。动态标签被设置为
estimator
中标签的值,名称在tag_names
中指定。tag_names
的默认设置是将estimator
的所有标签写入到self
中。当前的标签值可以通过
get_tags
或get_tag
检查。- 参数:
- estimator:class:BaseObject 或派生类的实例
- tag_namesstr 或 list of str,default = None
要克隆的标签名称。默认值 (
None
) 克隆estimator
的所有标签。
- 返回值:
- self
对
self
的引用。
- classmethod create_test_instance(parameter_set='default')[source]#
使用第一个测试参数集构造类的实例。
- 参数:
- parameter_setstr, default=”default”
要返回的测试参数集的名称,用于测试。如果未为某个值定义特殊参数,则将返回 “default” 集。
- 返回值:
- instance具有默认参数的类实例
- classmethod create_test_instances_and_names(parameter_set='default')[source]#
创建所有测试实例及其名称的列表。
- 参数:
- parameter_setstr, default=”default”
要返回的测试参数集的名称,用于测试。如果未为某个值定义特殊参数,则将返回 “default” 集。
- 返回值:
- objscls 实例列表
第 i 个实例是
cls(**cls.get_test_params()[i])
- nameslist of str,与 objs 长度相同
第 i 个元素是测试中 obj 第 i 个实例的名称。如果实例多于一个,命名约定为
{cls.__name__}-{i}
,否则为{cls.__name__}
- fit(X, y)[source]#
使用训练数据拟合时间序列分类器。
- 状态变更
将状态更改为“fitted”。
- 写入自身
将 self.is_fitted 设置为 True。设置以“_”结尾的已拟合模型属性。
- 参数:
- XPanel scitype 的 sktime 兼容时间序列面板数据容器
用于拟合评估器的时间序列。
可以是
Panel
scitype 的任何 mtype,例如pd-multiindex: 列为变量,索引为 pd.MultiIndex 的 pd.DataFrame,其中第一级为实例索引,第二级为时间索引
numpy3D: 形状为 [n_instances, n_dimensions, series_length] 的 3D np.array(任意维数,等长序列)
或任何其他支持的
Panel
mtype
mtype 列表请参见
datatypes.SCITYPE_REGISTER
有关规范,请参见
examples/AA_datatypes_and_datasets.ipynb
并非所有评估器都支持具有多元或不等长序列的面板,详情请参见标签参考。
- yTable scitype 的 sktime 兼容表格数据容器
用于拟合的类别标签,形状为 [n_instances] 的 1D 可迭代对象,或形状为 [n_instances, n_dimensions] 的 2D 可迭代对象 0 级索引对应于 X 中的实例索引 1 级索引(如果适用)对应于 X 中多输出向量的索引 支持的 sktime 类型:np.ndarray (1D, 2D), pd.Series, pd.DataFrame
- 返回值:
- self对自身的引用。
- fit_predict(X, y, cv=None, change_state=True)[source]#
拟合并预测 X 中序列的标签。
用于生成样本内预测和交叉验证的样本外预测的便利方法。
- 如果 change_state=True,则写入自身
将 self.is_fitted 设置为 True。设置以“_”结尾的已拟合模型属性。
如果 change_state=False,则不更新状态。
- 参数:
- XPanel scitype 的 sktime 兼容时间序列面板数据容器
用于拟合并预测标签的时间序列。
可以是
Panel
scitype 的任何 mtype,例如pd-multiindex: 列为变量,索引为 pd.MultiIndex 的 pd.DataFrame,其中第一级为实例索引,第二级为时间索引
numpy3D: 形状为 [n_instances, n_dimensions, series_length] 的 3D np.array(任意维数,等长序列)
或任何其他支持的
Panel
mtype
mtype 列表请参见
datatypes.SCITYPE_REGISTER
有关规范,请参见
examples/AA_datatypes_and_datasets.ipynb
并非所有评估器都支持具有多元或不等长序列的面板,详情请参见标签参考。
- yTable scitype 的 sktime 兼容表格数据容器
用于拟合的类别标签,形状为 [n_instances] 的 1D 可迭代对象,或形状为 [n_instances, n_dimensions] 的 2D 可迭代对象 0 级索引对应于 X 中的实例索引 1 级索引(如果适用)对应于 X 中多输出向量的索引 支持的 sktime 类型:np.ndarray (1D, 2D), pd.Series, pd.DataFrame
- cvNone, int, 或 sklearn 交叉验证对象,可选,default=None
None : 预测是样本内预测,等同于
fit(X, y).predict(X)
cv : 预测等同于
fit(X_train, y_train).predict(X_test)
,其中多个X_train
,y_train
,X_test
从cv
折叠获得。返回的y
是所有测试折叠预测的并集,cv
测试折叠必须是非交叉的int : 等同于
cv=KFold(cv, shuffle=True, random_state=x)
,即 k 折交叉验证的样本外预测,其中random_state
x
如果存在则取自self
,否则x=None
- change_statebool, 可选 (default=True)
如果为 False,将不会改变分类器的状态,即拟合/预测序列使用副本运行,self 不改变
如果为 True,将对完整的 X 和 y 拟合 self,结束状态将等同于运行 fit(X, y)
- 返回值:
- y_predTable scitype 的 sktime 兼容表格数据容器
预测的类别标签
形状为 [n_instances] 的 1D 可迭代对象,或形状为 [n_instances, n_dimensions] 的 2D 可迭代对象。
0 级索引对应于 X 中的实例索引,1 级索引(如果适用)对应于 X 中多输出向量的索引。
如果 y 是单变量(一维),则是 1D np.npdarray;否则,类型与 fit 中传入的 y 相同
- fit_predict_proba(X, y, cv=None, change_state=True)[source]#
拟合并预测 X 中序列的标签概率。
用于生成样本内预测和交叉验证的样本外预测的便利方法。
- 如果 change_state=True,则写入自身
将 self.is_fitted 设置为 True。设置以“_”结尾的已拟合模型属性。
如果 change_state=False,则不更新状态。
- 参数:
- XPanel scitype 的 sktime 兼容时间序列面板数据容器
用于拟合并预测标签的时间序列。
可以是
Panel
scitype 的任何 mtype,例如pd-multiindex: 列为变量,索引为 pd.MultiIndex 的 pd.DataFrame,其中第一级为实例索引,第二级为时间索引
numpy3D: 形状为 [n_instances, n_dimensions, series_length] 的 3D np.array(任意维数,等长序列)
或任何其他支持的
Panel
mtype
mtype 列表请参见
datatypes.SCITYPE_REGISTER
有关规范,请参见
examples/AA_datatypes_and_datasets.ipynb
并非所有评估器都支持具有多元或不等长序列的面板,详情请参见标签参考。
- yTable scitype 的 sktime 兼容表格数据容器
用于拟合的类别标签,形状为 [n_instances] 的 1D 可迭代对象,或形状为 [n_instances, n_dimensions] 的 2D 可迭代对象 0 级索引对应于 X 中的实例索引 1 级索引(如果适用)对应于 X 中多输出向量的索引 支持的 sktime 类型:np.ndarray (1D, 2D), pd.Series, pd.DataFrame
- cvNone, int, 或 sklearn 交叉验证对象,可选,default=None
None : 预测是样本内预测,等同于
fit(X, y).predict(X)
cv : 预测等同于
fit(X_train, y_train).predict(X_test)
,其中多个X_train
,y_train
,X_test
从cv
折叠获得。返回的y
是所有测试折叠预测的并集,cv
测试折叠必须是非交叉的int : 等同于
cv=KFold(cv, shuffle=True, random_state=x)
,即 k 折交叉验证的样本外预测,其中random_state
x
如果存在则取自self
,否则x=None
- change_statebool, 可选 (default=True)
如果为 False,将不会改变分类器的状态,即拟合/预测序列使用副本运行,self 不改变
如果为 True,将对完整的 X 和 y 拟合 self,结束状态将等同于运行 fit(X, y)
- 返回值:
- y_pred形状为 [n_instances, n_classes] 的 2D np.array
预测的类别标签概率 0 级索引对应于 X 中的实例索引 1 级索引对应于类别索引,顺序与 self.classes_ 中的顺序相同 条目是预测类别概率,总和为 1
- classmethod get_class_tag(tag_name, tag_value_default=None)[source]#
从类中获取类标签值,具有从父类继承的标签级别。
每个与
scikit-base
兼容的对象都有一个标签字典,用于存储对象的元数据。get_class_tag
方法是一个类方法,它仅考虑类级标签值和覆盖来检索标签的值。它返回对象中名称为
tag_name
的标签值,考虑标签覆盖,优先级按降序排列如下类
_tags
属性中设置的标签。父类
_tags
属性中设置的标签,
按继承顺序。
不考虑实例上通过
set_tags
或clone_tags
设置的动态标签覆盖。要检索可能带有实例覆盖的标签值,请使用
get_tag
方法。- 参数:
- tag_namestr
标签值的名称。
- tag_value_default任意类型
如果未找到标签,则为默认/备用值。
- 返回值:
- tag_value
self
中tag_name
标签的值。如果未找到,则返回tag_value_default
。
- classmethod get_class_tags()[source]#
从类中获取类标签,具有从父类继承的标签级别。
每个与
scikit-base
兼容的对象都有一个标签字典。标签可用于存储对象的元数据,或控制对象的行为。标签是特定于实例
self
的键值对,它们是对象构造后不更改的静态标志。get_class_tags
方法是一个类方法,它仅考虑类级标签值和覆盖来检索标签的值。它返回一个字典,键是类或其任何父类中设置的
_tags
任何属性的键。值是相应的标签值,覆盖按以下降序排列
类
_tags
属性中设置的标签。父类
_tags
属性中设置的标签,
按继承顺序。
实例可以根据超参数覆盖这些标签。
要检索可能带有实例覆盖的标签,请使用
get_tags
方法。不考虑实例上通过
set_tags
或clone_tags
设置的动态标签覆盖。要包含动态标签的覆盖,请使用
get_tags
。- collected_tagsdict
标签名称: 标签值对的字典。通过嵌套继承从
_tags
类属性收集。不会被set_tags
或clone_tags
设置的动态标签覆盖。
- get_config()[source]#
获取自身的配置标志。
配置是
self
的键值对,通常用作控制行为的瞬时标志。get_config
返回动态配置,这些配置会覆盖默认配置。默认配置在类或其父类的类属性
_config
中设置,并被通过set_config
设置的动态配置覆盖。配置在
clone
或reset
调用下被保留。- 返回值:
- config_dictdict
配置名称: 配置值对的字典。通过嵌套继承从 _config 类属性收集,然后从 _config_dynamic 对象属性收集任何覆盖和新标签。
- get_fitted_params(deep=True)[source]#
获取已拟合参数。
- 所需状态
要求状态为“fitted”。
- 参数:
- deepbool, default=True
是否返回组件的已拟合参数。
如果为 True,将返回此对象的参数名 : 值字典,包括可拟合组件(= BaseEstimator 值参数)的已拟合参数。
如果为 False,将返回此对象的参数名 : 值字典,但不包含组件的已拟合参数。
- 返回值:
- fitted_params带有 str 值键的字典
已拟合参数字典,参数名 : 参数值 的键值对包括
始终:此对象的所有已拟合参数,通过
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, default=True
是否按字母顺序返回参数名称 (True),还是按它们出现在类
__init__
中的顺序返回 (False)。
- 返回值:
- param_names: list[str]
cls
的参数名称列表。如果sort=False
,则按它们出现在类__init__
中的顺序排列。如果sort=True
,则按字母顺序排列。
- get_params(deep=True)[source]#
获取此对象的参数值字典。
- 参数:
- deepbool, default=True
是否返回组件的参数。
如果为
True
,将返回此对象的参数名: 值字典,包括组件的参数(=BaseObject
类型参数)。如果为
False
,将返回此对象的参数名: 值字典,但不包括组件的参数。
- 返回值:
- paramsdict, 键为 str 类型
参数字典,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
的单个标签的值,考虑标签的覆盖,优先级按降序排列如下:在实例上通过
set_tags
或clone_tags
设置的标签,
在实例构造时设置的标签。
类
_tags
属性中设置的标签。父类
_tags
属性中设置的标签,
按继承顺序。
- 参数:
- tag_namestr
要检索的标签名称
- tag_value_default任意类型, 可选; default=None
如果未找到标签,则使用的默认/备用值
- raise_errorbool
未找到标签时是否引发
ValueError
- 返回值:
- tag_valueAny
self
中tag_name
标签的值。如果未找到,则在raise_error
为 True 时引发错误,否则返回tag_value_default
。
- 抛出异常:
- ValueError, 如果
raise_error
为True
。 当
tag_name
不在self.get_tags().keys()
中时,会引发ValueError
。
- ValueError, 如果
- get_tags()[source]#
从实例获取标签,具有标签级别继承和覆盖。
每个与
scikit-base
兼容的对象都有一个标签字典。标签可用于存储对象的元数据,或控制对象的行为。标签是特定于实例
self
的键值对,它们是对象构造后不更改的静态标志。get_tags
方法返回一个标签字典,其键是类中或其任何父类中设置的_tags
属性的任何键,或者是通过set_tags
或clone_tags
设置的标签。值是相应的标签值,覆盖按以下降序排列
在实例上通过
set_tags
或clone_tags
设置的标签,
在实例构造时设置的标签。
类
_tags
属性中设置的标签。父类
_tags
属性中设置的标签,
按继承顺序。
- 返回值:
- collected_tagsdict
标签名 : 标签值对的字典。从通过嵌套继承的
_tags
类属性中收集,然后从_tags_dynamic
对象属性中收集任何覆盖和新标签。
- classmethod get_test_params(parameter_set='default')[source]#
返回评估器的测试参数设置。
- 参数:
- parameter_setstr, default=”default”
要返回的测试参数集的名称,用于测试。如果某个值没有定义特殊参数,将返回
"default"
集。对于分类器,应提供一组“默认”参数用于通用测试,以及一组“结果比较”参数,用于在通用集未产生合适的概率进行比较时,与先前记录的结果进行比较。
- 返回值:
- paramsdict 或 dict 列表, default={}
用于创建类测试实例的参数。每个字典都是构造“有趣”测试实例的参数,即
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]#
从文件位置加载对象。
- 参数:
- serialzip 文件名。
- 返回值:
- 反序列化的 self,产生在
path
处的输出,即cls.save(path)
的输出
- 反序列化的 self,产生在
- classmethod load_from_serial(serial)[source]#
从序列化内存容器加载对象。
- 参数:
- serial: ``cls.save(None)`` 输出的第一个元素
这是一个大小为 3 的元组。第一个元素表示 pickle 序列化的实例。第二个元素表示 h5py 序列化的
keras
模型。第三个元素表示 pickle 序列化的.fit()
历史。
- 返回值:
- 反序列化的 self,产生输出
serial
,即cls.save(None)
的输出
- 反序列化的 self,产生输出
- predict(X)[source]#
预测 X 中序列的标签。
- 参数:
- XPanel scitype 的 sktime 兼容时间序列面板数据容器
要预测标签的时间序列。
可以是
Panel
scitype 的任何 mtype,例如pd-multiindex: 列为变量,索引为 pd.MultiIndex 的 pd.DataFrame,其中第一级为实例索引,第二级为时间索引
numpy3D: 形状为 [n_instances, n_dimensions, series_length] 的 3D np.array(任意维数,等长序列)
或任何其他支持的
Panel
mtype
mtype 列表请参见
datatypes.SCITYPE_REGISTER
有关规范,请参见
examples/AA_datatypes_and_datasets.ipynb
并非所有评估器都支持具有多元或不等长序列的面板,详情请参见标签参考。
- 返回值:
- y_predTable scitype 的 sktime 兼容表格数据容器
预测的类别标签
形状为 [n_instances] 的 1D 可迭代对象,或形状为 [n_instances, n_dimensions] 的 2D 可迭代对象。
0 级索引对应于 X 中的实例索引,1 级索引(如果适用)对应于 X 中多输出向量的索引。
如果 y 是单变量(一维),则是 1D np.npdarray;否则,类型与 fit 中传入的 y 相同
- predict_proba(X)[source]#
预测 X 中序列的标签概率。
- 参数:
- XPanel scitype 的 sktime 兼容时间序列面板数据容器
要预测标签的时间序列。
可以是
Panel
scitype 的任何 mtype,例如pd-multiindex: 列为变量,索引为 pd.MultiIndex 的 pd.DataFrame,其中第一级为实例索引,第二级为时间索引
numpy3D: 形状为 [n_instances, n_dimensions, series_length] 的 3D np.array(任意维数,等长序列)
或任何其他支持的
Panel
mtype
mtype 列表请参见
datatypes.SCITYPE_REGISTER
有关规范,请参见
examples/AA_datatypes_and_datasets.ipynb
并非所有评估器都支持具有多元或不等长序列的面板,详情请参见标签参考。
- 返回值:
- y_pred形状为 [n_instances, n_classes] 的 2D np.array
预测的类别标签概率,0-th 索引对应于 X 中的实例索引,1-st 索引对应于类别索引,顺序与 self.classes_ 中的顺序相同,条目是预测的类别概率,总和为 1。
- 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
是文件,则在该位置存储一个同名 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
。- serialization_formatstr, default = “pickle”
用于序列化的模块。可用选项位于
sktime.base._base.SERIALIZATION_FORMATS
下。请注意,非默认格式可能需要安装其他软依赖。
- 返回值:
- 如果
path
为 None - 内存中序列化的 self - 如果
path
为文件位置 - 引用该文件的 ZipFile 对象
- 如果
- score(X, y) float [source]#
在 X 上根据真实标签对预测标签进行评分。
- 参数:
- XPanel scitype 的 sktime 兼容时间序列面板数据容器
用于评分预测标签的时间序列。
可以是
Panel
scitype 的任何 mtype,例如pd-multiindex: 列为变量,索引为 pd.MultiIndex 的 pd.DataFrame,其中第一级为实例索引,第二级为时间索引
numpy3D: 形状为 [n_instances, n_dimensions, series_length] 的 3D np.array(任意维数,等长序列)
或任何其他支持的
Panel
mtype
mtype 列表请参见
datatypes.SCITYPE_REGISTER
有关规范,请参见
examples/AA_datatypes_and_datasets.ipynb
并非所有评估器都支持具有多元或不等长序列的面板,详情请参见标签参考。
- yTable scitype 的 sktime 兼容表格数据容器
用于拟合的类别标签,形状为 [n_instances] 的 1D 可迭代对象,或形状为 [n_instances, n_dimensions] 的 2D 可迭代对象 0 级索引对应于 X 中的实例索引 1 级索引(如果适用)对应于 X 中多输出向量的索引 支持的 sktime 类型:np.ndarray (1D, 2D), pd.Series, pd.DataFrame
- 返回值:
- float, predict(X) 与 y 的准确率得分
- set_config(**config_dict)[source]#
将配置标志设置为给定值。
- 参数:
- config_dictdict
配置名 : 配置值对的字典。有效的配置、值及其含义如下所示
- displaystr, “diagram” (default), 或 “text”
jupyter 内核如何显示 self 的实例
“diagram” = html 框图表示
“text” = 字符串打印输出
- print_changed_onlybool, default=True
打印 self 时,是否只列出自默认值有所不同的 self 参数 (False),还是列出所有参数名称和值 (False)。不嵌套,即仅影响 self 而不影响组件估计器。
- warningsstr, “on” (default), 或 “off”
是否引发警告,仅影响来自 sktime 的警告
“on” = 将引发来自 sktime 的警告
“off” = 将不引发来自 sktime 的警告
- backend:parallelstr, 可选, default=”None”
广播/向量化时用于并行化的后端之一:
“None”: 顺序执行循环,简单的列表推导式
“loky”, “multiprocessing” 和 “threading”: 使用
joblib.Parallel
“joblib”: 自定义和第三方
joblib
后端,例如spark
“dask”: 使用
dask
,需要在环境中安装dask
包“ray”: 使用
ray
,需要在环境中安装ray
包
- backend:parallel:paramsdict, 可选, 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”: bool, default=True; False 会阻止
ray
在并行化后关闭。 “logger_name”: str, default=”ray”; 要使用的日志记录器的名称。
- “shutdown_ray”: bool, default=True; False 会阻止
“mute_warnings”: bool, default=False; 如果为 True,则抑制警告。
“mute_warnings”:布尔型,默认值:False;若为True,则抑制警告
- 返回值:
- self指向 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指向 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
的链式哈希采样,保证了 seeded 随机生成器的伪随机独立性。适用于
self
中的random_state
参数(取决于self_policy
),以及剩余组件对象(当且仅当deep=True
时)。注意:即使
self
没有random_state
,或者没有任何组件具有random_state
参数,也会调用set_params
。因此,set_random_state
将重置任何scikit-base
对象,即使那些没有random_state
参数的对象。- 参数:
- random_stateint, RandomState 实例或 None, default=None
伪随机数生成器,用于控制随机整数的生成。传入 int 以在多次函数调用中获得可重现的输出。
- deepbool, default=True
是否在 skbase 对象值参数中设置随机状态,即组件估计器。
如果为 False,则仅设置
self
的random_state
参数(如果存在)。如果为 True,则也会设置组件对象中的
random_state
参数。
- self_policystr, “copy”, “keep”, “new” 中的一个, default=”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_tags
或get_tag
检查。- 参数:
- **tag_dictdict
标签名: 标签值对的字典。
- 返回值:
- Self
指向 self 的引用。