KerasHub:预训练模型 / API 文档 / 分词器 / WordPieceTokenizer

WordPieceTokenizer

[source]

WordPieceTokenizer

keras_hub.tokenizers.WordPieceTokenizer(
    vocabulary=None,
    sequence_length=None,
    lowercase=False,
    strip_accents=False,
    split=True,
    split_on_cjk=True,
    suffix_indicator="##",
    oov_token="[UNK]",
    special_tokens=None,
    special_tokens_in_strings=False,
    dtype="int32",
    **kwargs
)

WordPiece 分词器层。

此层提供了 WordPiece 算法的高效图内实现,BERT 和其他模型使用该算法。

为了使此层更易于开箱即用,该层将预分词输入,可以选择性地将输入转换为小写、去除重音符号,并按空格和标点符号拆分输入。这些预分词步骤均不可逆。detokenize 方法将用空格连接单词,并且不会完全反转 tokenize

如果需要更自定义的预分词步骤,则可以将该层配置为仅应用严格的 WordPiece 算法,方法是传递 lowercase=Falsestrip_accents=Falsesplit=False。在这种情况下,输入应为预先拆分的字符串张量或 RaggedTensor。

分词器输出可以使用 sequence_length 参数进行填充和截断,也可以保持不截断。确切的输出将取决于输入张量的秩。

如果输入是字符串批次(秩 > 0):默认情况下,该层将输出一个 tf.RaggedTensor,其中输出的最后一个维度是 Ragged。如果设置了 sequence_length,则该层将输出一个密集 tf.Tensor,其中所有输入都已填充或截断为 sequence_length

如果输入是标量字符串(秩 == 0):默认情况下,该层将输出一个静态形状为 [None] 的密集 tf.Tensor。如果设置了 sequence_length,则输出将是形状为 [sequence_length] 的密集 tf.Tensor

可以通过 dtype 参数控制输出 dtype,该参数应为整数或字符串类型。

参数

  • vocabulary:字符串列表或字符串文件名路径。如果传递列表,则列表的每个元素都应为单个 WordPiece 词元字符串。如果传递文件名,则该文件应为纯文本文件,每行包含一个 WordPiece 词元。
  • sequence_length:int。如果设置,则输出将转换为密集张量,并进行填充/修剪,以便所有输出都具有 sequence_length。
  • lowercase:bool。如果为 True,则输入文本将在分词前转换为小写。默认为 False
  • strip_accents:bool。如果为 True,则所有重音符号将从文本中删除,然后再进行分词。默认为 False
  • split:bool。如果为 True,则输入将按空格和标点符号拆分,并且所有标点符号将保留为词元。如果为 False,则应在调用分词器之前拆分(“预分词”)输入,并将其作为整个单词的密集或 RaggedTensor 传递。默认为 True
  • split_on_cjk:bool。如果为 True,则输入将按 CJK 字符拆分,即中文、日文、韩文和越南文字符 (https://en.wikipedia.org/wiki/CJK_Unified_Ideographs_(Unicode_block))。请注意,这仅在 split 为 True 时适用。默认为 True
  • suffix_indicator:str。前置于 WordPiece 的字符,用于指示它是另一个子词的后缀。例如“##ing”。默认为 "##"
  • oov_token:str。用于替换未知词元的字符串值。它必须包含在词汇表中。默认为 "[UNK]"
  • special_tokens_in_strings:bool。一个布尔值,指示分词器是否应期望输入字符串中包含特殊词元,这些特殊词元应被正确分词并映射到其 ID。默认为 False。

参考文献

示例

Ragged 输出。

>>> vocab = ["[UNK]", "the", "qu", "##ick", "br", "##own", "fox", "."]
>>> inputs = "The quick brown fox."
>>> tokenizer = keras_hub.tokenizers.WordPieceTokenizer(
...     vocabulary=vocab,
...     lowercase=True,
... )
>>> outputs = tokenizer(inputs)
>>> np.array(outputs)
array([1, 2, 3, 4, 5, 6, 7], dtype=int32)

密集输出。

>>> vocab = ["[UNK]", "the", "qu", "##ick", "br", "##own", "fox", "."]
>>> inputs = ["The quick brown fox."]
>>> tokenizer = keras_hub.tokenizers.WordPieceTokenizer(
...     vocabulary=vocab,
...     sequence_length=10,
...     lowercase=True,
... )
>>> outputs = tokenizer(inputs)
>>> np.array(outputs)
array([[1, 2, 3, 4, 5, 6, 7, 0, 0, 0]], dtype=int32)

字符串输出。

>>> vocab = ["[UNK]", "the", "qu", "##ick", "br", "##own", "fox", "."]
>>> inputs = "The quick brown fox."
>>> tokenizer = keras_hub.tokenizers.WordPieceTokenizer(
...     vocabulary=vocab,
...     lowercase=True,
...     dtype="string",
... )
>>> tokenizer(inputs)
['the', 'qu', '##ick', 'br', '##own', 'fox', '.']

反分词。

>>> vocab = ["[UNK]", "the", "qu", "##ick", "br", "##own", "fox", "."]
>>> inputs = "The quick brown fox."
>>> tokenizer = keras_hub.tokenizers.WordPieceTokenizer(
...     vocabulary=vocab,
...     lowercase=True,
... )
>>> tokenizer.detokenize(tokenizer.tokenize(inputs))
'the quick brown fox .'

自定义拆分。

>>> vocab = ["[UNK]", "the", "qu", "##ick", "br", "##own", "fox", "."]
>>> inputs = "The$quick$brown$fox"
>>> tokenizer = keras_hub.tokenizers.WordPieceTokenizer(
...     vocabulary=vocab,
...     split=False,
...     lowercase=True,
...     dtype='string',
... )
>>> split_inputs = tf.strings.split(inputs, sep="$")
>>> tokenizer(split_inputs)
['the', 'qu', '##ick', 'br', '##own', 'fox']

[source]

tokenize 方法

WordPieceTokenizer.tokenize(inputs)

将字符串的输入张量转换为输出词元。

参数

  • inputs:输入张量,或输入张量的字典/列表/元组。
  • *args:其他位置参数。
  • **kwargs:其他关键字参数。

[source]

detokenize 方法

WordPieceTokenizer.detokenize(inputs)

将词元转换回字符串。

参数

  • inputs:输入张量,或输入张量的字典/列表/元组。
  • *args:其他位置参数。
  • **kwargs:其他关键字参数。

[source]

get_vocabulary 方法

WordPieceTokenizer.get_vocabulary()

获取分词器词汇表作为字符串词元列表。


[source]

vocabulary_size 方法

WordPieceTokenizer.vocabulary_size()

获取分词器词汇表的整数大小。


[source]

token_to_id 方法

WordPieceTokenizer.token_to_id(token)

将字符串词元转换为整数 ID。


[source]

id_to_token 方法

WordPieceTokenizer.id_to_token(id)

将整数 ID 转换为字符串词元。