CosineTransformer#

class CosineTransformer[源]#

余弦变换。

这是 numpy 余弦函数(参见 numpy.cos)的一个包装器。

属性:
is_fitted

是否已调用 fit 方法。

另请参阅

numpy.cos

示例

>>> from sktime.transformations.series.cos import CosineTransformer
>>> from sktime.datasets import load_airline
>>> y = load_airline()
>>> transformer = CosineTransformer()
>>> y_hat = transformer.fit_transform(y)

方法

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])

将转换器拟合到 X,可选拟合到 y。

fit_transform(X[, y])

拟合数据,然后进行转换。

get_class_tag(tag_name[, tag_value_default])

从类中获取类标签值,并考虑来自父类的标签继承。

get_class_tags()

从类中获取类标签,并考虑来自父类的标签继承。

get_config()

获取 self 的配置标志。

get_fitted_params([deep])

获取已拟合的参数。

get_param_defaults()

获取对象的默认参数。

get_param_names([sort])

获取对象的参数名称。

get_params([deep])

获取此对象的参数值字典。

get_tag(tag_name[, tag_value_default, ...])

从实例获取标签值,考虑标签级别继承和覆盖。

get_tags()

从实例获取标签,考虑标签级别继承和覆盖。

get_test_params([parameter_set])

返回 skbase 对象的测试参数设置。

inverse_transform(X[, y])

逆转换 X 并返回逆转换版本。

is_composite()

检查对象是否由其他 BaseObjects 组成。

load_from_path(serial)

从文件位置加载对象。

load_from_serial(serial)

从序列化内存容器加载对象。

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)

将实例级别标签覆盖设置为给定值。

transform(X[, y])

转换 X 并返回转换后的版本。

update(X[, y, update_params])

返回 skbase 对象的测试参数设置。

check_is_fitted(method_name=None)[源]#

检查估计器是否已拟合。

检查 _is_fitted 属性是否存在且为 Trueis_fitted 属性应在调用对象的 fit 方法时设置为 True

如果不是,则引发 NotFittedError

参数:
method_namestr,可选

调用此方法的名称。如果提供,错误消息将包含此信息。

引发:
NotFittedError

如果估计器尚未拟合。

clone()[源]#

获取具有相同超参数和配置的对象的克隆。

克隆是一个没有共享引用、处于后初始化状态的不同对象。此函数等同于返回 selfsklearn.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)[源]#

将标签从另一个对象克隆为动态覆盖。

每个 scikit-base 兼容对象都有一个标签字典。标签可用于存储有关对象的元数据,或控制对象的行为。

标签是特定于实例 self 的键值对,它们是对象构造后不会更改的静态标志。

clone_tags 从另一个对象 estimator 设置动态标签覆盖。

clone_tags 方法应仅在对象的 __init__ 方法中、构造期间或通过 __init__ 构造后直接调用。

动态标签设置为 estimator 中标签的值,使用 tag_names 中指定的名称。

tag_names 的默认设置是将 estimator 中的所有标签写入 self

当前标签值可以通过 get_tagsget_tag 进行检查。

参数:
estimator:class:BaseObject 或派生类的一个实例
tag_namesstr 或 str 列表,默认值 = None

要克隆的标签名称。默认值 (None) 克隆 estimator 中的所有标签。

返回:
self

self 的引用。

classmethod create_test_instance(parameter_set='default')[源]#

使用第一个测试参数集构建类的实例。

参数:
parameter_setstr,默认值 =“default”

要返回的测试参数集的名称,用于测试。如果某个值未定义特殊参数,将返回 “default” 集。

返回:
instance具有默认参数的类实例
classmethod create_test_instances_and_names(parameter_set='default')[源]#

创建所有测试实例的列表及其名称列表。

参数:
parameter_setstr,默认值 =“default”

要返回的测试参数集的名称,用于测试。如果某个值未定义特殊参数,将返回 “default” 集。

返回:
objscls 实例列表

第 i 个实例是 cls(**cls.get_test_params()[i])

namesstr 列表,与 objs 长度相同

第 i 个元素是测试中 objs 的第 i 个实例的名称。如果实例多于一个,命名约定为 {cls.__name__}-{i},否则为 {cls.__name__}

fit(X, y=None)[源]#

将转换器拟合到 X,可选拟合到 y。

状态变化

将状态更改为“已拟合”。

写入 self

  • 设置以“_”结尾的已拟合模型属性,拟合属性可通过 get_fitted_params 检查。

  • self.is_fitted 标志设置为 True

  • 如果 self.get_tag("remember_data")True,则将 X 记忆为 self._X,并强制转换为 self.get_tag("X_inner_mtype")

参数:
Xsktime 兼容数据容器格式的时间序列

用于拟合转换的数据。

sktime 中的单个数据格式称为 mtype 规范,每个 mtype 实现一个抽象 scitype

  • Series scitype = 单个时间序列。pd.DataFrame, pd.Seriesnp.ndarray (1D 或 2D)

  • Panel scitype = 时间序列集合。带有 2 级行 MultiIndex (instance, time) 的 pd.DataFrame、3D np.ndarray (instance, variable, time)、Series 类型 pd.DataFramelist

  • Hierarchical scitype = 分层时间序列集合。带有 3 个或更多级别行 MultiIndex (hierarchy_1, ..., hierarchy_n, time) 的 pd.DataFrame

有关数据格式的更多详细信息,请参阅 mtype 词汇表。有关用法,请参阅转换器教程 examples/03_transformers.ipynb

y可选,sktime 兼容数据格式的数据,默认值=None

附加数据,例如用于转换的标签。某些转换器需要此数据,请参阅类文档字符串了解详细信息。如果 self.get_tag("requires_y")True,则必须在 fit 中传递,而非可选。

返回:
self估计器的一个已拟合实例
fit_transform(X, y=None)[源]#

拟合数据,然后进行转换。

将转换器拟合到 X 和 y,并返回 X 的转换版本。

状态变化

将状态更改为“已拟合”。

写入 self _is_fitted : 标志设置为 True。 _X : X 的强制副本,如果 remember_data 标签为 True

如果可能,强制转换为内部类型或 update_data 兼容类型(通过引用)

模型属性(以“_”结尾) 取决于估计器

参数:
Xsktime 兼容数据容器格式的时间序列

用于拟合转换的数据,以及用于转换的数据。

sktime 中的单个数据格式称为 mtype 规范,每个 mtype 实现一个抽象 scitype

  • Series scitype = 单个时间序列。pd.DataFrame, pd.Seriesnp.ndarray (1D 或 2D)

  • Panel scitype = 时间序列集合。带有 2 级行 MultiIndex (instance, time) 的 pd.DataFrame、3D np.ndarray (instance, variable, time)、Series 类型 pd.DataFramelist

  • Hierarchical scitype = 分层时间序列集合。带有 3 个或更多级别行 MultiIndex (hierarchy_1, ..., hierarchy_n, time) 的 pd.DataFrame

有关数据格式的更多详细信息,请参阅 mtype 词汇表。有关用法,请参阅转换器教程 examples/03_transformers.ipynb

y可选,sktime 兼容数据格式的数据,默认值=None

附加数据,例如用于转换的标签。某些转换器需要此数据,请参阅类文档字符串了解详细信息。如果 self.get_tag("requires_y")True,则必须在 fit 中传递,而非可选。

返回:
转换后的 X 版本
类型取决于 X 的类型和 scitype:transform-output 标签
X | tf-输出 | 返回类型 |

|----------|————–|------------------------| | Series | Primitives | pd.DataFrame (1 行) | | Panel | Primitives | pd.DataFrame | | Series | Series | Series | | Panel | Series | Panel | | Series | Panel | Panel |

返回的实例与 X 中的实例对应
表中未列出的组合目前不受支持
明确地,带有示例
  • 如果 XSeries(例如,pd.DataFrame

并且 transform-outputSeries,则返回的是具有相同 mtype 的单个 Series。示例:对单个 series 进行去趋势处理

  • 返回中的实例对应于 X 中的实例

表中未列出的组合目前不支持

  • 具体示例说明

如果 XSeries(例如,pd.DataFrame

  • 并且 transform-outputSeries,则返回相同 mtype 的单个 Series。示例:对单个序列进行去趋势

如果 XPanel(例如,pd-multiindex)并且 transform-output

Series,则返回与 X 实例数量相同的 Panel(转换器应用于每个输入的 Series 实例)。示例:Panel 中的所有序列都单独进行去趋势

从类中获取类标签值,并考虑来自父类的标签继承。

如果 XSeriesPanel 并且 transform-output

Primitives,则返回一个 pd.DataFrame,其行数与 X 中的实例数量相同。示例:返回值的第 i 行包含第 i 个序列的均值和方差

如果 XSeries 并且 transform-outputPanel

  1. 则返回一个类型为 pd-multiindexPanel 对象。示例:输出的第 i 个实例是覆盖 X 的第 i 个窗口

  2. classmethod get_class_tag(tag_name, tag_value_default=None)[源]#

每个 scikit-base 兼容对象都有一个标签字典,用于存储有关对象的元数据。

get_class_tag 方法是一个类方法,它仅考虑类级别标签值和覆盖来检索标签的值。

它从对象返回名称为 tag_name 的标签的值,考虑标签覆盖,优先级按降序排列如下

参数:
在类的 _tags 属性中设置的标签。

在父类的 _tags 属性中设置的标签,

按继承顺序排列。

不考虑通过 set_tagsclone_tags 在实例上设置的动态标签覆盖。

返回:
要检索可能包含实例覆盖的标签值,请改用 get_tag 方法。

tag_namestr

标签值的名称。

从类中获取类标签,并考虑来自父类的标签继承。

每个 scikit-base 兼容对象都有一个标签字典。标签可用于存储有关对象的元数据,或控制对象的行为。

标签是特定于实例 self 的键值对,它们是对象构造后不会更改的静态标志。

tag_value_default任何类型

未找到标签时的默认/回退值。

tag_value

  1. 则返回一个类型为 pd-multiindexPanel 对象。示例:输出的第 i 个实例是覆盖 X 的第 i 个窗口

  2. classmethod get_class_tag(tag_name, tag_value_default=None)[源]#

每个 scikit-base 兼容对象都有一个标签字典,用于存储有关对象的元数据。

selftag_name 标签的值。如果未找到,则返回 tag_value_default

classmethod get_class_tags()[源]#

get_class_tag 方法是一个类方法,它仅考虑类级别标签值和覆盖来检索标签的值。

get_class_tags 方法是一个类方法,它仅考虑类级别标签值和覆盖来检索标签的值。

它返回一个字典,其键是类或其任何父类中设置的 _tags 属性的任何键。

值是相应的标签值,覆盖的优先级按降序排列如下

实例可以根据超参数覆盖这些标签。

获取 self 的配置标志。

要检索可能包含实例覆盖的标签,请改用 get_tags 方法。

对于包含来自动态标签的覆盖,请使用 get_tags

collected_tagsdict

标签名称:标签值对的字典。通过嵌套继承从 _tags 类属性收集。不被 set_tagsclone_tags 设置的动态标签覆盖。

返回:
get_config()[源]#

配置是 self 的键值对,通常用作控制行为的瞬态标志。

get_config 返回动态配置,这些配置会覆盖默认配置。

获取已拟合的参数。

默认配置在类或其父类的 _config 类属性中设置,并被通过 set_config 设置的动态配置覆盖。

配置在 clonereset 调用下保留。

参数:
config_dictdict

配置名称:配置值对的字典。通过嵌套继承从 _config 类属性收集,然后收集 _onfig_dynamic 对象属性中的任何覆盖和新标签。

  • get_fitted_params(deep=True)[源]#

  • 所需状态

返回:
需要状态为“已拟合”。

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()[源]#

参数:
获取对象的参数默认值。

default_dict dict[str, Any]

返回:
键是所有在 __init__ 中定义了默认值的 cls 参数。值是 __init__ 中定义的默认值。

classmethod get_param_names(sort=True)[源]#

获取对象的参数名称。

获取此对象的参数值字典。

参数:
config_dictdict

sortbool,默认值=True

  • 是否按字母顺序 (True) 或按其在类 __init__ 中出现的顺序 (False) 返回参数名称。

  • param_names list[str]

返回:
cls 的参数名称列表。如果 sort=False,则按其在类 __init__ 中出现的相同顺序排列。如果 sort=True,则按字母顺序排列。

get_params(deep=True)[源]#

  • 是否返回组件的参数。

  • 如果 True,将返回此对象的参数名称:值字典,包括组件的参数(= BaseObject 值的参数)。

  • 如果 False,将返回此对象的参数名称:值字典,但不包括组件的参数。

params具有 str 值键的 dict

从实例获取标签值,考虑标签级别继承和覆盖。

每个 scikit-base 兼容对象都有一个标签字典。标签可用于存储有关对象的元数据,或控制对象的行为。

标签是特定于实例 self 的键值对,它们是对象构造后不会更改的静态标志。

参数字典,paramname : paramvalue 键值对包括

  1. 总是:此对象的所有参数,通过 get_param_names 获取值,是此对象该键的参数值,值始终与构造时传递的值相同

如果 deep=True,还包含组件参数的键/值对,组件参数索引为 [componentname]__[paramname]componentname 的所有参数都显示为其 paramname 及对应值

  1. 则返回一个类型为 pd-multiindexPanel 对象。示例:输出的第 i 个实例是覆盖 X 的第 i 个窗口

  2. classmethod get_class_tag(tag_name, tag_value_default=None)[源]#

每个 scikit-base 兼容对象都有一个标签字典,用于存储有关对象的元数据。

参数:
在类的 _tags 属性中设置的标签。

如果 deep=True,还包含任意级别的组件递归,例如,[componentname]__[componentcomponentname]__[paramname]

get_tag(tag_name, tag_value_default=None, raise_error=True)[源]#

get_tag 方法从实例检索名称为 tag_name 的单个标签的值,考虑标签覆盖,优先级按降序排列如下

通过 set_tagsclone_tags 在实例上设置的标签,

在实例构造时设置。

返回:
要检索的标签名称

tag_value_default任何类型,可选;默认值=None

引发:
未找到标签时的默认/回退值

raise_errorbool

未找到标签时是否引发 ValueError

从实例获取标签,考虑标签级别继承和覆盖。

每个 scikit-base 兼容对象都有一个标签字典。标签可用于存储有关对象的元数据,或控制对象的行为。

标签是特定于实例 self 的键值对,它们是对象构造后不会更改的静态标志。

tag_valueAny

tag_value

  1. 总是:此对象的所有参数,通过 get_param_names 获取值,是此对象该键的参数值,值始终与构造时传递的值相同

如果 deep=True,还包含组件参数的键/值对,组件参数索引为 [componentname]__[paramname]componentname 的所有参数都显示为其 paramname 及对应值

  1. 则返回一个类型为 pd-multiindexPanel 对象。示例:输出的第 i 个实例是覆盖 X 的第 i 个窗口

  2. classmethod get_class_tag(tag_name, tag_value_default=None)[源]#

每个 scikit-base 兼容对象都有一个标签字典,用于存储有关对象的元数据。

返回:
selftag_name 标签的值。如果未找到,若 raise_error 为 True 则引发错误,否则返回 tag_value_default

ValueError,如果 raise_errorTrue

如果 tag_name 不在 self.get_tags().keys() 中,则引发 ValueError

返回 skbase 对象的测试参数设置。

get_tags()[源]#

get_tags 方法返回一个标签字典,其键是类或其任何父类中设置的 _tags 属性的任何键,或者通过 set_tagsclone_tags 设置的标签。

collected_tagsdict

标签名称:标签值对的字典。通过嵌套继承从 _tags 类属性收集,然后收集 _tags_dynamic 对象属性中的任何覆盖和新标签。

参数:
parameter_setstr,默认值 =“default”

要返回的测试参数集的名称,用于测试。如果某个值未定义特殊参数,将返回 “default” 集。

返回:
classmethod get_test_params(parameter_set='default')[源]#

get_test_params 是一个统一的接口点,用于存储测试目的的参数设置。此函数也用于 create_test_instancecreate_test_instances_and_names 来构建测试实例。

get_test_params 应返回单个 dictlist of dict

逆转换 X 并返回逆转换版本。

每个 dict 都是用于测试的参数配置,可用于构建一个“有趣”的测试实例。对于 get_test_params 返回中的所有字典 params,调用 cls(**params) 应有效。

get_test_params 不必返回固定的字典列表,它也可以返回动态或随机参数设置。

paramsdict 或 dict 列表,默认值 = {}

默认配置在类或其父类的 _config 类属性中设置,并被通过 set_config 设置的动态配置覆盖。

配置在 clonereset 调用下保留。

创建类测试实例的参数。每个 dict 都是构建“有趣”测试实例的参数,即 MyClass(**params)MyClass(**params[i]) 创建一个有效的测试实例。create_test_instance 使用 params 中的第一个(或唯一的)字典。

  • inverse_transform(X, y=None)[源]#

  • 目前假定只有具有标签

参数:
Xsktime 兼容数据容器格式的时间序列

用于拟合转换的数据。

sktime 中的单个数据格式称为 mtype 规范,每个 mtype 实现一个抽象 scitype

  • Series scitype = 单个时间序列。pd.DataFrame, pd.Seriesnp.ndarray (1D 或 2D)

  • Panel scitype = 时间序列集合。带有 2 级行 MultiIndex (instance, time) 的 pd.DataFrame、3D np.ndarray (instance, variable, time)、Series 类型 pd.DataFramelist

  • Hierarchical scitype = 分层时间序列集合。带有 3 个或更多级别行 MultiIndex (hierarchy_1, ..., hierarchy_n, time) 的 pd.DataFrame

有关数据格式的更多详细信息,请参阅 mtype 词汇表。有关用法,请参阅转换器教程 examples/03_transformers.ipynb

y可选,sktime 兼容数据格式的数据,默认值=None

“scitype:transform-input”=”Series”,“scitype:transform-output”=”Series”,

返回:
具有 inverse_transform 方法。

访问 self 中的

以“_”结尾的已拟合模型属性。

检查对象是否由其他 BaseObjects 组成。

self.is_fitted,必须为 True

返回:
附加数据,例如用于转换的标签。某些转换器需要此数据,请参阅类文档字符串了解详细信息。

X 的逆转换版本

与 X 类型相同,并符合 mtype 格式规范

是否已调用 fit 方法。

is_composite()[源]#

返回:
复合对象是包含其他对象作为参数的对象。在实例上调用,因为这可能因实例而异。

composite bool

对象是否有任何参数的值是 BaseObject 后代实例。

从文件位置加载对象。

参数:
property is_fitted[源]#
返回:
检查对象的 _is_fitted` 属性,该属性在对象构造期间应初始化为 ``False,并在调用对象的 fit 方法时设置为 True。
bool

从序列化内存容器加载对象。

参数:
估计器是否已 fit
返回:
classmethod load_from_path(serial)[源]#
serialZipFile(path).open(“object) 的结果

将对象重置到干净的初始化后状态。

反序列化 self,结果输出到 path,来自 cls.save(path)

调用 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 或文件位置 (str 或 Path)

如果为 None,self 会保存到内存对象;如果为文件位置,self 会保存到该文件位置。如果

  • path=”estimator” 则会在当前工作目录创建 zip 文件 estimator.zip

  • path=”/home/stored/estimator” 则会创建 zip 文件 estimator.zip

存储在 /home/stored/ 中。

serialization_format: str,默认 = “pickle”

用于序列化的模块。可用选项包括 “pickle” 和 “cloudpickle”。请注意,非默认格式可能需要安装其他软依赖项。

返回:
如果 path 是 None - 内存中的序列化 self
如果 path 是文件位置 - 指向该文件的 ZipFile
set_config(**config_dict)[source]#

将配置标志设置为给定值。

参数:
get_config()[源]#

配置名称 : 配置值对的字典。有效的配置、值及其含义列举如下

displaystr,“diagram”(默认)或 “text”

jupyter kernel 如何显示 self 的实例

  • “diagram” = html 框图表示

  • “text” = 字符串输出

print_changed_onlybool,默认=True

打印 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 在并行化后

      关闭。

    • “logger_name”:str,默认=”ray”;要使用的日志记录器名称。

    • “mute_warnings”:bool,默认=False;如果为 True,则抑制警告

input_conversionstr,可选值包括 “on”(默认)、“off” 或有效的 mtype 字符串

控制输入的检查和转换,用于 _fit_transform_inverse_transform_update

  • "on" - 执行输入检查和转换

  • "off" - 在将数据传递给内部方法之前不执行输入检查和转换

  • 有效的 mtype 字符串 - 输入被假定为指定的 mtype,执行转换但不执行检查

output_conversionstr,可选值包括 “on”、“off”、有效的 mtype 字符串

控制 _transform_inverse_transform 的输出转换

  • "on" - 如果 input_conversion 是 “on”,则执行输出转换

  • "off" - 直接返回 _transform_inverse_transform 的输出

  • 有效的 mtype 字符串 - 输出被转换为指定的 mtype

返回:
self对 self 的引用。

注意

更改对象状态,将 config_dict 中的配置复制到 self._config_dynamic。

set_params(**params)[source]#

设置此对象的参数。

此方法适用于简单的 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')[source]#

为 self 设置 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 实例或 None, 默认=None

伪随机数生成器,用于控制随机整数的生成。传递 int 可在多次函数调用中获得可复现的输出。

config_dictdict

是否设置 skbase 对象值参数中的随机状态,即组件估计器中的随机状态。

  • 如果为 False,则仅设置 selfrandom_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 的引用
set_tags(**tag_dict)[source]#

将实例级别标签覆盖设置为给定值。

如果 XSeriesPanel 并且 transform-output

标签是特定于实例 self 的键值对,它们是静态标志,在对象构造后不会改变。它们可用于元数据检查或控制对象的行为。

set_tags 将动态标签覆盖设置为 tag_dict 中指定的值,其中键是标签名称,字典值是要将标签设置成的值。

set_tags 方法应该仅在对象的 __init__ 方法中、构造期间或通过 __init__ 构造后直接调用。

当前标签值可以通过 get_tagsget_tag 进行检查。

参数:
**tag_dictdict

标签名称 : 标签值对的字典。

返回:
Self

对 self 的引用。

transform(X, y=None)[source]#

转换 X 并返回转换后的版本。

默认配置在类或其父类的 _config 类属性中设置,并被通过 set_config 设置的动态配置覆盖。

配置在 clonereset 调用下保留。

创建类测试实例的参数。每个 dict 都是构建“有趣”测试实例的参数,即 MyClass(**params)MyClass(**params[i]) 创建一个有效的测试实例。create_test_instance 使用 params 中的第一个(或唯一的)字典。

  • inverse_transform(X, y=None)[源]#

  • 目前假定只有具有标签

参数:
Xsktime 兼容数据容器格式的时间序列

要转换的数据。

sktime 中的单个数据格式称为 mtype 规范,每个 mtype 实现一个抽象 scitype

  • Series scitype = 单个时间序列。pd.DataFrame, pd.Seriesnp.ndarray (1D 或 2D)

  • Panel scitype = 时间序列集合。带有 2 级行 MultiIndex (instance, time) 的 pd.DataFrame、3D np.ndarray (instance, variable, time)、Series 类型 pd.DataFramelist

  • Hierarchical scitype = 分层时间序列集合。带有 3 个或更多级别行 MultiIndex (hierarchy_1, ..., hierarchy_n, time) 的 pd.DataFrame

有关数据格式的更多详细信息,请参阅 mtype 词汇表。有关用法,请参阅转换器教程 examples/03_transformers.ipynb

y可选,sktime 兼容数据格式的数据,默认值=None

“scitype:transform-input”=”Series”,“scitype:transform-output”=”Series”,

返回:
转换后的 X 版本
类型取决于 X 的类型和 scitype:transform-output 标签

transform

X

-输出

返回类型

Series

Primitives

pd.DataFrame(1 行)

Panel

Primitives

pd.DataFrame

Series

Series

Series

Panel

Series

Panel

Series

Panel

Panel

返回的实例与 X 中的实例对应
表中未列出的组合目前不受支持
明确地,带有示例
  • 如果 XSeries(例如,pd.DataFrame

并且 transform-outputSeries,则返回的是具有相同 mtype 的单个 Series。示例:对单个 series 进行去趋势处理

  • 返回中的实例对应于 X 中的实例

表中未列出的组合目前不支持

  • 具体示例说明

如果 XSeries(例如,pd.DataFrame

  • 并且 transform-outputSeries,则返回相同 mtype 的单个 Series。示例:对单个序列进行去趋势

如果 XPanel(例如,pd-multiindex)并且 transform-output

update(X, y=None, update_params=True)[source]#

返回 skbase 对象的测试参数设置。

默认配置在类或其父类的 _config 类属性中设置,并被通过 set_config 设置的动态配置覆盖。

配置在 clonereset 调用下保留。

创建类测试实例的参数。每个 dict 都是构建“有趣”测试实例的参数,即 MyClass(**params)MyClass(**params[i]) 创建一个有效的测试实例。create_test_instance 使用 params 中的第一个(或唯一的)字典。

  • inverse_transform(X, y=None)[源]#

  • 目前假定只有具有标签

写入 self

  • inverse_transform(X, y=None)[源]#

  • 如果 remember_data 标签为 True,则写入 self._X,通过 update_data,根据 X 中的值进行更新。

参数:
Xsktime 兼容数据容器格式的时间序列

用于更新转换的数据

sktime 中的单个数据格式称为 mtype 规范,每个 mtype 实现一个抽象 scitype

  • Series scitype = 单个时间序列。pd.DataFrame, pd.Seriesnp.ndarray (1D 或 2D)

  • Panel scitype = 时间序列集合。带有 2 级行 MultiIndex (instance, time) 的 pd.DataFrame、3D np.ndarray (instance, variable, time)、Series 类型 pd.DataFramelist

  • Hierarchical scitype = 分层时间序列集合。带有 3 个或更多级别行 MultiIndex (hierarchy_1, ..., hierarchy_n, time) 的 pd.DataFrame

有关数据格式的更多详细信息,请参阅 mtype 词汇表。有关用法,请参阅转换器教程 examples/03_transformers.ipynb

y可选,sktime 兼容数据格式的数据,默认值=None

“scitype:transform-input”=”Series”,“scitype:transform-output”=”Series”,

返回:
self估计器的一个已拟合实例