文本向量化层

[源代码]

TextVectorization 类

keras.layers.TextVectorization(
    max_tokens=None,
    standardize="lower_and_strip_punctuation",
    split="whitespace",
    ngrams=None,
    output_mode="int",
    output_sequence_length=None,
    pad_to_max_tokens=False,
    vocabulary=None,
    idf_weights=None,
    sparse=False,
    ragged=False,
    encoding="utf-8",
    name=None,
    **kwargs
)

一个预处理层，将文本特征映射为整数序列。

此层具有管理 Keras 模型中文本的基本选项。它将一批字符串（一个示例 = 一个字符串）转换为标记索引列表（一个示例 = 一维整数标记索引张量）或密集表示（一个示例 = 一维浮点值张量，表示有关示例标记的数据）。此层旨在处理自然语言输入。要处理简单的字符串输入（类别字符串或预标记化字符串），请参阅 kers_core.layers.StringLookup。

该层的词汇表必须在构造时提供，或通过 adapt() 学习。当此层被调整时，它将分析数据集，确定各个字符串值的频率，并从中创建词汇表。此词汇表可以具有无限大小或被限制，具体取决于此层的配置选项；如果输入中的唯一值多于最大词汇表大小，则将使用最频繁的术语来创建词汇表。

每个示例的处理包含以下步骤

1. 标准化每个示例（通常是小写化 + 去除标点符号）
2. 将每个示例拆分为子字符串（通常是单词）
3. 将子字符串重新组合为标记（通常是 n-gram）
4. 索引标记（将唯一整数值与每个标记关联）
5. 使用此索引转换每个示例，转换为整数向量或密集浮点向量。

关于传递可调用对象以自定义此层的拆分和标准化的说明

1. 任何可调用对象都可以传递到此层，但是如果要序列化此对象，则应仅传递已注册的 Keras 可序列化函数（有关更多详细信息，请参阅 keras.saving.register_keras_serializable）。
2. 当使用自定义可调用对象进行 standardize 时，可调用对象接收的数据将与传递给此层的数据完全相同。可调用对象应返回与输入形状相同的张量。
3. 当使用自定义可调用对象进行 split 时，可调用对象接收的数据将删除第一个维度 - 而不是 [["string to split"], ["another string to split"]]，可调用对象将看到 ["string to split", "another string to split"]。可调用对象应返回一个数据类型为 string 的 tf.Tensor，其中第一个维度包含拆分的标记 - 在此示例中，我们应该看到类似 [["string", "to", "split"], ["another", "string", "to", "split"]] 的内容。

注意： 此层在内部使用 TensorFlow。它不能用作除 TensorFlow 之外的任何后端的模型编译计算图的一部分。但是，它可以在急切模式下运行时与任何后端一起使用。它也始终可以用作任何后端的输入预处理管道的一部分（在模型本身之外），这是我们建议使用此层的方式。

注意： 此层可以安全地在 tf.data 管道内部使用（与您使用的后端无关）。

参数

• max_tokens：此层的最大词汇量大小。仅当调整词汇表或设置 pad_to_max_tokens=True 时才应指定此值。请注意，此词汇表包含 1 个 OOV 标记，因此有效标记数为 (max_tokens - 1 - (1 if output_mode == "int" else 0))。
• standardize：应用于输入文本的标准化的可选规范。值可以是
  • None：不进行标准化。
  • "lower_and_strip_punctuation"：文本将转换为小写并删除所有标点符号。
  • "lower"：文本将转换为小写。
  • "strip_punctuation"：所有标点符号将被删除。
  • 可调用对象：输入将传递给可调用函数，该函数应被标准化并返回。
• split：用于拆分输入文本的可选规范。值可以是
  • None：不拆分。
  • "whitespace"：按空格拆分。
  • "character"：按每个 Unicode 字符拆分。
  • 可调用对象：标准化后的输入将传递给可调用函数，该函数应拆分并返回。
• ngrams：用于从可能拆分的输入文本创建 n-gram 的可选规范。值可以是 None，一个整数或一个整数元组；传递一个整数将创建高达该整数的 n-gram，传递一个整数元组将为元组中指定的值创建 n-gram。传递 None 表示不创建 n-gram。
• output_mode：该层输出的可选规范。值可以是 "int"，"multi_hot"，"count" 或 "tf_idf"，配置层如下
  • "int"：输出整数索引，每个拆分的字符串标记一个整数索引。当 output_mode == "int" 时，0 保留用于屏蔽位置；这会将词汇量大小减小到 max_tokens - 2 而不是 max_tokens - 1。
  • "multi_hot"：每个批次输出一个整数数组，其大小为 vocab_size 或 max_tokens，其中所有元素都包含 1，该元素映射到该索引的标记在批次项中至少存在一次。
  • "count"：与 "multi_hot" 类似，但整数数组包含该索引处的标记在批次项中出现的次数计数。
  • "tf_idf"：与 "multi_hot" 类似，但应用 TF-IDF 算法来查找每个标记槽中的值。对于 "int" 输出，支持任何形状的输入和输出。对于所有其他输出模式，目前仅支持排名 1 的输入（和拆分后的排名 2 输出）。
• output_sequence_length：仅在 INT 模式下有效。如果设置，则输出的时间维度将被填充或截断为正好 output_sequence_length 个值，从而产生形状为 (batch_size, output_sequence_length) 的张量，而与拆分步骤产生了多少个标记无关。默认为 None。如果 ragged 为 True，则 output_sequence_length 仍可以截断输出。
• pad_to_max_tokens：仅在 "multi_hot"，"count" 和 "tf_idf" 模式下有效。如果为 True，即使词汇表中唯一标记的数量小于 max_tokens，输出的特征轴也将填充到 max_tokens，从而产生形状为 (batch_size, max_tokens) 的张量，而与词汇量大小无关。默认为 False。
• vocabulary：可选。可以是字符串数组或指向文本文件的字符串路径。如果传递数组，则可以传递包含字符串词汇表术语的元组、列表、一维 NumPy 数组或一维张量。如果传递文件路径，则该文件应为词汇表中的每个术语包含一行。如果设置此参数，则无需 adapt() 该层。
• idf_weights：仅当 output_mode 为 "tf_idf" 时有效。与词汇表长度相同的元组、列表、一维 NumPy 数组或一维张量，其中包含浮点倒排文档频率权重，这些权重将乘以每个样本项的计数，以获得最终的 tf_idf 权重。如果设置了 vocabulary 参数，并且 output_mode 为 "tf_idf"，则必须提供此参数。
• ragged：布尔值。仅适用于 "int" 输出模式。仅支持 TensorFlow 后端。如果为 True，则返回 RaggedTensor 而不是密集 Tensor，其中每个序列在字符串拆分后可能具有不同的长度。默认为 False。
• sparse：布尔值。仅适用于 "multi_hot"、"count" 和 "tf_idf" 输出模式。仅支持 TensorFlow 后端。如果为 True，则返回 SparseTensor 而不是密集 Tensor。默认为 False。
• encoding: 可选。用于解释输入字符串的文本编码。默认为 "utf-8"。

示例

此示例实例化一个 TextVectorization 层，该层会将文本转换为小写、按空格分割、去除标点符号并输出整数词汇索引。

>>> max_tokens = 5000  # Maximum vocab size.
>>> max_len = 4  # Sequence length to pad the outputs to.
>>> # Create the layer.
>>> vectorize_layer = TextVectorization(
...     max_tokens=max_tokens,
...     output_mode='int',
...     output_sequence_length=max_len)

>>> # Now that the vocab layer has been created, call `adapt` on the
>>> # list of strings to create the vocabulary.
>>> vectorize_layer.adapt(["foo bar", "bar baz", "baz bada boom"])

>>> # Now, the layer can map strings to integers -- you can use an
>>> # embedding layer to map these integers to learned embeddings.
>>> input_data = [["foo qux bar"], ["qux baz"]]
>>> vectorize_layer(input_data)
array([[4, 1, 3, 0],
       [1, 2, 0, 0]])

此示例通过将词汇项列表传递给该层的 __init__() 方法来实例化一个 TextVectorization 层。

>>> vocab_data = ["earth", "wind", "and", "fire"]
>>> max_len = 4  # Sequence length to pad the outputs to.
>>> # Create the layer, passing the vocab directly. You can also pass the
>>> # vocabulary arg a path to a file containing one vocabulary word per
>>> # line.
>>> vectorize_layer = keras.layers.TextVectorization(
...     max_tokens=max_tokens,
...     output_mode='int',
...     output_sequence_length=max_len,
...     vocabulary=vocab_data)

>>> # Because we've passed the vocabulary directly, we don't need to adapt
>>> # the layer - the vocabulary is already set. The vocabulary contains the
>>> # padding token ('') and OOV token ('[UNK]')
>>> # as well as the passed tokens.
>>> vectorize_layer.get_vocabulary()
['', '[UNK]', 'earth', 'wind', 'and', 'fire']