TimeSeriesSVCTslearn#
- class TimeSeriesSVCTslearn(C=1.0, kernel='gak', degree=3, gamma='auto', coef0=0.0, shrinking=True, probability=False, tol=0.001, cache_size=200, class_weight=None, n_jobs=None, verbose=0, max_iter=-1, decision_function_shape='ovr', random_state=None)[source]#
时间序列支持向量分类器,来自 tslearn。
直接接口到
tslearn.svm.svm.TimeSeriesSVC。- 参数:
- Cfloat,可选(默认=1.0)
误差项的惩罚参数 C。
- kernelstring,可选(默认='gak')
指定算法中使用的核类型。它必须是“gak”或
sklearn.svm.SVC接受的核之一。如果未给出,将使用“gak”。如果给出了一个可调用对象,则它用于从数据矩阵预计算核矩阵;该矩阵应为形状(n_samples, n_samples)的数组。- degreeint,可选(默认=3)
多项式核函数 ('poly') 的次数。所有其他核都会忽略此参数。
- gammafloat,可选(默认='auto')
'gak'、'rbf'、'poly' 和 'sigmoid' 的核系数。如果 gamma 为 'auto',则
对于 'gak' 核,它是根据训练集的采样
tslearn.metrics.gamma_soft_dtw计算的对于其他核(例如 'rbf'),将使用 1/n_features。
- coef0float,可选(默认=0.0)
核函数中的独立项。仅在 'poly' 和 'sigmoid' 中有意义。
- shrinkingboolean,可选(默认=True)
是否使用收缩启发式算法。
- probabilityboolean,可选(默认=False)
是否启用概率估计。必须在调用
fit之前启用此选项,这将减慢该方法。此外,概率估计不保证与预测输出匹配。有关更多详细信息,请参阅我们的专门用户指南章节。- tolfloat,可选(默认=1e-3)
停止标准的容差。
- cache_sizefloat,可选(默认=200.0)
指定核缓存的大小(以 MB 为单位)。
- class_weight{dict, ‘balanced’},可选
将 SVC 的类别 i 的参数 C 设置为 class_weight[i]*C。如果未给出,则所有类别都被假定具有权重一。“balanced”模式使用 y 的值自动调整权重,使其与输入数据中类别的频率成反比,计算方法为
n_samples / (n_classes * np.bincount(y))- n_jobsint 或 None,可选(默认=None)
用于 GAK 交叉相似度矩阵计算的并行运行作业数。
None表示 1,除非在joblib.parallel_backend环境中。-1表示使用所有处理器。有关更多详细信息,请参阅 scikit-learn 的术语表。- verboseint,默认值:0
启用详细输出。请注意,此设置利用了 libsvm 中每个进程的运行时设置,如果启用,在多线程环境中可能无法正常工作。
- max_iterint,可选(默认=-1)
求解器内迭代的硬限制,或 -1 表示无限制。
- decision_function_shape‘ovo’,‘ovr’,默认值='ovr'
是返回与其他所有分类器一样形状为 (n_samples, n_classes) 的 one-vs-rest ('ovr') 决策函数,还是返回 libsvm 原始的形状为 (n_samples, n_classes * (n_classes - 1) / 2) 的 one-vs-one ('ovo') 决策函数。
- random_stateint,RandomState 实例或 None,可选(默认=None)
用于洗牌数据的伪随机数生成器的种子。如果为 int,则 random_state 是随机数生成器使用的种子;如果为 RandomState 实例,则 random_state 是随机数生成器;如果为 None,则随机数生成器是
np.random使用的 RandomState 实例。
- 属性:
- support_类数组,形状 = [n_SV]
支持向量的索引。
- n_support_类数组,dtype=int32,形状 = [n_class]
每个类别的支持向量数量。
- support_vectors_形状为 [n_SV, sz, d] 的数组列表
tslearn 数据集格式的支持向量列表,每个类别一个数组
- dual_coef_数组,形状 = [n_class-1, n_SV]
决策函数中支持向量的系数。对于多类别,所有 1 对 1 分类器的系数。多类别情况下系数的布局有点复杂。有关详细信息,请参阅
sklearn用户指南 SVM 部分中关于多类别分类的章节。- coef_数组,形状 = [n_class-1, n_features]
赋予特征的权重(原始问题中的系数)。仅在线性核情况下可用。
coef_是从dual_coef_和support_vectors_派生的只读属性。- intercept_数组,形状 = [n_class * (n_class-1) / 2]
决策函数中的常数。
- svm_estimator_sklearn.svm.SVC
底层的 sklearn 估计器
方法
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])返回估计器的测试参数设置。
检查对象是否由其他 BaseObject 组成。
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)将实例级别标签覆盖设置为给定值。
- classmethod get_test_params(parameter_set='default')[source]#
返回估计器的测试参数设置。
- 参数:
- parameter_setstr,默认值=“default”
要返回的测试参数集名称,用于测试。如果未为值定义特殊参数,将返回
"default"集。
- 返回:
- 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的对象都有一个标签字典。标签可用于存储对象的元数据,或控制对象的行为。clone_tags从另一个对象estimator设置动态标签覆盖。clone_tags方法只能在对象的__init__方法中调用,在构建期间,或者通过__init__直接在构建之后调用。动态标签被设置为
estimator中标签的值,其名称在tag_names中指定。tag_names的默认行为是将estimator中的所有标签写入到self中。可以通过
get_tags或get_tag检查当前标签值。estimator:class:BaseObject 或派生类的实例
-
要返回的测试参数集名称,用于测试。如果未为值定义特殊参数,将返回
“default”集。 使用第一个测试参数集构建类的实例。
- objscls 实例列表
创建所有测试实例列表及其名称列表。
- 状态改变
将时间序列分类器拟合到训练数据。
- 将状态改为“已拟合”。
写入自身
- 将 self.is_fitted 设置为 True。设置以“_”结尾的拟合模型属性。
Xsktime 兼容的时间序列面板数据容器,Panel scitype
- 参数:
- 用于拟合估计器的时间序列。
可以是
Panelscitype 的任何 mtype,例如pd-multiindex:pd.DataFrame,列 = 变量,索引 = pd.MultiIndex,第一级 = 实例索引,第二级 = 时间索引
numpy3D:形状为 [n_instances, n_dimensions, series_length] 的 3D np.array(任意维数,等长序列)
或任何其他支持的
Panelmtype有关 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 中序列的标签。
用于生成样本内预测和交叉验证的样本外预测的便捷方法。
- 如果 change_state=True,则写入自身。
Xsktime 兼容的时间序列面板数据容器,Panel scitype
如果 change_state=False,则不更新状态。
- 参数:
- 用于拟合估计器的时间序列。
用于拟合和预测标签的时间序列。
pd-multiindex:pd.DataFrame,列 = 变量,索引 = pd.MultiIndex,第一级 = 实例索引,第二级 = 时间索引
numpy3D:形状为 [n_instances, n_dimensions, series_length] 的 3D np.array(任意维数,等长序列)
或任何其他支持的
Panelmtype有关 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对自身的引用。
- 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折叠(folds)获得。返回的y是所有测试折叠预测的并集,cv测试折叠必须互不相交。int:等同于
cv=KFold(cv, shuffle=True, random_state=x),即 K 折交叉验证的样本外预测,其中random_statex如果存在则取自self,否则x=None。
- change_statebool,可选 (默认=True)
如果为 False,则不会改变分类器的状态,即 fit/predict 序列是使用一个副本运行的,self 不会改变。
如果为 True,则将 self 拟合到完整的 X 和 y 上,最终状态将等同于运行 fit(X, y)。
- 返回:
- y_predsktime 兼容的表格数据容器,科学类型 (scitype) 为 Table
预测的类别标签
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,则写入自身。
Xsktime 兼容的时间序列面板数据容器,Panel scitype
如果 change_state=False,则不更新状态。
- 参数:
- 用于拟合估计器的时间序列。
用于拟合和预测标签的时间序列。
pd-multiindex:pd.DataFrame,列 = 变量,索引 = pd.MultiIndex,第一级 = 实例索引,第二级 = 时间索引
numpy3D:形状为 [n_instances, n_dimensions, series_length] 的 3D np.array(任意维数,等长序列)
或任何其他支持的
Panelmtype有关 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对自身的引用。
- 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折叠(folds)获得。返回的y是所有测试折叠预测的并集,cv测试折叠必须互不相交。int:等同于
cv=KFold(cv, shuffle=True, random_state=x),即 K 折交叉验证的样本外预测,其中random_statex如果存在则取自self,否则x=None。
- change_statebool,可选 (默认=True)
如果为 False,则不会改变分类器的状态,即 fit/predict 序列是使用一个副本运行的,self 不会改变。
如果为 True,则将 self 拟合到完整的 X 和 y 上,最终状态将等同于运行 fit(X, y)。
- 返回:
- y_pred2D np.array of 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方法是一个类方法,它仅考虑类级别的标签值和覆盖(overrides)来检索标签的值。它从对象中返回名称为
tag_name的标签的值,考虑标签覆盖,优先级按降序排列如下:在类的
_tags属性中设置的标签。在父类的
_tags属性中设置的标签,
按照继承顺序。
不考虑通过
set_tags或clone_tags在实例上设置的动态标签覆盖,这些覆盖定义在实例上。要检索具有潜在实例覆盖的标签值,请改用
get_tag方法。- 参数:
- tag_namestr
标签值的名称。
- tag_value_defaultany type
如果找不到标签时的默认/备用值。
- 返回:
- tag_value
self中名称为tag_name的标签的值。如果找不到,则返回tag_value_default。
- classmethod get_class_tags()[source]#
从类中获取类标签,并从父类继承标签级别。
每个兼容
scikit-base的对象都有一个标签字典。标签可用于存储对象的元数据,或控制对象的行为。clone_tags从另一个对象estimator设置动态标签覆盖。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
是否返回组件的 fitted parameters。
如果为 True,将返回此对象的参数名称:值的字典,包括可拟合组件(即 BaseEstimator 类型的参数)的 fitted parameters。
如果为 False,将返回此对象的参数名称:值的字典,但不包括组件的 fitted parameters。
- 返回:
- fitted_paramsdict with str-valued keys
Fitted parameters 字典,键值对 paramname : paramvalue 包括:
始终包含:此对象的所有 fitted parameters,通过
get_param_names获取,值为此对象该键的 fitted parameter 值。如果
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,但不包括组件的参数。
- 返回:
- 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的对象都有一个标签字典。标签可用于存储对象的元数据,或控制对象的行为。clone_tags从另一个对象estimator设置动态标签覆盖。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的对象都有一个标签字典。标签可用于存储对象的元数据,或控制对象的行为。clone_tags从另一个对象estimator设置动态标签覆盖。get_tags方法返回一个标签字典,其键是类或其任何父类中设置的任何_tags属性的键,或通过set_tags或clone_tags设置的标签的键。值是对应的标签值,覆盖优先级按降序排列如下:
通过
set_tags或clone_tags在实例上设置的标签,
在实例构造时设置的标签。
在类的
_tags属性中设置的标签。在父类的
_tags属性中设置的标签,
按照继承顺序。
- 返回:
- collected_tagsdict
标签名称:标签值对的字典。通过嵌套继承从
_tags类属性收集,然后是来自_tags_dynamic对象属性的任何覆盖和新标签。
- is_composite()[source]#
检查对象是否由其他 BaseObject 组成。
复合对象是包含其他对象作为参数的对象。在实例上调用,因为这可能因实例而异。
- 返回:
- 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)输出的第 1 个元素
- serial
- 返回:
- 反序列化的 self,结果是
cls.save(None)的输出serial。
- 反序列化的 self,结果是
- predict(X)[source]#
预测 X 中序列的标签。
- 参数:
- 用于拟合估计器的时间序列。
用于预测标签的时间序列。
pd-multiindex:pd.DataFrame,列 = 变量,索引 = pd.MultiIndex,第一级 = 实例索引,第二级 = 时间索引
numpy3D:形状为 [n_instances, n_dimensions, series_length] 的 3D np.array(任意维数,等长序列)
或任何其他支持的
Panelmtype有关 mtype 列表,请参阅
datatypes.SCITYPE_REGISTER
有关规范,请参阅
examples/AA_datatypes_and_datasets.ipynb并非所有估计器都支持包含多变量或不等长序列的面板,有关详细信息,请参阅标签参考。
ysktime 兼容的表格数据容器,Table scitype
- 返回:
- y_predsktime 兼容的表格数据容器,科学类型 (scitype) 为 Table
预测的类别标签
1D 可迭代对象,形状为 [n_instances],或 2D 可迭代对象,形状为 [n_instances, n_dimensions]。
第 0 个索引对应于 X 中的实例索引,第 1 个索引(如果适用)对应于 X 中的多输出向量索引。
如果 y 是一元(一维)的,则是 1D np.npdarray;否则,与拟合 (fit) 时传入的 y 类型相同。
- predict_proba(X)[source]#
预测 X 中序列的标签概率。
- 参数:
- 用于拟合估计器的时间序列。
用于预测标签的时间序列。
pd-multiindex:pd.DataFrame,列 = 变量,索引 = pd.MultiIndex,第一级 = 实例索引,第二级 = 时间索引
numpy3D:形状为 [n_instances, n_dimensions, series_length] 的 3D np.array(任意维数,等长序列)
或任何其他支持的
Panelmtype有关 mtype 列表,请参阅
datatypes.SCITYPE_REGISTER
有关规范,请参阅
examples/AA_datatypes_and_datasets.ipynb并非所有估计器都支持包含多变量或不等长序列的面板,有关详细信息,请参阅标签参考。
ysktime 兼容的表格数据容器,Table scitype
- 返回:
- y_pred2D np.array of 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,返回内存中的序列化 self;如果path是文件位置,则将 self 以 zip 文件形式存储在该位置。保存的文件是 zip 文件,包含以下内容:_metadata - 包含 self 的类,即 type(self);_obj - 序列化的 self。此类使用默认序列化(pickle)。
- 参数:
- pathNone 或文件位置 (str 或 Path)
如果为 None,self 将保存到内存对象;如果为文件位置,self 将保存到该文件位置。例如,如果
path="estimator",则将在当前工作目录 (cwd) 创建一个 zip 文件
estimator.zip。path="/home/stored/estimator",则将创建一个 zip 文件
estimator.zip并
存储在
/home/stored/中。- serialization_format: str,默认 = "pickle"
用于序列化的模块。可用选项有 "pickle" 和 "cloudpickle"。请注意,非默认格式可能需要安装其他软依赖项。
- 返回:
- 如果
path为 None - 内存中的序列化 self。 - 如果
path为文件位置 - 指向该文件的 ZipFile 对象。
- 如果
- score(X, y) float[source]#
对预测标签与 X 上的真实标签进行评分。
- 参数:
- 用于拟合估计器的时间序列。
用于评分预测标签的时间序列。
pd-multiindex:pd.DataFrame,列 = 变量,索引 = pd.MultiIndex,第一级 = 实例索引,第二级 = 时间索引
numpy3D:形状为 [n_instances, n_dimensions, series_length] 的 3D np.array(任意维数,等长序列)
或任何其他支持的
Panelmtype有关 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对自身的引用。
- 返回:
- float,predict(X) 与 y 相比的准确率得分。
- set_config(**config_dict)[source]#
将配置标志设置为给定值。
- 参数:
- config_dictdict
配置名称:配置值对的字典。有效的配置、值及其含义如下所示:
- displaystr,“diagram” (默认),或 “text”
jupyter kernel 如何显示 self 的实例。
“diagram” = html 框图表示
“text” = 字符串打印输出
- print_changed_onlybool,默认=True
打印 self 时是仅列出与默认值不同的 self 参数 (当参数为 True 时),还是列出所有参数名称和值 (当参数为 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在并行化后 关闭。
- “shutdown_ray”:bool,默认=True;False 防止
“logger_name”:str,默认=”ray”;要使用的日志记录器名称。
“mute_warnings”:bool,默认=False;如果为 True,则禁止警告
- 返回:
- self对自身的引用。
注意
改变对象状态,将 config_dict 中的配置复制到 self._config_dynamic。
- set_params(**params)[source]#
设置此对象的参数。
此方法适用于简单的 skbase 对象以及复合对象。复合对象(即包含其他对象的对象)可以使用参数键字符串
<component>__<parameter>来访问组件<component>中的<parameter>。如果没有两个组件参数名称相同,也可以使用不带<component>__的字符串<parameter>,这样引用会更明确。- 参数:
- **paramsdict
BaseObject 参数,键必须是
<component>__<parameter>字符串。如果__后缀在 get_params 键中是唯一的,则可以作为完整字符串的别名。
- 返回:
- self对自身的引用 (参数设置后)
- set_random_state(random_state=None, deep=True, self_policy='copy')[source]#
设置自身的 random_state 伪随机种子参数。
通过
self.get_params查找名为random_state的参数,并通过set_params将它们设置为从random_state通过链式哈希 (chain hashing)sample_dependent_seed派生的整数。这些整数保证了 seeded 随机生成器的伪随机独立性。根据
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,默认=True
是否在 skbase 对象值的参数(即组件估计器)中设置随机状态。
如果为 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对自身的引用
- set_tags(**tag_dict)[source]#
将实例级别标签覆盖设置为给定值。
每个
scikit-base兼容对象都有一个标签字典,用于存储关于对象的元数据。标签是特定于实例
self的键值对,它们是静态标志,在对象构造后不会改变。它们可用于元数据检查或控制对象的行为。set_tags将动态标签覆盖设置为tag_dict中指定的值,键是标签名称,字典值是要将标签设置为的值。set_tags方法应仅在对象的__init__方法中,在构造期间调用,或在通过__init__构造后直接调用。estimator:class:BaseObject 或派生类的实例
- 参数:
- **tag_dictdict
标签名称:标签值对的字典。
- 返回:
- Self
对自身的引用。