Keras 3 API 文件 / KerasNLP / 預訓練模型 / XLMRoberta / XLMRobertaMaskedLMPreprocessor 圖層

XLMRobertaMaskedLMPreprocessor 圖層

[來源]

XLMRobertaMaskedLMPreprocessor 類別

keras_nlp.models.XLMRobertaMaskedLMPreprocessor(
    tokenizer,
    sequence_length=512,
    truncate="round_robin",
    mask_selection_rate=0.15,
    mask_selection_length=96,
    mask_token_rate=0.8,
    random_token_rate=0.1,
    **kwargs
)

用於遮罩語言建模任務的 XLM-RoBERTa 預處理。

此預處理圖層將準備用於遮罩語言建模任務的輸入。它主要用於搭配 keras_nlp.models.XLMRobertaMaskedLM 任務模型。預處理將分多個步驟進行。

  1. 使用 tokenizer 對任意數量的輸入段落進行分詞。
  2. 使用適當的 "<s>""</s>""<pad>" 標記將輸入打包在一起,即在整個序列的開頭添加一個 "<s>",在每個段落之間添加 "</s></s>",並在整個序列的結尾添加一個 "</s>"
  3. 隨機選擇非特殊標記進行遮罩,由 mask_selection_rate 控制。
  4. 建構一個適用於使用 keras_nlp.models.XLMRobertaMaskedLM 任務模型進行訓練的 (x, y, sample_weight) 元組。

參數

  • tokenizer:一個 keras_nlp.models.XLMRobertaTokenizer 实例。
  • sequence_length:int。打包輸入的長度。
  • truncate:字串。用於截斷一批段落列表以符合 sequence_length 的演算法。值可以是 round_robinwaterfall: - "round_robin":可用空間以循環方式一次分配一個標記給仍然需要的輸入,直到達到限制。 - "waterfall":預算的分配使用「瀑布」演算法,該演算法以從左到右的方式分配配額,並填滿桶,直到預算用完。它支援任意數量的段落。
  • mask_selection_rate:浮點數。輸入標記被動態遮罩的機率。
  • mask_selection_length:int。給定樣本中遮罩標記的最大數量。
  • mask_token_rate:浮點數。選定標記將被替換為遮罩標記的機率。
  • random_token_rate:浮點數。選定詞彙被隨機詞彙替換的機率。選定詞彙將以 1 - mask_token_rate - random_token_rate 的機率保留原樣。

呼叫參數

  • x:單一字串序列的張量,或多個要打包在一起的張量序列的元組。輸入可以是批次或非批次的。對於單一序列,原始 Python 輸入將轉換為張量。對於多個序列,請直接傳遞張量。
  • y:標籤資料。應該始終為 None,因為圖層會產生標籤。
  • sample_weight:標籤權重。應該始終為 None,因為圖層會產生標籤權重。

範例

直接在資料上呼叫圖層。

# Load the preprocessor from a preset.
preprocessor = keras_nlp.models.XLMRobertaMaskedLMPreprocessor.from_preset(
    "xlm_roberta_base_multi"
)

# Tokenize and mask a single sentence.
preprocessor("The quick brown fox jumped.")
# Tokenize and mask a batch of single sentences.
preprocessor(["The quick brown fox jumped.", "Call me Ishmael."])
# Tokenize and mask sentence pairs.
# In this case, always convert input to tensors before calling the layer.
first = tf.constant(["The quick brown fox jumped.", "Call me Ishmael."])
second = tf.constant(["The fox tripped.", "Oh look, a whale."])
preprocessor((first, second))

使用 tf.data.Dataset 進行映射。

preprocessor = keras_nlp.models.XLMRobertaMaskedLMPreprocessor.from_preset(
    "xlm_roberta_base_multi"
)
first = tf.constant(["The quick brown fox jumped.", "Call me Ishmael."])
second = tf.constant(["The fox tripped.", "Oh look, a whale."])

# Map single sentences.
ds = tf.data.Dataset.from_tensor_slices(first)
ds = ds.map(preprocessor, num_parallel_calls=tf.data.AUTOTUNE)

# Map sentence pairs.
ds = tf.data.Dataset.from_tensor_slices((first, second))
# Watch out for tf.data's default unpacking of tuples here!
# Best to invoke the `preprocessor` directly in this case.
ds = ds.map(
    lambda first, second: preprocessor(x=(first, second)),
    num_parallel_calls=tf.data.AUTOTUNE,
)
----

<span style="float:right;">[[source]](https://github.com/keras-team/keras-nlp/tree/v0.15.1/keras_nlp/src/models/preprocessor.py#L125)</span>

### `from_preset` method


```python
XLMRobertaMaskedLMPreprocessor.from_preset(preset, **kwargs)

從模型預設集實例化 keras_nlp.models.Preprocessor

預設集是配置、權重和其他檔案資源的目錄,用於儲存和載入預先訓練的模型。preset 可以作為以下其中一種傳遞

  1. 內建預設集識別碼,例如 'bert_base_en'
  2. Kaggle 模型控點,例如 'kaggle://user/bert/keras/bert_base_en'
  3. Hugging Face 控點,例如 'hf://user/bert_base_en'
  4. 本機預設集目錄的路徑,例如 './bert_base_en'

對於任何 Preprocessor 子類別,您可以執行 cls.presets.keys() 來列出類別上可用的所有內建預設集。

由於給定模型通常有多個預處理類別,因此應該在特定子類別上呼叫此方法,例如 keras_nlp.models.BertTextClassifierPreprocessor.from_preset()

參數

  • preset:字串。內建預設集識別碼、Kaggle 模型控點、Hugging Face 控點或本機目錄的路徑。

範例

# Load a preprocessor for Gemma generation.
preprocessor = keras_nlp.models.GemmaCausalLMPreprocessor.from_preset(
    "gemma_2b_en",
)

# Load a preprocessor for Bert classification.
preprocessor = keras_nlp.models.BertTextClassifierPreprocessor.from_preset(
    "bert_base_en",
)
預設集名稱 參數 說明
xlm_roberta_base_multi 277.45M 12 層 XLM-RoBERTa 模型,其中保留大小寫。在 100 種語言的 CommonCrawl 上進行訓練。
xlm_roberta_large_multi 558.84M 24 層 XLM-RoBERTa 模型,其中保留大小寫。在 100 種語言的 CommonCrawl 上進行訓練。

tokenizer 屬性

keras_nlp.models.XLMRobertaMaskedLMPreprocessor.tokenizer

用於將字串標記化的標記器。