FCNClassifier#
- class FCNClassifier(n_epochs=2000, batch_size=16, callbacks=None, verbose=False, loss='categorical_crossentropy', metrics=None, random_state=None, activation='sigmoid', use_bias=True, optimizer=None)[source]#
全卷积网络(FCN),如 [1] 所述。
改编自 Fawaz 等人的实现 hfawaz/dl-4-tsc
- 参数:
- 此处应列出继承的字段吗?
- n_epochs整型, 默认值 = 2000
训练模型的轮次数量
- batch_size整型, 默认值 = 16
每次梯度更新的样本数量。
- random_state整型或 None, 默认值=None
随机数生成的种子。
- verbose布尔型, 默认值 = False
是否输出额外信息
- loss字符串, 默认值=”mean_squared_error”
keras 模型的 fit 参数
- optimizerkeras.optimizer, 默认值=keras.optimizers.Adam(),
- metrics字符串列表, 默认值=[“accuracy”],
- activation字符串或 tf 可调用对象, 默认值=”sigmoid”
输出线性层中使用的激活函数。可用激活函数列表:https://keras.org.cn/api/layers/activations/
- use_bias布尔型, 默认值 = True
该层是否使用偏置向量。
- optimizerkeras.optimizers 对象, 默认值 = Adam(lr=0.01)
指定要使用的优化器和学习率。
- 属性:
is_fitted
是否已调用
fit
。
参考文献
[1]Wang 等人,从零开始的时间序列分类与
深度神经网络:一个强大的基线。2017 International Joint Conference on Neural Networks (IJCNN)
示例
>>> from sktime.classification.deep_learning.fcn import FCNClassifier >>> 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) >>> fcn = FCNClassifier(n_epochs=20,batch_size=4) >>> fcn.fit(X_train, y_train) FCNClassifier(...)
方法
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])从类中获取类标签值,并考虑从父类继承的标签级别。
从类中获取类标签,并考虑从父类继承的标签级别。
获取 self 的配置标志。
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])返回估计器的测试参数设置。
检查对象是否由其他 BaseObject 组成。
load_from_path
(serial)从文件位置加载对象。
load_from_serial
(serial)从序列化内存容器加载对象。
predict
(X)预测 X 中序列的标签。
预测 X 中序列的标签概率。
reset
()将对象重置为干净的初始化后状态。
save
([path, serialization_format])将序列化的 self 保存到字节类对象或 (.zip) 文件。
score
(X, y)根据 X 上的地面真实标签对预测标签进行评分。
set_config
(**config_dict)将配置标志设置为给定值。
set_params
(**params)设置此对象的参数。
set_random_state
([random_state, deep, ...])为 self 设置 random_state 伪随机种子参数。
set_tags
(**tag_dict)设置实例级别的标签覆盖为给定值。
summary
()摘要函数,用于返回模型拟合的损失/指标。
- build_model(input_shape, n_classes, **kwargs)[source]#
构造一个已编译、未训练、可用于训练的 keras 模型。
在 sktime 中,时间序列存储在形状为 (d,m) 的 numpy 数组中,其中 d 是维数,m 是序列长度。Keras/tensorflow 假定数据形状为 (m,d)。此方法也假定为 (m,d)。转置应该在 fit 中发生。
- 参数:
- input_shape元组
输入层的数据形状,应为 (m,d)
- n_classes: 整型
类的数量,成为输出层的大小
- 返回:
- output已编译的 Keras 模型
- classmethod get_test_params(parameter_set='default')[source]#
返回估计器的测试参数设置。
- 参数:
- parameter_set字符串, 默认值=”default”
要返回的测试参数集的名称,用于测试。如果某个值没有定义特殊参数,则将返回
"default"
集。对于分类器,应提供一组“default”参数用于一般测试,并提供一组“results_comparison”参数用于与先前记录的结果进行比较,如果一般集产生的概率不适合比较。
- 返回:
- params字典或字典列表, 默认值={}
用于创建类测试实例的参数。每个字典都是构造一个“有趣”测试实例的参数,即
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_name字符串, 可选
调用此函数的方法的名称。如果提供,错误消息将包含此信息。
- 引发:
- 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
设置动态标签覆盖。clone_tags
方法应仅在对象的__init__
方法中,在构造期间,或通过__init__
直接在构造后调用。动态标签设置为
estimator
中标签的值,名称由tag_names
指定。tag_names
的默认值是将estimator
中的所有标签写入self
。当前标签值可以通过
get_tags
或get_tag
检查。- 参数:
- estimator:class:BaseObject 或派生类的实例
- tag_names字符串或字符串列表, 默认值 = None
要克隆的标签名称。默认值 (
None
) 克隆estimator
中的所有标签。
- 返回:
- self
对
self
的引用。
- classmethod create_test_instance(parameter_set='default')[source]#
使用第一个测试参数集构造类的实例。
- 参数:
- parameter_set字符串, 默认值=”default”
要返回的测试参数集的名称,用于测试。如果某个值没有定义特殊参数,则将返回 “default” 集。
- 返回:
- instance使用默认参数的类实例
- classmethod create_test_instances_and_names(parameter_set='default')[source]#
创建所有测试实例及其名称列表。
- 参数:
- parameter_set字符串, 默认值=”default”
要返回的测试参数集的名称,用于测试。如果某个值没有定义特殊参数,则将返回 “default” 集。
- 返回:
- objscls 实例列表
第 i 个实例是
cls(**cls.get_test_params()[i])
- names字符串列表, 与 objs 长度相同
第 i 个元素是测试中第 i 个 obj 实例的名称。如果实例多于一个,命名约定为
{cls.__name__}-{i}
,否则为{cls.__name__}
- fit(X, y)[source]#
将时间序列分类器拟合到训练数据。
- 状态变化
将状态更改为“已拟合”。
- 写入 self
将 self.is_fitted 设置为 True。设置以“_”结尾的拟合模型属性。
- 参数:
- XPanel scitype 的 sktime 兼容时间序列面板数据容器
用于拟合估计器的时间序列。
可以是
Panel
scitype 的任何 mtype,例如pd-multiindex: pd.DataFrame,列为变量,索引为 pd.MultiIndex,第一层为实例索引,第二层为时间索引
numpy3D: 3D np.array(任意维数,等长序列),形状为 [n_instances, n_dimensions, series_length]
或任何其他支持的
Panel
mtype
有关 mtype 列表,请参阅
datatypes.SCITYPE_REGISTER
有关规范,请参阅
examples/AA_datatypes_and_datasets.ipynb
并非所有估计器都支持具有多元或不等长序列的面板,详见标签参考。
- 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 的引用。
- fit_predict(X, y, cv=None, change_state=True)[source]#
拟合并预测 X 中序列的标签。
方便的方法,用于生成样本内预测和交叉验证的样本外预测。
- 写入 self, 如果 change_state=True
将 self.is_fitted 设置为 True。设置以“_”结尾的拟合模型属性。
如果 change_state=False,则不更新状态。
- 参数:
- XPanel scitype 的 sktime 兼容时间序列面板数据容器
用于拟合和预测标签的时间序列。
可以是
Panel
scitype 的任何 mtype,例如pd-multiindex: pd.DataFrame,列为变量,索引为 pd.MultiIndex,第一层为实例索引,第二层为时间索引
numpy3D: 3D np.array(任意维数,等长序列),形状为 [n_instances, n_dimensions, series_length]
或任何其他支持的
Panel
mtype
有关 mtype 列表,请参阅
datatypes.SCITYPE_REGISTER
有关规范,请参阅
examples/AA_datatypes_and_datasets.ipynb
并非所有估计器都支持具有多元或不等长序列的面板,详见标签参考。
- ysktime 兼容的表格数据容器, Table scitype
1D 可迭代对象,形状为 [n_instances] 或 2D 可迭代对象,形状为 [n_instances, n_dimensions],用于拟合的类别标签,第 0 个索引对应 X 中的实例索引,第 1 个索引(如果适用)对应 X 中的多输出向量索引,支持的 sktime 类型:np.ndarray (1D, 2D), pd.Series, pd.DataFrame
- cvNone, 整型, 或 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
测试折叠必须不相交整型 : 等同于
cv=KFold(cv, shuffle=True, random_state=x)
,即 k-折交叉验证的样本外预测,其中random_state
x
取自self
(如果存在),否则x=None
- change_state布尔型, 可选 (默认值=True)
如果为 False,则不会改变分类器的状态,即 fit/predict 序列使用副本运行,self 不会改变
如果为 True,则将 self 拟合到完整的 X 和 y,结束状态将等同于运行 fit(X, y)
- 返回:
- y_predTable scitype 的 sktime 兼容表格数据容器
预测的类别标签
1D 可迭代对象,形状为 [n_instances],或 2D 可迭代对象,形状为 [n_instances, n_dimensions]。
第 0 个索引对应 X 中的实例索引,第 1 个索引(如果适用)对应 X 中的多输出向量索引。
1D np.npdarray,如果 y 是单变量(一个维度);否则,与 fit 中传入的 y 类型相同
- fit_predict_proba(X, y, cv=None, change_state=True)[source]#
拟合并预测 X 中序列的标签概率。
方便的方法,用于生成样本内预测和交叉验证的样本外预测。
- 写入 self, 如果 change_state=True
将 self.is_fitted 设置为 True。设置以“_”结尾的拟合模型属性。
如果 change_state=False,则不更新状态。
- 参数:
- XPanel scitype 的 sktime 兼容时间序列面板数据容器
用于拟合和预测标签的时间序列。
可以是
Panel
scitype 的任何 mtype,例如pd-multiindex: pd.DataFrame,列为变量,索引为 pd.MultiIndex,第一层为实例索引,第二层为时间索引
numpy3D: 3D np.array(任意维数,等长序列),形状为 [n_instances, n_dimensions, series_length]
或任何其他支持的
Panel
mtype
有关 mtype 列表,请参阅
datatypes.SCITYPE_REGISTER
有关规范,请参阅
examples/AA_datatypes_and_datasets.ipynb
并非所有估计器都支持具有多元或不等长序列的面板,详见标签参考。
- ysktime 兼容的表格数据容器, Table scitype
1D 可迭代对象,形状为 [n_instances] 或 2D 可迭代对象,形状为 [n_instances, n_dimensions],用于拟合的类别标签,第 0 个索引对应 X 中的实例索引,第 1 个索引(如果适用)对应 X 中的多输出向量索引,支持的 sktime 类型:np.ndarray (1D, 2D), pd.Series, pd.DataFrame
- cvNone, 整型, 或 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
测试折叠必须不相交整型 : 等同于
cv=KFold(cv, shuffle=True, random_state=x)
,即 k-折交叉验证的样本外预测,其中random_state
x
取自self
(如果存在),否则x=None
- change_state布尔型, 可选 (默认值=True)
如果为 False,则不会改变分类器的状态,即 fit/predict 序列使用副本运行,self 不会改变
如果为 True,则将 self 拟合到完整的 X 和 y,结束状态将等同于运行 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_name字符串
标签名称。
- 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_tags字典
标签名称:标签值对的字典。通过嵌套继承从
_tags
类属性收集。不受通过set_tags
或clone_tags
设置的动态标签的覆盖。
- get_config()[source]#
获取 self 的配置标志。
配置是
self
的键值对,通常用作控制行为的瞬时标志。get_config
返回动态配置,这些配置会覆盖默认配置。默认配置在类或其父类的类属性
_config
中设置,并由通过set_config
设置的动态配置覆盖。配置在
clone
或reset
调用下保留。- 返回:
- config_dict字典
配置名称:配置值对的字典。通过嵌套继承从 _config 类属性收集,然后应用来自 _onfig_dynamic 对象属性的任何覆盖和新标签。
- get_fitted_params(deep=True)[source]#
获取已拟合参数。
- 所需状态
要求状态为“已拟合”。
- 参数:
- deep布尔型, 默认值=True
是否返回组件的已拟合参数。
如果为 True,则返回此对象的参数名称:值字典,包括可拟合组件(= BaseEstimator 值参数)的已拟合参数。
如果为 False,则返回此对象的参数名称:值字典,但不包括组件的已拟合参数。
- 返回:
- fitted_params键为字符串的字典
已拟合参数的字典,键为 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]#
获取对象的参数名称。
- 参数:
- sort布尔型, 默认值=True
是否按字母顺序(True)或它们在类
__init__
中出现的顺序(False)返回参数名称。
- 返回:
- param_names: list[str]
cls
的参数名称列表。如果sort=False
,则按它们在类__init__
中出现的顺序排列。如果sort=True
,则按字母顺序排列。
- get_params(deep=True)[source]#
获取此对象的参数值字典。
- 参数:
- deep布尔型, 默认值=True
是否返回组件的参数。
如果
True
,则返回此对象的参数名称:值dict
,包括组件(=BaseObject
值参数)的参数。如果
False
,则返回此对象的参数名称:值dict
,但不包括组件的参数。
- 返回:
- params键为字符串的字典
参数字典,键为 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_name字符串
要检索的标签名称
- tag_value_default任意类型, 可选; 默认值=None
未找到标签时的默认/备用值
- raise_error布尔型
未找到标签时是否引发
ValueError
- 返回:
- tag_value任意类型
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_tags字典
标签名称:标签值对的字典。通过嵌套继承从
_tags
类属性收集,然后应用来自_tags_dynamic
对象属性的任何覆盖和新标签。
- is_composite()[source]#
检查对象是否由其他 BaseObject 组成。
组合对象是包含对象作为参数的对象。在实例上调用,因为这可能因实例而异。
- 返回:
- composite: 布尔型
对象是否具有任何参数,其值是
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()
历史。
- serial:
- 返回:
- 反序列化的 self,结果输出
serial
,来自cls.save(None)
- 反序列化的 self,结果输出
- predict(X)[source]#
预测 X 中序列的标签。
- 参数:
- XPanel scitype 的 sktime 兼容时间序列面板数据容器
用于预测标签的时间序列。
可以是
Panel
scitype 的任何 mtype,例如pd-multiindex: pd.DataFrame,列为变量,索引为 pd.MultiIndex,第一层为实例索引,第二层为时间索引
numpy3D: 3D np.array(任意维数,等长序列),形状为 [n_instances, n_dimensions, series_length]
或任何其他支持的
Panel
mtype
有关 mtype 列表,请参阅
datatypes.SCITYPE_REGISTER
有关规范,请参阅
examples/AA_datatypes_and_datasets.ipynb
并非所有估计器都支持具有多元或不等长序列的面板,详见标签参考。
- 返回:
- y_predTable scitype 的 sktime 兼容表格数据容器
预测的类别标签
1D 可迭代对象,形状为 [n_instances],或 2D 可迭代对象,形状为 [n_instances, n_dimensions]。
第 0 个索引对应 X 中的实例索引,第 1 个索引(如果适用)对应 X 中的多输出向量索引。
1D np.npdarray,如果 y 是单变量(一个维度);否则,与 fit 中传入的 y 类型相同
- predict_proba(X)[source]#
预测 X 中序列的标签概率。
- 参数:
- XPanel scitype 的 sktime 兼容时间序列面板数据容器
用于预测标签的时间序列。
可以是
Panel
scitype 的任何 mtype,例如pd-multiindex: pd.DataFrame,列为变量,索引为 pd.MultiIndex,第一层为实例索引,第二层为时间索引
numpy3D: 3D np.array(任意维数,等长序列),形状为 [n_instances, n_dimensions, series_length]
或任何其他支持的
Panel
mtype
有关 mtype 列表,请参阅
datatypes.SCITYPE_REGISTER
有关规范,请参阅
examples/AA_datatypes_and_datasets.ipynb
并非所有估计器都支持具有多元或不等长序列的面板,详见标签参考。
- 返回:
- y_pred形状为 [n_instances, n_classes] 的 2D np.array 整型
预测的类别标签概率,第 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]#
将序列化的 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” 则会在当前工作目录创建一个名为
estimator.zip
的 zip 文件。path=”/home/stored/estimator” 则会在/home/stored/
中存储一个名为estimator.zip
的 zip 文件。- serialization_formatstr, 默认 = “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.DataFrame,列为变量,索引为 pd.MultiIndex,第一层为实例索引,第二层为时间索引
numpy3D: 3D np.array(任意维数,等长序列),形状为 [n_instances, n_dimensions, series_length]
或任何其他支持的
Panel
mtype
有关 mtype 列表,请参阅
datatypes.SCITYPE_REGISTER
有关规范,请参阅
examples/AA_datatypes_and_datasets.ipynb
并非所有估计器都支持具有多元或不等长序列的面板,详见标签参考。
- ysktime 兼容的表格数据容器, Table scitype
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_dict字典
配置名称 : 配置值对的字典。下方列出了有效的配置、值及其含义
- displaystr, “diagram” (默认), 或 “text”
jupyter 内核如何显示 self 的实例
“diagram” = html 框图表示
“text” = 字符串打印输出
- print_changed_onlybool, 默认=True
打印 self 时,是否只列出与默认值不同的 self 参数 (False),或所有参数名称和值 (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”; 要使用的日志记录器的名称。
- “shutdown_ray”: bool, 默认=True; False 防止
“mute_warnings”: bool, 默认=False; 如果为 True,则抑制警告。
self指向 self 的引用。
- 返回:
- 说明
改变对象状态,将 config_dict 中的配置复制到 self._config_dynamic。
-
此方法适用于简单的 skbase 对象以及复合对象。参数键字符串
<component>__<parameter>
可用于复合对象(即包含其他对象的对象),以访问组件<component>
中的<parameter>
。如果引用明确(例如,没有两个组件参数具有相同的名称<parameter>
),也可以使用字符串<parameter>
,而不带<component>__
。 设置此对象的参数。
**paramsdict
-
通过
self.get_params
查找名为random_state
的参数,并使用set_params
将它们设置为从random_state
通过sample_dependent_seed
进行链式哈希派生的整数。这些整数保证了伪随机生成器的伪随机独立性。 为 self 设置 random_state 伪随机种子参数。
根据
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 可在多次函数调用中获得可复现的输出。
是否在 skbase 对象值参数(即组件估计器)中设置随机状态。
- deep布尔型, 默认值=True
如果为 False,则仅设置
self
的random_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 的引用
- 返回:
-
标签是特定于实例
self
的键值对,它们是静态标志,在对象构造后不会更改。它们可用于元数据检查或控制对象的行为。 设置实例级别的标签覆盖为给定值。
每个
scikit-base
兼容对象都有一个标签字典,用于存储有关对象的元数据。set_tags
将动态标签覆盖设置为tag_dict
中指定的值,其中键是标签名称,字典值是要设置的标签值。set_tags
方法应仅在对象的__init__
方法中(构造期间)或直接在__init__
构造后调用。**tag_dictdict
当前标签值可以通过
get_tags
或get_tag
检查。
- history: dict 或 None,
摘要函数,用于返回模型拟合的损失/指标。
- 返回:
- 包含模型训练/验证损失和指标的字典
本页内容