forecasting_verify 模块

参考

一套用于验证数据完整性的函数。

类

Messages

定义验证和错误消息。

函数

check_cols_exist

检查 X 中是否存在 cols。

check_cols_exist(df, cols)

参数

df

必需

TimeSeriesDataFrame 或 pandas.DataFrame。

cols

必需

str 或数组类，如列名称或列名称列表。

无。

data_frame_properties_are_equal

确定两个 TimeSeriesDataFrame 属性是否相等。

由于属性可以是标量或向量，因此该检查不仅仅是单个布尔值语句。

data_frame_properties_are_equal(property1, property2)

参数

property1

必需

要检查的第一个属性

property2

必需

要检查的第二个属性

如果属性相等，则为 True

data_frame_properties_intersection

确定两个 TimeSeriesDataFrame 属性的交集。

如果交集为空，则返回空列表。由于属性可以是标量或向量，因此该检查不仅仅是单个布尔值语句。

data_frame_properties_intersection(property1, property2)

参数

property1

必需

要检查的第一个属性

property2

必需

要检查的第二个属性

交集中列名称的列表

equals

如果输入值不相等，则引发异常。

equals(val1, val2, message)

参数

val1

必需

要测试的第一个输入值

val2

必需

要测试的第二个输入值

message

必需

引发异常时要输出的消息

is_collection

如果 x 是列表、元组或集，则返回 True，否则返回 False。

is_collection(x)

参数

x

is_datetime_like

检查参数是否为合法的、类似于日期时间的对象。

只能将此类对象放入时间索引。

is_datetime_like(x)

参数

x

必需

输入对象

如果输入内容类似于日期/时间，则为 True

is_iterable_but_not_string

确定对象是否具有类似于列表的可迭代属性。

重要的是，此函数不会将字符串视为类似于列表，即使 Python 字符串是可迭代的。

is_iterable_but_not_string(obj)

参数

obj

必需

要检查的对象

如果对象为可迭代，则为 True

is_list_oftype

如果输入值不是给定类型的列表，则引发异常。

is_list_oftype(value, valuetype)

参数

value

必需

要测试的输入列表

valuetype

必需

要检查的值类型

type_is_numeric

如果输入类型不是数值，则引发异常。

：如果参数为 numpy 数值类型，则返回 True

type_is_numeric(data_type: Any, message: str, should_raise: bool = True) -> bool

参数

data_type

必需

要测试的输入类型

message

必需

要检查的变量的名称

should_raise

默认值: True

如果验证数据类型时失败，则应引发异常

type_is_one_of

如果输入类型在给定类型的列表中，则引发异常。

type_is_one_of(data_type, given_types, message)

参数

data_type

必需