TSFreshClassifier#
- class TSFreshClassifier(default_fc_parameters='efficient', relevant_feature_extractor=True, estimator=None, verbose=0, n_jobs=1, chunksize=None, random_state=None)[source]#
基于可伸缩假设检验的时间序列特征提取分类器。
此分类器简单地使用 TSFresh [1] 转换器转换输入数据,并使用转换后的数据构建提供的估计器。
- 参数:
- default_fc_parametersstr, 默认值=”efficient”
要提取的 TSFresh 特征集,选项包括“minimal”、“efficient”或“comprehensive”。
- relevant_feature_extractorbool, 默认值=False
使用 FRESH 算法移除不相关的特征。
- estimatorsklearn 分类器, 默认值=None
使用转换后的数据构建一个 sklearn 估计器。默认为包含 200 棵树的随机森林。
- verboseint, 默认值=0
输出到控制台的详细程度(仅供参考)
- n_jobsint, 默认值=1
并行运行
fit
和predict
的作业数量。-1
表示使用所有处理器。- chunksizeint 或 None, 默认值=None
每个并行 TSFresh 作业中处理的时间序列数量,应针对高效并行化进行优化。
- random_stateint 或 None, 默认值=None
随机种子,整数。
- 属性:
- n_classes_int
类别数量。从数据中提取。
- classes_形状为 (n_classes_) 的 ndarray
保存每个类别的标签。
另请参阅
TSFreshFeatureExtractor
,TSFreshRelevantFeatureExtractor
参考文献
[1]Christ, Maximilian, et al. “Time series feature extraction on basis of scalable hypothesis tests (tsfresh-a python package).” Neurocomputing 307 (2018): 72-77. https://www.sciencedirect.com/science/article/pii/S0925231218304843
示例
>>> from sktime.classification.feature_based import TSFreshClassifier >>> from sklearn.ensemble import RandomForestClassifier >>> 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) >>> clf = TSFreshClassifier( ... estimator=RandomForestClassifier(n_estimators=5), ... default_fc_parameters="efficient", ... ) >>> clf.fit(X_train, y_train) TSFreshClassifier(...) >>> y_pred = clf.predict(X_test)
方法
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) 文件。
用于对预测标签进行评分的时间序列。
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”参数。
- 返回:
- paramsdict 或 list of 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]#
获取具有相同超参数和配置的对象的克隆。
克隆是一个没有共享引用的不同对象,处于初始化后状态。此函数等同于返回
sklearn.clone
的self
。等同于使用
self
的参数构造一个新的type(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 或 list of 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
将 self.is_fitted 设置为 True。设置以“_”结尾的拟合模型属性。
- 参数:
- Xsktime 兼容的 Panel scitype 时间序列面板数据容器
用于拟合估计器的时间序列。
可以是
Panel
scitype 的任何 mtype,例如pd-multiindex: pd.DataFrame,其中 columns = variables,index = 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,则不更新状态。
- 参数:
- Xsktime 兼容的 Panel scitype 时间序列面板数据容器
用于拟合和预测标签的时间序列。
可以是
Panel
scitype 的任何 mtype,例如pd-multiindex: pd.DataFrame,其中 columns = variables,index = 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, 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,则不会更改分类器的状态,即拟合/预测序列使用副本运行,self 不变
如果为 True,则会将 self 拟合到完整的 X 和 y,结束状态将等同于运行 fit(X, y)
- 返回:
- y_predsktime 兼容的 Table scitype 表格数据容器
预测的类别标签
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 中序列的标签概率。
方便方法,用于生成样本内预测和交叉验证的样本外预测。
- 写入 self,如果 change_state=True
将 self.is_fitted 设置为 True。设置以“_”结尾的拟合模型属性。
如果 change_state=False,则不更新状态。
- 参数:
- Xsktime 兼容的 Panel scitype 时间序列面板数据容器
用于拟合和预测标签的时间序列。
可以是
Panel
scitype 的任何 mtype,例如pd-multiindex: pd.DataFrame,其中 columns = variables,index = 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, 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,则不会更改分类器的状态,即拟合/预测序列使用副本运行,self 不变
如果为 True,则会将 self 拟合到完整的 X 和 y,结束状态将等同于运行 fit(X, y)
- 返回:
- y_pred2D int 类型 np.array, 形状为 [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 的配置标志。
配置是
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键为字符串值的字典(dict 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
兼容对象都有一个标签字典。标签可用于存储对象的元数据,或控制对象的行为。标签是特定于实例
self
的键值对,它们是对象构造后不会更改的静态标志。get_tag
方法从实例中检索名称为tag_name
的单个标签的值,并考虑标签覆盖,优先级按以下降序排列:在实例上通过
set_tags
或clone_tags
设置的标签,
在实例构造时。
在类的
_tags
属性中设置的标签。在父类的
_tags
属性中设置的标签,
按继承顺序。
- 参数:
- tag_namestr
要检索的标签名称
- 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。- 返回:
- 布尔值
估计器是否已 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 中序列的标签。
- 参数:
- Xsktime 兼容的 Panel scitype 时间序列面板数据容器
用于预测标签的时间序列。
可以是
Panel
scitype 的任何 mtype,例如pd-multiindex: pd.DataFrame,其中 columns = variables,index = 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_predsktime 兼容的 Table scitype 表格数据容器
预测的类别标签
1D 可迭代对象,形状为 [n_instances],或 2D 可迭代对象,形状为 [n_instances, n_dimensions]。
第 0 个索引对应于 X 中的实例索引,第 1 个索引(如果适用)对应于 X 中的多输出向量索引。
如果 y 是一元(一维),则为 1D np.npdarray;否则,与 fit 中传入的 y 类型相同
- predict_proba(X)[source]#
预测 X 中序列的标签概率。
- 参数:
- Xsktime 兼容的 Panel scitype 时间序列面板数据容器
用于预测标签的时间序列。
可以是
Panel
scitype 的任何 mtype,例如pd-multiindex: pd.DataFrame,其中 columns = variables,index = 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_pred2D int 类型 np.array, 形状为 [n_instances, n_classes]
预测的类别标签概率。第0个索引对应 X 中的实例索引。第1个索引对应类别索引,顺序与 self.classes_ 中的顺序相同。条目是预测的类别概率,总和为1。
- reset()[source]#
将对象重置到干净的初始化后状态。
将
self
设置为构造函数调用后立即具有的状态,并保留相同的超参数。通过set_config
设置的配置值也会保留。对
reset
的调用会删除所有对象属性,除了超参数 =
__init__
的参数,写入到self
,例如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 或文件位置(字符串或 Path)
如果为 None,则 self 保存到内存中的对象;如果是文件位置,self 保存到该文件位置。
如果 path="estimator",则将在当前工作目录创建一个 zip 文件
estimator.zip
。如果 path="/home/stored/estimator",则将在
/home/stored/
中创建一个 zip 文件estimator.zip
。
(续上)
- serialization_format: str, default = “pickle”
用于序列化的模块。可用选项有 “pickle” 和 “cloudpickle”。请注意,非默认格式可能需要安装其他软依赖。
- 返回:
- 如果
path
为 None - 内存中的序列化 self - 如果
path
是文件位置 - ZipFile,引用该文件
- 如果
- score(X, y) float [source]#
用于对预测标签进行评分的时间序列。
- 参数:
- Xsktime 兼容的 Panel scitype 时间序列面板数据容器
用于评估预测标签的时间序列。
可以是
Panel
scitype 的任何 mtype,例如pd-multiindex: pd.DataFrame,其中 columns = variables,index = 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
- 返回:
- 浮点数,predict(X) 与 y 的准确率分数
- set_config(**config_dict)[source]#
将配置标志设置为给定值。
- 参数:
- config_dictdict
配置名称 : 配置值 对的字典。下面列出了有效的配置、值及其含义:
- display字符串,"diagram"(默认)或 "text"
jupyter kernels 如何显示 self 的实例
"diagram" = html 框图表示
"text" = 字符串打印输出
- print_changed_only布尔值,默认为 True
打印 self 时是否只列出与默认值不同的 self 参数 (False),或者列出所有参数名称和值 (False)。不嵌套,即只影响 self,不影响组件估计器。
- warnings字符串,"on"(默认)或 "off"
是否引发警告,仅影响来自 sktime 的警告
"on" = 将引发来自 sktime 的警告
"off" = 不会引发来自 sktime 的警告
- backend:parallel字符串,可选,默认为 "None"
广播/向量化时用于并行化的后端,选项之一:
"None":顺序执行循环,简单的列表推导式
"loky", "multiprocessing" 和 "threading":使用
joblib.Parallel
"joblib":自定义和第三方
joblib
后端,例如spark
"dask":使用
dask
,需要在环境中安装dask
包"ray":使用
ray
,需要在环境中安装ray
包
- backend:parallel:params字典,可选,默认为 {} (不传递参数)
作为配置传递给并行化后端的附加参数。有效键取决于
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":布尔值,默认为 True;如果为 False,则阻止
ray
在并行化后关闭。 (续上)
- "shutdown_ray":布尔值,默认为 True;如果为 False,则阻止
"logger_name":字符串,默认为 "ray";要使用的 logger 名称。
"mute_warnings":布尔值,默认为 False;如果为 True,则抑制警告
- 返回:
- self对 self 的引用。
注意
更改对象状态,将 config_dict 中的配置复制到 self._config_dynamic。
- set_params(**params)[source]#
设置此对象的参数。
此方法适用于简单的 skbase 对象以及复合对象。参数键字符串
<component>__<parameter>
可用于复合对象(即包含其他对象的对象)访问组件<component>
中的<parameter>
。如果引用明确(例如,没有两个组件参数同名<parameter>
),也可以使用不带<component>__
的字符串<parameter>
。- 参数:
- **params字典
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_state整数,RandomState 实例或 None,默认为 None
用于控制随机整数生成的伪随机数生成器。传递整数可在多次函数调用中获得可重现的输出。
- deepbool, 默认值=True
是否在 skbase 对象值参数(即组件估计器)中设置随机状态。
如果为 False,则仅设置
self
的random_state
参数(如果存在)。如果为 True,则也会在组件对象中设置
random_state
参数。
- self_policy字符串,"copy", "keep", "new" 之一,默认为 "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_dict字典
标签名称 : 标签值 对的字典。
- 返回:
- Self
对 self 的引用。