GRUFCNNClassifier#
- 类 GRUFCNNClassifier(hidden_dim: int, gru_layers: int, batch_first: bool = False, bias: bool = True, init_weights: bool = True, dropout: float = 0.0, gru_dropout: float = 0.0, bidirectional: bool = False, conv_layers: list = [128, 256, 128], kernel_sizes: list = [7, 5, 3], num_epochs: int = 10, batch_size: int = 8, optimizer: str = 'Adam', criterion: str = None, criterion_kwargs: dict = None, optimizer_kwargs: dict = None, lr: float = 0.01, verbose: bool = False, random_state: int = None)[source]#
用于时间序列分类的 GRU-FCN。
此分类器中使用的网络最初在 [1] 中定义。当前实现使用 PyTorch 并参考了 [2] 和 [3] 中的 TensorFlow 实现。
- 参数:
- hidden_dimint
隐藏状态的特征数量。
- gru_layersint
循环层数。
- batch_firstbool
如果为 True,则输入和输出张量以 (batch, seq, feature) 形式提供,默认为 False。
- biasbool
如果为 False,则该层不使用偏置权重,默认为 True。
- init_weightsbool
如果为 True,则初始化权重,默认为 True。
- dropoutfloat
应用于 gru cell 内部的 dropout 率。默认为 0.0
- gru_dropoutfloat
应用于 gru 输出层的 dropout 率。默认为 0.0
- bidirectionalbool
如果为 True,则 GRU 为双向,默认为 False。
- conv_layerslist
指定每个卷积层中滤波器数量的整数列表。默认为 [128, 256, 128]。
- kernel_sizeslist
指定每个卷积层中核大小的整数列表。默认为 [7, 5, 3]。
- num_epochsint, optional (default=10)
训练模型的 epoch 数量。
- optimizerstr, optional (default=None)
要使用的优化器。如果为 None,将使用 Adam。
- activationstr, optional (default=”relu”)
要使用的激活函数。选项:[“relu”, “softmax”]。
- batch_sizeint, optional (default=8)
训练期间每个 mini-batch 的大小。
- criterioncallable, optional (default=None)
要使用的损失函数。如果为 None,将使用 CrossEntropyLoss。
- criterion_kwargsdict, optional (default=None)
传递给损失函数的额外关键字参数。
- optimizer_kwargsdict, optional (default=None)
传递给优化器的额外关键字参数。
- lrfloat, optional (default=0.001)
用于优化器的学习率。
- verbosebool, optional (default=False)
训练期间是否打印进度信息。
- random_stateint, optional (default=None)
确保可重现性的种子。
- 属性:
is_fitted
是否已调用
fit
。
参考文献
[1]Elsayed 等人。《用于单变量时间序列分类的深度门控循环和卷积网络混合模型》,arXiv 预印本 arXiv:1812.07683 (2018)。
方法
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])返回估计器的测试参数设置。
检查对象是否由其他 BaseObjects 组成。
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)将实例级标签覆盖设置为给定值。
- classmethod get_test_params(parameter_set='default')[source]#
返回估计器的测试参数设置。
- 参数:
- parameter_setstr, default=”default”
要返回的测试参数集的名称,用于测试。如果某个值没有定义特殊参数,将返回
"default"
集。分类器的保留值- “results_comparison” - 用于某些分类器中的身份测试
应包含与“TSC bakeoff”相当的参数设置
- 返回:
- paramsdict or list of dict, default = {}
用于创建类测试实例的参数。每个字典都是构造“有趣”测试实例的参数,即
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, optional
调用此函数的方法的名称。如果提供,错误消息将包含此信息。
- 引发:
- 未拟合错误
如果估计器尚未拟合。
- 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
兼容的对象都有一个标签字典。标签可用于存储对象的元数据,或控制对象的行为。通过
clone_tags
从另一个对象estimator
设置动态标签覆盖。clone_tags
方法应仅在对象的__init__
方法中调用,即在构造期间,或通过__init__
构造后立即调用。动态标签被设置为
estimator
中由tag_names
指定名称的标签值。tag_names
的默认值将estimator
中的所有标签写入self
。当前标签值可以通过
get_tags
或get_tag
检查。estimator:class:BaseObject 或派生类的实例。
- 要返回的测试参数集的名称,用于测试。如果某个值没有定义特殊参数,将返回 “default” 集。
使用第一个测试参数集构造类的实例。
- objscls 实例列表
创建所有测试实例列表及其名称列表。
- 状态变化
将时间序列分类器拟合到训练数据。
- 将状态更改为“fitted”(已拟合)。
写入 self
- 将 self.is_fitted 设置为 True。设置以“_”结尾的拟合模型属性。
Xsktime 兼容的时间序列面板数据容器,属于 Panel 科学类型。
- 参数:
- 要拟合估计器的时间序列。
-
pd-multiindex: pd.DataFrame,列为变量,索引为 pd.MultiIndex,第一级为实例索引,第二级为时间索引
numpy3D: 3D np.array(任意维度,等长序列),形状为 [n_instances, n_dimensions, series_length]
或任何其他支持的
Panel
mtype有关 mtypes 列表,请参阅
datatypes.SCITYPE_REGISTER
有关规范,请参阅
examples/AA_datatypes_and_datasets.ipynb
并非所有估计器都支持多变量或不等长序列的面板,详细信息请参阅标签参考。
ysktime 兼容的表格数据容器,属于 Table 科学类型。
- 1D 可迭代对象,形状为 [n_instances],或 2D 可迭代对象,形状为 [n_instances, n_dimensions]。用于拟合的类别标签,第 0 个索引对应于 X 中的实例索引,第 1 个索引(如果适用)对应于 X 中的多输出向量索引。支持的 sktime 类型:np.ndarray (1D, 2D), pd.Series, pd.DataFrame
self对 self 的引用。
- 返回:
- 用于生成样本内预测和交叉验证的样本外预测的便捷方法。
拟合并预测 X 中序列的标签。
写入 self,如果 change_state=True
- 如果 change_state=False,则不更新状态。
Xsktime 兼容的时间序列面板数据容器,属于 Panel 科学类型。
要拟合和预测标签的时间序列。
- 参数:
- 要拟合估计器的时间序列。
cvNone, int, 或 sklearn 交叉验证对象,可选,默认为 None
pd-multiindex: pd.DataFrame,列为变量,索引为 pd.MultiIndex,第一级为实例索引,第二级为时间索引
numpy3D: 3D np.array(任意维度,等长序列),形状为 [n_instances, n_dimensions, series_length]
或任何其他支持的
Panel
mtype有关 mtypes 列表,请参阅
datatypes.SCITYPE_REGISTER
有关规范,请参阅
examples/AA_datatypes_and_datasets.ipynb
并非所有估计器都支持多变量或不等长序列的面板,详细信息请参阅标签参考。
ysktime 兼容的表格数据容器,属于 Table 科学类型。
- 1D 可迭代对象,形状为 [n_instances],或 2D 可迭代对象,形状为 [n_instances, n_dimensions]。用于拟合的类别标签,第 0 个索引对应于 X 中的实例索引,第 1 个索引(如果适用)对应于 X 中的多输出向量索引。支持的 sktime 类型:np.ndarray (1D, 2D), pd.Series, pd.DataFrame
self对 self 的引用。
- None : 预测是样本内的,等同于
fit(X, y).predict(X)
cv : 预测等同于
fit(X_train, y_train).predict(X_test)
,其中从cv
折叠中获取多个X_train
,y_train
,X_test
。返回的y
是所有测试折叠预测的并集,cv
测试折叠必须不相交int : 等同于
cv=KFold(cv, shuffle=True, random_state=x)
,即 k 折交叉验证的样本外预测,其中random_state
x
取自self
(如果存在),否则x=None
change_statebool, optional (default=True)
- 如果为 False,将不会更改分类器的状态,即拟合/预测序列使用副本运行,self 不变
如果为 True,将 self 拟合到完整的 X 和 y,最终状态将等同于运行 fit(X, y)
y_predsktime 兼容的表格数据容器,属于 Table 科学类型
- 返回:
- y_pred2D np.array,整数类型,形状为 [n_instances, n_classes]
拟合并预测 X 中序列的标签概率。
写入 self,如果 change_state=True
- 如果 change_state=False,则不更新状态。
Xsktime 兼容的时间序列面板数据容器,属于 Panel 科学类型。
要拟合和预测标签的时间序列。
- 参数:
- 要拟合估计器的时间序列。
cvNone, int, 或 sklearn 交叉验证对象,可选,默认为 None
pd-multiindex: pd.DataFrame,列为变量,索引为 pd.MultiIndex,第一级为实例索引,第二级为时间索引
numpy3D: 3D np.array(任意维度,等长序列),形状为 [n_instances, n_dimensions, series_length]
或任何其他支持的
Panel
mtype有关 mtypes 列表,请参阅
datatypes.SCITYPE_REGISTER
有关规范,请参阅
examples/AA_datatypes_and_datasets.ipynb
并非所有估计器都支持多变量或不等长序列的面板,详细信息请参阅标签参考。
ysktime 兼容的表格数据容器,属于 Table 科学类型。
- 1D 可迭代对象,形状为 [n_instances],或 2D 可迭代对象,形状为 [n_instances, n_dimensions]。用于拟合的类别标签,第 0 个索引对应于 X 中的实例索引,第 1 个索引(如果适用)对应于 X 中的多输出向量索引。支持的 sktime 类型:np.ndarray (1D, 2D), pd.Series, pd.DataFrame
self对 self 的引用。
- None : 预测是样本内的,等同于
fit(X, y).predict(X)
cv : 预测等同于
fit(X_train, y_train).predict(X_test)
,其中从cv
折叠中获取多个X_train
,y_train
,X_test
。返回的y
是所有测试折叠预测的并集,cv
测试折叠必须不相交int : 等同于
cv=KFold(cv, shuffle=True, random_state=x)
,即 k 折交叉验证的样本外预测,其中random_state
x
取自self
(如果存在),否则x=None
change_statebool, optional (default=True)
- 如果为 False,将不会更改分类器的状态,即拟合/预测序列使用副本运行,self 不变
如果为 True,将 self 拟合到完整的 X 和 y,最终状态将等同于运行 fit(X, y)
y_predsktime 兼容的表格数据容器,属于 Table 科学类型
- 返回:
- 预测的类标签概率。第 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
标签值名称。
-
它返回一个字典,其键是类或其任何父类中设置的
_tags
属性的任何键。 从类中获取类标签,带标签级别继承自父类。
每个与
scikit-base
兼容的对象都有一个标签字典。标签可用于存储对象的元数据,或控制对象的行为。通过
clone_tags
从另一个对象estimator
设置动态标签覆盖。值是相应的标签值,覆盖优先级顺序如下(优先级递减):
实例可以根据超参数覆盖这些标签。
要检索可能包含实例覆盖的标签,请改用
get_tags
方法。在父类的
_tags
属性中按继承顺序设置的标签,不考虑在实例上设置的动态标签覆盖,例如通过
set_tags
或clone_tags
在实例上定义的覆盖。
要检索可能包含实例覆盖的标签值,请改用
get_tag
方法。要包含动态标签的覆盖,请使用
get_tags
。collected_tagsdict
tag_namestr
标签名称 : 标签值 对的字典。通过嵌套继承从
_tags
类属性收集。不被通过set_tags
或clone_tags
设置的动态标签覆盖。
-
get_config
返回动态配置,这些配置会覆盖默认配置。 获取 self 的配置标志。
默认配置在类或其父类的类属性
_config
中设置,并通过set_config
设置的动态配置覆盖。配置在
clone
或reset
调用时保留。config_dictdict
配置名称 : 配置值 对的字典。通过嵌套继承从 _config 类属性收集,然后通过 _onfig_dynamic 对象属性的任何覆盖和新标签覆盖。
- 需要状态为“fitted”(已拟合)。
获取拟合参数。
- deepbool, default=True
是否返回组件的拟合参数。
- 参数:
- 如果为 True,将返回此对象的参数名称 : 值字典,包括可拟合组件(= BaseEstimator 值参数)的拟合参数。
如果为 False,将返回此对象的参数名称 : 值字典,但不包括组件的拟合参数。
fitted_params键为字符串的拟合参数字典。
参数名称 : 参数值 键值对包括
- 返回:
- 始终:此对象的所有拟合参数,如通过
get_param_names
获取的。值为此对象该键的拟合参数值。 如果
deep=True
,还包含组件参数的键/值对。组件的参数以[componentname]__[paramname]
为索引。componentname
的所有参数都以paramname
的形式出现,带有其值。
- 始终:此对象的所有拟合参数,如通过
- default_dict: dict[str, Any]
键是
cls
的所有在__init__
中定义了默认值的参数。值是__init__
中定义的默认值。
- sortbool, default=True
是否按字母顺序(True)或在类的
__init__
中出现的顺序(False)返回参数名称。
-
如果为
True
,将返回此对象的参数名称 : 值字典,包括组件(=BaseObject
值参数)的参数。 获取此对象的参数值字典。
- 参数:
- 如果为 True,将返回此对象的参数名称 : 值字典,包括可拟合组件(= BaseEstimator 值参数)的拟合参数。
如果为
False
,将返回此对象的参数名称 : 值字典,但不包括组件的参数。params键为字符串的参数字典。
参数名称 : 参数值 键值对包括
- 返回:
-
在实例上通过
set_tags
或clone_tags
设置的标签, 从实例中获取标签值,带标签级别继承和覆盖。
每个与
scikit-base
兼容的对象都有一个标签字典。标签可用于存储对象的元数据,或控制对象的行为。通过
clone_tags
从另一个对象estimator
设置动态标签覆盖。即在实例构造时设置的。
要检索的标签名称
tag_value_default任意类型,可选;默认为 None
在父类的
_tags
属性中按继承顺序设置的标签,不考虑在实例上设置的动态标签覆盖,例如通过
set_tags
或clone_tags
在实例上定义的覆盖。
要检索可能包含实例覆盖的标签值,请改用
get_tag
方法。- 参数:
- tag_value_defaultany type
如果未找到标签,则为默认/回退值
- 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
兼容的对象都有一个标签字典。标签可用于存储对象的元数据,或控制对象的行为。通过
clone_tags
从另一个对象estimator
设置动态标签覆盖。get_tags
方法返回一个标签字典,其中键是类或其任何父类中设置的任何_tags
属性的键,或是通过set_tags
或clone_tags
设置的标签。要检索可能包含实例覆盖的标签,请改用
get_tags
方法。要检索的标签名称
tag_value_default任意类型,可选;默认为 None
在父类的
_tags
属性中按继承顺序设置的标签,不考虑在实例上设置的动态标签覆盖,例如通过
set_tags
或clone_tags
在实例上定义的覆盖。
要检索可能包含实例覆盖的标签值,请改用
get_tag
方法。- 返回:
- 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]#
从文件位置加载对象。
- 参数:
- serialZipFile(path).open(“object”) 的结果
- 返回:
- 反序列化的 self,其结果是
cls.save(path)
在path
位置产生的输出
- 反序列化的 self,其结果是
- classmethod load_from_serial(serial)[source]#
从序列化内存容器加载对象。
- 参数:
- serial
cls.save(None)
输出的第一个元素
- serial
- 返回:
- 反序列化的 self,其结果是
cls.save(None)
产生的输出serial
- 反序列化的 self,其结果是
- predict(X)[source]#
预测 X 中序列的标签。
- 参数:
- 要拟合估计器的时间序列。
用于预测标签的时间序列。
pd-multiindex: pd.DataFrame,列为变量,索引为 pd.MultiIndex,第一级为实例索引,第二级为时间索引
numpy3D: 3D np.array(任意维度,等长序列),形状为 [n_instances, n_dimensions, series_length]
或任何其他支持的
Panel
mtype有关 mtypes 列表,请参阅
datatypes.SCITYPE_REGISTER
有关规范,请参阅
examples/AA_datatypes_and_datasets.ipynb
并非所有估计器都支持多变量或不等长序列的面板,详细信息请参阅标签参考。
ysktime 兼容的表格数据容器,属于 Table 科学类型。
- 返回:
- predict_proba(X)[source]#
预测 X 中序列的标签概率。
- 参数:
- 要拟合估计器的时间序列。
用于预测标签的时间序列。
pd-multiindex: pd.DataFrame,列为变量,索引为 pd.MultiIndex,第一级为实例索引,第二级为时间索引
numpy3D: 3D np.array(任意维度,等长序列),形状为 [n_instances, n_dimensions, series_length]
或任何其他支持的
Panel
mtype有关 mtypes 列表,请参阅
datatypes.SCITYPE_REGISTER
有关规范,请参阅
examples/AA_datatypes_and_datasets.ipynb
并非所有估计器都支持多变量或不等长序列的面板,详细信息请参阅标签参考。
ysktime 兼容的表格数据容器,属于 Table 科学类型。
- 返回:
- 预测的类标签概率。第 0 个索引对应于 X 中的实例索引,第 1 个索引对应于类索引,顺序与 self.classes_ 中的条目相同。条目为预测的类概率,总和为 1
预测的类别标签概率 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]#
将序列化的 self 保存到字节类对象或 (.zip) 文件。
行为:如果
path
为 None,则返回内存中的序列化 self;如果path
是文件位置,则将 self 作为 zip 文件存储在该位置保存的文件是包含以下内容的 zip 文件:_metadata - 包含 self 的类,即 type(self) _obj - 序列化的 self。此类使用默认的序列化方式 (pickle)。
- 参数:
- pathNone 或 文件位置 (str 或 Path)
如果为 None,则将 self 保存到内存对象 如果是文件位置,则将 self 保存到该文件位置。如果
path=”estimator” 则将在 cwd 中创建一个名为
estimator.zip
的 zip 文件。path=”/home/stored/estimator” 则将创建一个名为
estimator.zip
的 zip 文件
存储在
/home/stored/
中。- serialization_format: str, default = “pickle”
用于序列化的模块。可用选项有 “pickle” 和 “cloudpickle”。请注意,非默认格式可能需要安装其他软依赖项。
- 返回:
- 如果
path
为 None - 内存中的序列化 self - 如果
path
是文件位置 - 引用该文件的 ZipFile
- 如果
- score(X, y) float [source]#
在 X 上根据真实标签对预测标签评分。
- 参数:
- 要拟合估计器的时间序列。
用于预测标签的时间序列,以计算分数。
pd-multiindex: pd.DataFrame,列为变量,索引为 pd.MultiIndex,第一级为实例索引,第二级为时间索引
numpy3D: 3D np.array(任意维度,等长序列),形状为 [n_instances, n_dimensions, series_length]
或任何其他支持的
Panel
mtype有关 mtypes 列表,请参阅
datatypes.SCITYPE_REGISTER
有关规范,请参阅
examples/AA_datatypes_and_datasets.ipynb
并非所有估计器都支持多变量或不等长序列的面板,详细信息请参阅标签参考。
ysktime 兼容的表格数据容器,属于 Table 科学类型。
- 1D 可迭代对象,形状为 [n_instances],或 2D 可迭代对象,形状为 [n_instances, n_dimensions]。用于拟合的类别标签,第 0 个索引对应于 X 中的实例索引,第 1 个索引(如果适用)对应于 X 中的多输出向量索引。支持的 sktime 类型:np.ndarray (1D, 2D), pd.Series, pd.DataFrame
self对 self 的引用。
- 返回:
- float,predict(X) 相对于 y 的准确率分数
- set_config(**config_dict)[source]#
将配置标志设置为给定值。
- 参数:
- get_fitted_params(deep=True)[source]#
配置名称 : 配置值 对的字典。有效的配置、值及其含义如下所示
- displaystr, “diagram” (默认), 或 “text”
jupyter kernel 如何显示 self 的实例
“diagram” = html 框图表示
“text” = 字符串打印输出
- print_changed_onlybool, default=True
打印 self 时是否仅列出与默认值不同的 self 参数 (False),或者列出所有参数名称和值 (False)。不嵌套,即仅影响 self,不影响组件估计器。
- warningsstr, “on” (默认), 或 “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”:bool,默认=True;False 阻止
ray
在并行化后 关闭。
- “shutdown_ray”:bool,默认=True;False 阻止
“logger_name”:str,默认=“ray”;要使用的日志记录器的名称。
“mute_warnings”:bool,默认=False;如果为 True,则抑制警告
- 返回:
- self对 self 的引用。
注意
改变对象状态,将 config_dict 中的配置复制到 self._config_dynamic。
- set_params(**params)[source]#
设置此对象的参数。
该方法适用于简单的 skbase 对象以及复合对象。参数键字符串
<component>__<parameter>
可用于复合对象,即包含其他对象的对象,以访问组件<component>
中的<parameter>
。如果这种引用是明确的(例如,没有两个组件参数具有相同的名称<parameter>
),则也可以使用字符串<parameter>
,而不带<component>__
前缀。- 参数:
- **paramsdict
BaseObject 参数,键必须是
<component>__<parameter>
字符串。__
后缀可以作为完整字符串的别名,如果在 get_params 键中是唯一的。
- 返回:
- self对 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, default=None
伪随机数生成器,用于控制随机整数的生成。传递 int 以在多次函数调用中获得可重现的输出。
- 如果为 True,将返回此对象的参数名称 : 值字典,包括可拟合组件(= BaseEstimator 值参数)的拟合参数。
deep: bool, 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]#
将实例级标签覆盖设置为给定值。
get_class_tag
方法是一个类方法,仅考虑类级别的标签值和覆盖来检索标签的值。标签是特定于实例
self
的键值对,它们是构建对象后不会更改的静态标志。它们可用于元数据检查,或控制对象的行为。set_tags
将动态标签覆盖设置为tag_dict
中指定的值,其中键是标签名称,字典值是要设置的标签值。set_tags
方法应仅在对象的__init__
方法中(构造期间)或通过__init__
直接在构造后调用。estimator:class:BaseObject 或派生类的实例。
- 参数:
- **tag_dictdict
标签名称: 标签值 对的字典。
- 返回:
- Self
对 self 的引用。