woodwork.table_schema.TableSchema

class woodwork.table_schema.TableSchema(column_names, logical_types, name=None, index=None, time_index=None, semantic_tags=None, table_metadata=None, column_metadata=None, use_standard_tags=False, column_descriptions=None, column_origins=None, validate=True)

__init__(column_names, logical_types, name=None, index=None, time_index=None, semantic_tags=None, table_metadata=None, column_metadata=None, use_standard_tags=False, column_descriptions=None, column_origins=None, validate=True)

创建 TableSchema

参数：

• column_names (list, set) – TableSchema 中存在的列。

• logical_types (dict[str -> LogicalType]) – 将 TableSchema 中的列名映射到该列的 LogicalType 的字典。TableSchema 中存在的所有列都必须包含在 logical_types 字典中。

• name (str, optional) – 用于标识 TableSchema 的名称。

• index (str, optional) – 索引列的名称。

• time_index (str, optional) – 时间索引列的名称。

• semantic_tags (dict, optional) – 将 TableSchema 中的列名映射到该列的语义标签的字典。字典中的键应为字符串，对应于 TableSchema 中的列。指定字典值有两种选择：(str)：如果只设置一个语义标签，可以使用单个字符串作为值。(list[str] 或 set[str])：如果设置多个标签，可以使用字符串列表或集合作为值。对于未包含在字典中的任何列，语义标签将设置为空集。

• table_metadata (dict[str -> json serializable], optional) – 包含 TableSchema 额外元数据的字典。字典必须包含 JSON 可序列化的数据类型，例如字符串、整数和浮点数。不支持 DataFrame 和 Series 类型。

• column_metadata (dict[str -> dict[str -> json serializable]], optional) – 将列名映射到该列的元数据字典的字典。

• use_standard_tags (bool, dict[str -> bool], optional) – 确定是否根据指定的列逻辑类型为列添加标准语义标签。如果提供单个布尔值，则会将相同的 use_standard_tags 值应用于所有列。可以使用字典为单个列指定 use_standard_tags 值。未指定的列将使用默认值。默认为 False。

• column_descriptions (dict[str -> str], optional) – 将列名映射到列描述的字典。

• column_origins (str, dict[str -> str], optional) – 每列的来源。如果提供字符串，则将其用作所有列的来源。可以使用字典为单个列设置来源。

• validate (bool, optional) – 是否应执行参数验证。默认为 True。警告：仅当参数和数据已知有效时，才应将其设置为 False。跳过验证并使用无效输入导致的任何错误可能难以理解。

方法

__init__(column_names, logical_types[, ...])	创建 TableSchema
add_semantic_tags(semantic_tags)	向列添加指定的语义标签，更新 Woodwork 类型信息。
get_subset_schema(subset_cols)	创建一个新的 TableSchema，包含指定的列并保留类型信息。
remove_semantic_tags(semantic_tags)	删除提供的 semantic_tags 字典中任何列名的语义标签，更新 Woodwork 类型信息。
rename(columns)	重命名 TableSchema 中的列
reset_semantic_tags([columns, retain_index_tags])	将指定列的语义标签重置为默认值。
set_index(new_index[, validate])	设置索引。
set_time_index(new_time_index[, validate])	设置时间索引。
set_types([logical_types, semantic_tags, ...])	更新提供的 types 字典中任何列名的逻辑类型和语义标签，从而更新这些列的 TableSchema。

属性

index	表的索引列
logical_types	一个包含每列逻辑类型的字典
metadata	表的元数据
name	模式名称
semantic_tags	一个包含每列语义标签的字典
time_index	表的时间索引列
types	包含 TableSchema 的物理 dtype、逻辑类型和语义标签的 DataFrame。
use_standard_tags