InceptionTimeClassifier#
- class InceptionTimeClassifier(n_epochs=1500, batch_size=64, kernel_size=40, n_filters=32, use_residual=True, use_bottleneck=True, bottleneck_size=32, depth=6, callbacks=None, random_state=None, verbose=False, loss='categorical_crossentropy', metrics=None)[source]#
InceptionTime 深度学习分类器。
改编自 Fawaz 等人的实现 hfawaz/InceptionTime
InceptionTime 在 [1]_ 中有所描述,它是一种为时间序列分类设计的深度学习模型。它基于图像的 Inception 架构。该模型由一系列 Inception 模块组成。
InceptionTimeClassifier
是原始出版物 [1]_ 中描述的 InceptionTime 模型的一个单一实例,原始模型使用了 5 个单一实例的集成。要构建一个模仿 [1]_ 的模型集成,请使用
BaggingClassifier
,设置n_estimators=5
、bootstrap=False
,并将estimator
设置为此InceptionTimeClassifier
的一个实例。- 参数:
- n_epochsint, 默认值=1500
- batch_sizeint, 默认值=64
每次梯度更新的样本数量
- kernel_sizeint, 默认值=40
指定一维卷积窗口的长度
- n_filtersint, 默认值=32
- use_residualboolean, 默认值=True
- use_bottleneckboolean, 默认值=True
- bottleneck_sizeint, 默认值=32
- depthint, 默认值=6
- callbackstf.keras.callbacks.Callback 对象列表
- random_state: int, 可选, 默认值=None
用于内部随机数生成器的随机种子
- verbose: boolean, 默认值=False
是否打印运行时信息
- loss: str, 默认值=”categorical_crossentropy”
- metrics: 可选
- 属性:
is_fitted
是否已调用
fit
方法。
注意
..[1] Fawaz 等人,InceptionTime:寻找用于时间序列分类的 AlexNet,数据挖掘与知识发现,34, 2020
示例
InceptionTime 模型的一个单一实例:>>> from sktime.classification.deep_learning import InceptionTimeClassifier >>> from sktime.datasets import load_unit_test # doctest: +SKIP >>> X_train, y_train = load_unit_test(split=”train”) # doctest: +SKIP >>> X_test, y_test = load_unit_test(split=”test”) # doctest: +SKIP >>> clf = InceptionTimeClassifier() # doctest: +SKIP >>> clf.fit(X_train, y_train) # doctest: +SKIP InceptionTimeClassifier(…)
要构建一个模仿 [1]_ 的模型集成,请如下使用
BaggingClassifier
:>>> from sktime.classification.ensemble import BaggingClassifier >>> from sktime.classification.deep_learning import InceptionTimeClassifier >>> from sktime.datasets import load_unit_test # doctest: +SKIP >>> X_train, y_train = load_unit_test(split=”train”) # doctest: +SKIP >>> X_test, y_test = load_unit_test(split=”test”) # doctest: +SKIP >>> clf = BaggingClassifier( … InceptionTimeClassifier(), … n_estimators=5, … bootstrap=False … ) # doctest: +SKIP >>> clf.fit(X_train, y_train) # doctest: +SKIP BaggingClassifier(…)方法
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 中序列的标签概率。
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 模型,该模型已准备好进行训练。
- 参数:
- input_shapetuple
输入层接收的数据形状
- n_classes: int
- 类别的数量,它将成为输出
层
- 返回:
- output一个已编译的 Keras Model
- classmethod get_test_params(parameter_set='default')[source]#
返回估计器的测试参数设置。
- 参数:
- parameter_setstr, 默认值=”default”
要返回的测试参数集的名称,用于测试。如果未为某个值定义特殊参数,将返回
"default"
集。对于分类器,应提供“default”参数集用于一般测试,如果通用集未产生适合比较的概率,则提供“results_comparison”参数集用于与先前记录的结果进行比较。
- 返回:
- paramsdict 或 dict 列表, 默认值={}
用于创建该类测试实例的参数。每个 dict 都是用于构建一个“有趣”测试实例的参数,例如,
MyClass(**params)
或MyClass(**params[i])
创建一个有效的测试实例。create_test_instance
使用params
中的第一个(或唯一一个)字典。
- check_is_fitted(method_name=None)[source]#
检查估计器是否已拟合。
检查
_is_fitted
属性是否存在且为True
。is_fitted
属性应在调用对象的fit
方法时设置为True
。如果不是,则引发
NotFittedError
。- 参数:
- method_namestr, 可选
调用此函数的方法的名称。如果提供,错误消息将包含此信息。
- 引发:
- NotFittedError
如果估计器尚未拟合。
- clone()[source]#
获取一个具有相同超参数和配置的对象的克隆。
克隆是一个不同的对象,没有共享引用,处于初始化后状态。此函数等效于返回
self
的sklearn.clone
。等效于构建
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_tags
或get_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 个元素是测试中 obj 的第 i 个实例的名称。如果实例不止一个,命名约定是
{cls.__name__}-{i}
,否则是{cls.__name__}
- fit(X, y)[source]#
将时间序列分类器拟合到训练数据。
- 状态更改
将状态更改为“fitted”。
- 写入自身
将 self.is_fitted 设置为 True。设置以“_”结尾的已拟合模型属性。
- 参数:
- XPanel scientific type 的 sktime 兼容时间序列面板数据容器
用于拟合估计器的时间序列。
可以是 `Panel` scientific type 的任何 mtype 格式,例如
pd-multiindex: 列为变量,索引为 pd.MultiIndex 的 pd.DataFrame,其中第一级为实例索引,第二级为时间索引
numpy3D: 形状为 [n_instances, n_dimensions, series_length] 的 3D np.array(任意维数,等长序列)
或任何其他支持的 `Panel` mtype
mtypes 列表,请参阅
datatypes.SCITYPE_REGISTER
有关规范,请参阅
examples/AA_datatypes_and_datasets.ipynb
并非所有估计器都支持具有多元或不等长序列的面板,详情请参阅 标签参考。
- yTable scientific type 的 sktime 兼容表格数据容器
1D 可迭代对象,形状为 [n_instances] 或 2D 可迭代对象,形状为 [n_instances, n_dimensions] 用于拟合的类标签 第 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 scientific type 的 sktime 兼容时间序列面板数据容器
用于拟合和预测标签的时间序列。
可以是 `Panel` scientific type 的任何 mtype 格式,例如
pd-multiindex: 列为变量,索引为 pd.MultiIndex 的 pd.DataFrame,其中第一级为实例索引,第二级为时间索引
numpy3D: 形状为 [n_instances, n_dimensions, series_length] 的 3D np.array(任意维数,等长序列)
或任何其他支持的 `Panel` mtype
mtypes 列表,请参阅
datatypes.SCITYPE_REGISTER
有关规范,请参阅
examples/AA_datatypes_and_datasets.ipynb
并非所有估计器都支持具有多元或不等长序列的面板,详情请参阅 标签参考。
- yTable scientific type 的 sktime 兼容表格数据容器
1D 可迭代对象,形状为 [n_instances] 或 2D 可迭代对象,形状为 [n_instances, n_dimensions] 用于拟合的类标签 第 0 个索引对应于 X 中的实例索引 第 1 个索引(如果适用)对应于 X 中的多输出向量索引 支持的 sktime 类型:np.ndarray (1D, 2D), pd.Series, pd.DataFrame
- cvNone, int, 或 sklearn 交叉验证对象, 可选, 默认值=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, 可选 (默认值=True)
如果为 False,则不会更改分类器的状态,即拟合/预测序列使用副本运行,自身不会更改
如果为 True,则将自身拟合到完整的 X 和 y,最终状态将等同于运行 fit(X, y)
- 返回:
- y_predTable scientific type 的 sktime 兼容表格数据容器
预测的类别标签
1D 可迭代对象,形状为 [n_instances],或 2D 可迭代对象,形状为 [n_instances, n_dimensions]。
第 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 scientific type 的 sktime 兼容时间序列面板数据容器
用于拟合和预测标签的时间序列。
可以是 `Panel` scientific type 的任何 mtype 格式,例如
pd-multiindex: 列为变量,索引为 pd.MultiIndex 的 pd.DataFrame,其中第一级为实例索引,第二级为时间索引
numpy3D: 形状为 [n_instances, n_dimensions, series_length] 的 3D np.array(任意维数,等长序列)
或任何其他支持的 `Panel` mtype
mtypes 列表,请参阅
datatypes.SCITYPE_REGISTER
有关规范,请参阅
examples/AA_datatypes_and_datasets.ipynb
并非所有估计器都支持具有多元或不等长序列的面板,详情请参阅 标签参考。
- yTable scientific type 的 sktime 兼容表格数据容器
1D 可迭代对象,形状为 [n_instances] 或 2D 可迭代对象,形状为 [n_instances, n_dimensions] 用于拟合的类标签 第 0 个索引对应于 X 中的实例索引 第 1 个索引(如果适用)对应于 X 中的多输出向量索引 支持的 sktime 类型:np.ndarray (1D, 2D), pd.Series, pd.DataFrame
- cvNone, int, 或 sklearn 交叉验证对象, 可选, 默认值=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, 可选 (默认值=True)
如果为 False,则不会更改分类器的状态,即拟合/预测序列使用副本运行,自身不会更改
如果为 True,则将自身拟合到完整的 X 和 y,最终状态将等同于运行 fit(X, y)
- 返回:
- y_pred2D np.array (int 类型),形状为 [n_instances, n_classes]
预测的类别标签概率 第 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 类属性收集,然后从 _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
的单个标签的值,考虑标签覆盖,优先级按以下降序排列通过
set_tags
或clone_tags
在实例上设置的标签,
在实例构造时。
在类的
_tags
属性中设置的标签。在父类的
_tags
属性中设置的标签,
按继承顺序排列。
- 参数:
- tag_namestr
要检索的标签名称
- tag_value_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
对象属性中收集任何覆盖和新标签。
- 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 文件的名称。
- 返回:
cls.save(path)
在path
生成的输出的反序列化自身
- classmethod load_from_serial(serial)[source]#
从序列化内存容器加载对象。
- 参数:
- serial: ``cls.save(None)`` 输出的第一个元素
这是一个大小为 3 的元组。第一个元素表示 pickle 序列化的实例。第二个元素表示 h5py 序列化的
keras
模型。第三个元素表示 pickle 序列化的.fit()
历史记录。
- 返回:
cls.save(None)
输出serial
的反序列化自身
- predict(X)[source]#
预测 X 中序列的标签。
- 参数:
- XPanel scientific type 的 sktime 兼容时间序列面板数据容器
用于预测标签的时间序列。
可以是 `Panel` scientific type 的任何 mtype 格式,例如
pd-multiindex: 列为变量,索引为 pd.MultiIndex 的 pd.DataFrame,其中第一级为实例索引,第二级为时间索引
numpy3D: 形状为 [n_instances, n_dimensions, series_length] 的 3D np.array(任意维数,等长序列)
或任何其他支持的 `Panel` mtype
mtypes 列表,请参阅
datatypes.SCITYPE_REGISTER
有关规范,请参阅
examples/AA_datatypes_and_datasets.ipynb
并非所有估计器都支持具有多元或不等长序列的面板,详情请参阅 标签参考。
- 返回:
- y_predTable scientific type 的 sktime 兼容表格数据容器
预测的类别标签
1D 可迭代对象,形状为 [n_instances],或 2D 可迭代对象,形状为 [n_instances, n_dimensions]。
第 0 个索引对应于 X 中的实例索引,第 1 个索引(如果适用)对应于 X 中的多输出向量索引。
如果 y 是一元(一维),则为 1D np.npdarray;否则,与 fit 中传递的 y 类型相同
- predict_proba(X)[source]#
预测 X 中序列的标签概率。
- 参数:
- XPanel scientific type 的 sktime 兼容时间序列面板数据容器
用于预测标签的时间序列。
可以是 `Panel` scientific type 的任何 mtype 格式,例如
pd-multiindex: 列为变量,索引为 pd.MultiIndex 的 pd.DataFrame,其中第一级为实例索引,第二级为时间索引
numpy3D: 形状为 [n_instances, n_dimensions, series_length] 的 3D np.array(任意维数,等长序列)
或任何其他支持的 `Panel` mtype
mtypes 列表,请参阅
datatypes.SCITYPE_REGISTER
有关规范,请参阅
examples/AA_datatypes_and_datasets.ipynb
并非所有估计器都支持具有多元或不等长序列的面板,详情请参阅 标签参考。
- 返回:
- y_pred2D np.array (int 类型),形状为 [n_instances, n_classes]
预测的类别标签概率 第 0 个索引对应于 X 中的实例索引 第 1 个索引对应于类别索引,顺序与 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,则返回内存中的序列化自身;如果path
是文件,则在该位置存储名为该名称的 zip 文件。zip 文件内容包括:_metadata - 包含自身的类,即 type(self)。_obj - 序列化的自身。此类使用默认的序列化方式 (pickle)。keras/ - 模型、优化器和状态存储在此目录中。history - 序列化历史记录对象。- 参数:
- pathNone 或文件位置 (str 或 Path)
如果为 None,自身保存到内存对象;如果是文件位置,自身保存到该文件位置。例如
path=”estimator” 则会在当前工作目录创建
estimator.zip
文件。path=”/home/stored/estimator” 则会在/home/stored/
中存储estimator.zip
文件。- serialization_formatstr, 默认值 = “pickle”
用于序列化的模块。可用选项位于
sktime.base._base.SERIALIZATION_FORMATS
下。请注意,非默认格式可能需要安装其他软依赖项。
- 返回:
- 如果
path
为 None - 内存中的序列化自身 - 如果
path
是文件位置 - 包含文件引用的 ZipFile
- 如果
- score(X, y) float [source]#
根据 X 上的真实标签对预测标签进行评分。
- 参数:
- XPanel scientific type 的 sktime 兼容时间序列面板数据容器
用于对预测标签评分的时间序列。
可以是 `Panel` scientific type 的任何 mtype 格式,例如
pd-multiindex: 列为变量,索引为 pd.MultiIndex 的 pd.DataFrame,其中第一级为实例索引,第二级为时间索引
numpy3D: 形状为 [n_instances, n_dimensions, series_length] 的 3D np.array(任意维数,等长序列)
或任何其他支持的 `Panel` mtype
mtypes 列表,请参阅
datatypes.SCITYPE_REGISTER
有关规范,请参阅
examples/AA_datatypes_and_datasets.ipynb
并非所有估计器都支持具有多元或不等长序列的面板,详情请参阅 标签参考。
- yTable scientific type 的 sktime 兼容表格数据容器
1D 可迭代对象,形状为 [n_instances] 或 2D 可迭代对象,形状为 [n_instances, n_dimensions] 用于拟合的类标签 第 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”(默认)或“text”
jupyter kernel 如何显示自身的实例
“diagram” = html 盒子图表示
“text” = 字符串打印输出
- print_changed_onlybool, 默认值=True
打印自身时是否仅列出与默认值不同的自身参数 (False),或所有参数名称和值 (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, 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”: bool, default=True; False 阻止
ray
在并行化后 关闭。
- “shutdown_ray”: bool, default=True; False 阻止
“logger_name”: str, default=”ray”; 要使用的日志记录器名称。
“mute_warnings”: bool, default=False; 如果为 True,则抑制警告
- 返回:
- self对 self 的引用。
注意
改变对象状态,将 config_dict 中的配置复制到 self._config_dynamic。
- set_params(**params)[源代码]#
设置此对象的参数。
此方法适用于简单的 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')[源代码]#
为自身设置 random_state 伪随机种子参数。
通过
self.get_params
查找名为random_state
的参数,并通过set_params
将它们设置为从random_state
派生的整数。这些整数通过sample_dependent_seed
通过链式哈希采样,并保证种子随机生成器的伪随机独立性。根据
self_policy
和剩余组件对象(当且仅当deep=True
时),应用于self
中的random_state
参数。注意:即使
self
没有random_state
参数,或者没有任何组件有random_state
参数,也会调用set_params
。因此,set_random_state
将重置任何scikit-base
对象,即使是那些没有random_state
参数的对象。- 参数:
- random_stateint, RandomState instance 或 None, default=None
伪随机数生成器,用于控制随机整数的生成。传递 int 可在多次函数调用中获得可重现的输出。
- deepbool, 默认值=True
是否在 skbase 对象值参数(即组件估计器)中设置随机状态。
如果为 False,则仅设置
self
的random_state
参数(如果存在)。如果为 True,则也会设置组件对象中的
random_state
参数。
- self_policystr, one of {“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)[源代码]#
将实例级别标签覆盖设置为给定值。
每个与
scikit-base
兼容的对象都有一个标签字典,用于存储对象的元数据。标签是特定于实例
self
的键值对,它们是对象构建后不会更改的静态标志。它们可用于元数据检查或控制对象的行为。set_tags
将动态标签覆盖设置为tag_dict
中指定的值,其中键是标签名称,字典值是要设置的标签值。set_tags
方法应仅在对象的__init__
方法中(构建期间)或通过__init__
直接在构建后调用。当前的标签值可以通过
get_tags
或get_tag
检查。- 参数:
- **tag_dictdict
标签名称: 标签值 对的字典。
- 返回:
- Self
对 self 的引用。