Hugging Face 的 LOGO

Transformers 文件

Open-Llama

Hugging Face's logo
加入 Hugging Face 社群

並獲得增強的文件體驗

開始使用

Open-Llama

PyTorch

該模型僅處於維護模式，我們不接受任何更改其程式碼的新 PR。

如果您在執行此模型時遇到任何問題，請重新安裝支援此模型的最後一個版本：v4.31.0。您可以透過執行以下命令來執行此操作：pip install -U transformers==4.31.0。

該模型不同於 Hugging Face Hub 上的 OpenLLaMA 模型，後者主要使用 LLaMA 架構。

概述

Open-Llama 模型是由社群開發者 s-JoL 在開源專案 Open-Llama 中提出的。

該模型主要基於 LLaMA 並進行了一些修改，融合了 Xformers 的記憶體高效注意力機制、Bloom 的穩定嵌入以及 PaLM 的共享輸入輸出嵌入。並且該模型在中英文語料上進行了預訓練，使其在中文語言任務上表現更佳。

此模型由 s-JoL 貢獻。原始程式碼由 s-JoL 釋出於 GitHub，但現已移除。

OpenLlamaConfig

class transformers.OpenLlamaConfig

< >

( vocab_size = 100000 hidden_size = 4096 intermediate_size = 11008 num_hidden_layers = 32 num_attention_heads = 32 hidden_act = 'silu' max_position_embeddings = 2048 initializer_range = 0.02 rms_norm_eps = 1e-06 use_cache = True pad_token_id = 0 bos_token_id = 1 eos_token_id = 2 tie_word_embeddings = False use_memory_efficient_attention = True hidden_dropout_prob = 0.1 attention_dropout_prob = 0.1 use_stable_embedding = True shared_input_output_embedding = True rope_theta = 10000.0 rope_scaling = None **kwargs )

引數

  • vocab_size (int, 可選, 預設為 32000) — Open-Llama 模型的詞彙表大小。定義了在呼叫 OpenLlamaModel 時，可以透過 inputs_ids 表示的不同標記（token）的數量。
  • hidden_size (int, 可選, 預設為 4096) — 隱藏表示的維度。
  • intermediate_size (int, 可選, 預設為 11008) — MLP 表示的維度。
  • num_hidden_layers (int, 可選, 預設為 32) — Transformer 編碼器中的隱藏層數量。
  • num_attention_heads (int, 可選, 預設為 32) — Transformer 編碼器中每個注意力層的注意力頭數量。
  • hidden_act (str 或 function, 可選, 預設為 "silu") — 解碼器中的非線性啟用函式（函式或字串）。
  • max_position_embeddings (int, 可選, 預設為 2048) — 該模型可能使用的最大序列長度。通常將其設定為一個較大的值以備不時之需（例如 512、1024 或 2048）。
  • initializer_range (float, 可選, 預設為 0.02) — 用於初始化所有權重矩陣的 truncated_normal_initializer 的標準差。
  • rms_norm_eps (float, 可選, 預設為 1e-12) — rms 歸一化層使用的 epsilon 值。
  • use_cache (bool, 可選, 預設為 True) — 模型是否應返回最後一個鍵/值注意力（並非所有模型都使用）。僅當 config.is_decoder=True 時相關。
  • tie_word_embeddings(bool, 可選, 預設為 False) — 是否繫結詞嵌入權重
  • rope_theta (float, 可選, 預設為 10000.0) — RoPE 嵌入的基礎週期。
  • rope_scaling (Dict, 可選) — 包含 RoPE 嵌入縮放配置的字典。目前支援兩種縮放策略：線性和動態。它們的縮放因子必須是大於 1 的浮點數。預期格式為 {"type": 策略名稱, "factor": 縮放因子}。使用此標誌時，不要將 max_position_embeddings 更新為預期的新最大值。有關這些縮放策略行為的更多資訊，請參閱以下帖子：https://www.reddit.com/r/LocalLLaMA/comments/14mrgpr/dynamically_scaled_rope_further_increases/。這是一個實驗性功能，未來版本中可能會有破壞性的 API 變更。
  • 示例 —

這是一個用於儲存 OpenLlamaModel 配置的配置類。它用於根據指定的引數例項化一個 Open-Llama 模型，定義模型架構。使用預設值例項化配置將產生與 s-JoL/Open-Llama-V1 類似的配置。

配置物件繼承自 PretrainedConfig，可用於控制模型輸出。有關更多資訊，請閱讀 PretrainedConfig 的文件。

>>> from transformers import OpenLlamaModel, OpenLlamaConfig

>>> # Initializing a Open-Llama open_llama-7b style configuration
>>> configuration = OpenLlamaConfig()

>>> # Initializing a model from the open_llama-7b style configuration
>>> model = OpenLlamaModel(configuration)

>>> # Accessing the model configuration
>>> configuration = model.config

OpenLlamaModel

class transformers.OpenLlamaModel

< >

( config: OpenLlamaConfig )

引數

  • config (OpenLlamaConfig) — 模型配置類，包含模型的所有引數。使用配置檔案進行初始化不會載入與模型關聯的權重，只會載入配置。請檢視 from_pretrained() 方法來載入模型權重。
  • config — OpenLlamaConfig

基礎的 Open-Llama 模型，輸出原始的隱藏狀態，沒有任何特定的頭部。此模型繼承自 PreTrainedModel。請檢視超類文件以瞭解庫為所有模型實現的通用方法（如​​下載或儲存、調整輸入嵌入大小、修剪頭部等）。

此模型也是 PyTorch torch.nn.Module 的子類。可以像常規 PyTorch 模組一樣使用它，並參考 PyTorch 文件瞭解所有與常規用法和行為相關的事項。

由 config.num_hidden_layers 層組成的 Transformer 解碼器。每一層都是一個 OpenLlamaDecoderLayer

forward

< >

( input_ids: typing.Optional[torch.LongTensor] = None attention_mask: typing.Optional[torch.Tensor] = None position_ids: typing.Optional[torch.LongTensor] = None past_key_values: typing.Optional[list[torch.FloatTensor]] = None inputs_embeds: typing.Optional[torch.FloatTensor] = None use_cache: typing.Optional[bool] = None output_attentions: typing.Optional[bool] = None output_hidden_states: typing.Optional[bool] = None return_dict: typing.Optional[bool] = None )

引數

  • input_ids (torch.LongTensor，形狀為 (batch_size, sequence_length)) — 詞彙表中輸入序列標記的索引。如果提供，填充部分將預設被忽略。

    可以使用 AutoTokenizer 獲取索引。有關詳細資訊，請參閱 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。

    什麼是 input IDs？

  • attention_mask (torch.Tensor，形狀為 (batch_size, sequence_length), 可選) — 用於避免對填充標記索引執行注意力的掩碼。掩碼值選自 [0, 1]：

    • 1 表示標記未被掩碼,
    • 0 表示標記被掩碼。

    什麼是注意力掩碼？

    可以使用 AutoTokenizer 獲取索引。有關詳細資訊，請參閱 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。

    如果使用了 past_key_values，可以選擇只輸入最後一個 decoder_input_ids（參見 past_key_values）。

    如果您想更改填充行為，應閱讀 modeling_opt._prepare_decoder_attention_mask 並根據需要進行修改。有關預設策略的更多資訊，請參閱論文中的圖 1。

    • 1 表示頭未被掩碼,
    • 0 表示頭被掩碼。
  • position_ids (torch.LongTensor，形狀為 (batch_size, sequence_length), 可選) — 每個輸入序列標記在位置嵌入中的位置索引。選自範圍 [0, config.n_positions - 1]。

    什麼是位置 ID？

  • past_key_values (tuple(tuple(torch.FloatTensor)), 可選，在傳遞 use_cache=True 或 config.use_cache=True 時返回) — 長度為 config.n_layers 的 tuple(torch.FloatTensor) 元組，每個元組包含 2 個形狀為 (batch_size, num_heads, sequence_length, embed_size_per_head) 的張量，以及 2 個額外的形狀為 (batch_size, num_heads, encoder_sequence_length, embed_size_per_head) 的張量。

    包含預計算的隱藏狀態（自注意塊和交叉注意塊中的鍵和值），可用於（參見 past_key_values 輸入）加速序列解碼。

    如果使用 past_key_values，使用者可以選擇只輸入最後一個 decoder_input_ids（那些沒有為其提供過去鍵值狀態的輸入）形狀為 (batch_size, 1)，而不是所有形狀為 (batch_size, sequence_length) 的 decoder_input_ids。

  • inputs_embeds (torch.FloatTensor，形狀為 (batch_size, sequence_length, hidden_size), 可選) — 可選地，您可以選擇直接傳遞嵌入表示，而不是傳遞 input_ids。如果您希望比模型內部嵌入查詢矩陣更好地控制如何將 input_ids 索引轉換為關聯向量，這將非常有用。
  • use_cache (bool, 可選) — 如果設定為 True，將返回 past_key_values 鍵值狀態，可用於加速解碼（參見 past_key_values）。
  • output_attentions (bool, 可選) — 是否返回所有注意力層的注意力張量。有關更多詳細資訊，請參閱返回張量下的 attentions。
  • output_hidden_states (bool, 可選) — 是否返回所有層的隱藏狀態。有關更多詳細資訊，請參閱返回張量下的 hidden_states。
  • return_dict (bool, 可選) — 是否返回一個 ModelOutput 而不是一個普通的元組。

OpenLlamaModel 的 forward 方法重寫了 __call__ 特殊方法。

儘管前向傳播的流程需要在此函式中定義，但之後應該呼叫 Module 例項而不是這個函式，因為前者會負責執行前處理和後處理步驟，而後者會靜默地忽略它們。

OpenLlamaForCausalLM

class transformers.OpenLlamaForCausalLM

< >

( config )

forward

< >

( input_ids: typing.Optional[torch.LongTensor] = None attention_mask: typing.Optional[torch.Tensor] = None position_ids: typing.Optional[torch.LongTensor] = None past_key_values: typing.Optional[list[torch.FloatTensor]] = None inputs_embeds: typing.Optional[torch.FloatTensor] = None labels: typing.Optional[torch.LongTensor] = None use_cache: typing.Optional[bool] = None output_attentions: typing.Optional[bool] = None output_hidden_states: typing.Optional[bool] = None return_dict: typing.Optional[bool] = None ) → transformers.modeling_outputs.CausalLMOutputWithPast 或 tuple(torch.FloatTensor)

引數

  • input_ids (torch.LongTensor，形狀為 (batch_size, sequence_length)) — 詞彙表中輸入序列標記的索引。如果提供填充，預設情況下將被忽略。

    可以使用 AutoTokenizer 獲取索引。有關詳細資訊，請參閱 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。

    什麼是輸入 ID？

  • attention_mask (torch.Tensor，形狀為 (batch_size, sequence_length), 可選) — 用於避免對填充標記索引執行注意力操作的掩碼。掩碼值選自 [0, 1]：

    • 1 表示標記未被掩碼，
    • 0 表示標記被掩碼。

    什麼是注意力掩碼？

    可以使用 AutoTokenizer 獲取索引。有關詳細資訊，請參閱 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。

    如果使用 past_key_values，則可以選擇只輸入最後一個 decoder_input_ids（參見 past_key_values）。

    如果你想更改填充行為，應閱讀 modeling_opt._prepare_decoder_attention_mask 並根據需要進行修改。有關預設策略的更多資訊，請參閱論文中的圖 1。

    • 1 表示注意力頭未被掩碼，
    • 0 表示注意力頭被掩碼。
  • position_ids (torch.LongTensor，形狀為 (batch_size, sequence_length), 可選) — 位置嵌入中每個輸入序列標記的位置索引。選定範圍為 [0, config.n_positions - 1]。

    什麼是位置 ID？

  • past_key_values (tuple(tuple(torch.FloatTensor)), 可選，當傳遞 use_cache=True 或 config.use_cache=True 時返回) — 長度為 config.n_layers 的 tuple(torch.FloatTensor) 元組，每個元組包含 2 個形狀為 (batch_size, num_heads, sequence_length, embed_size_per_head) 的張量和 2 個形狀為 (batch_size, num_heads, encoder_sequence_length, embed_size_per_head) 的附加張量。

    包含預計算的隱藏狀態（自注意力和交叉注意力塊中的鍵和值），可用於加速順序解碼（參見 past_key_values 輸入）。

    如果使用 past_key_values，使用者可以選擇只輸入最後一個 decoder_input_ids（那些沒有為其提供過去鍵值狀態的標記），其形狀為 (batch_size, 1)，而不是所有形狀為 (batch_size, sequence_length) 的 decoder_input_ids。

  • inputs_embeds (torch.FloatTensor，形狀為 (batch_size, sequence_length, hidden_size), 可選) — 可選地，你可以選擇直接傳遞嵌入表示，而不是傳遞 input_ids。如果你希望比模型內部的嵌入查詢矩陣有更多控制權來將 input_ids 索引轉換為關聯向量，這會很有用。
  • use_cache (bool, 可選) — 如果設定為 True，將返回 past_key_values 鍵值狀態，可用於加速解碼（參見 past_key_values）。
  • output_attentions (bool, 可選) — 是否返回所有注意力層的注意力張量。有關更多詳細資訊，請參閱返回張量下的 attentions。
  • output_hidden_states (bool, 可選) — 是否返回所有層的隱藏狀態。有關更多詳細資訊，請參閱返回張量下的 hidden_states。
  • return_dict (bool, 可選) — 是否返回一個 ModelOutput 而不是一個普通的元組。
  • labels (torch.LongTensor，形狀為 (batch_size, sequence_length), 可選) — 用於計算掩碼語言建模損失的標籤。索引應在 [0, ..., config.vocab_size] 或 -100 之間（參見 input_ids 文件）。索引設定為 -100 的標記將被忽略（掩碼），損失僅對標籤在 [0, ..., config.vocab_size] 內的標記計算。

返回

transformers.modeling_outputs.CausalLMOutputWithPast 或 tuple(torch.FloatTensor)

一個 transformers.modeling_outputs.CausalLMOutputWithPast 或一個 torch.FloatTensor 的元組（如果傳遞了 return_dict=False 或當 config.return_dict=False 時），根據配置（OpenLlamaConfig）和輸入，包含各種元素。

  • loss (torch.FloatTensor 形狀為 (1,)，可選，當提供 labels 時返回) — 語言建模損失（用於下一個 token 預測）。

  • logits (形狀為 (batch_size, sequence_length, config.vocab_size) 的 torch.FloatTensor) — 語言建模頭部的預測分數（SoftMax 之前的每個詞彙標記的分數）。

  • past_key_values (Cache, 可選，當傳遞 use_cache=True 或 config.use_cache=True 時返回) — 這是一個 Cache 例項。更多詳情請參閱我們的 KV 快取指南。

    包含預計算的隱藏狀態（自注意力塊中的鍵和值），可用於（參見 past_key_values 輸入）加速順序解碼。

  • hidden_states (tuple(torch.FloatTensor), 可選，當傳遞 output_hidden_states=True 或 config.output_hidden_states=True 時返回) — torch.FloatTensor 的元組（如果模型有嵌入層，一個是嵌入層的輸出，另一個是每一層的輸出），形狀為 (batch_size, sequence_length, hidden_size)。

    模型在每個層輸出的隱藏狀態以及可選的初始嵌入輸出。

  • attentions (tuple(torch.FloatTensor), 可選，當傳遞 output_attentions=True 或 config.output_attentions=True 時返回) — torch.FloatTensor 的元組（每層一個），形狀為 (batch_size, num_heads, sequence_length, sequence_length)。

    注意力 softmax 後的注意力權重，用於計算自注意力頭中的加權平均值。

OpenLlamaForCausalLM 的 forward 方法重寫了 __call__ 特殊方法。

儘管前向傳播的流程需要在此函式中定義，但之後應該呼叫 Module 例項而不是這個函式，因為前者會負責執行前處理和後處理步驟，而後者會靜默地忽略它們。

示例

>>> from transformers import AutoTokenizer, OpenLlamaForCausalLM

>>> model = OpenLlamaForCausalLM.from_pretrained("openlm-research/open_llama_7b")
>>> tokenizer = AutoTokenizer.from_pretrained("openlm-research/open_llama_7b")

>>> prompt = "Hey, are you conscious? Can you talk to me?"
>>> inputs = tokenizer(prompt, return_tensors="pt")

>>> # Generate
>>> generate_ids = model.generate(inputs.input_ids, max_length=30)
>>> tokenizer.batch_decode(generate_ids, skip_special_tokens=True, clean_up_tokenization_spaces=False)[0]
"Hey, are you conscious? Can you talk to me?\nI'm not conscious, but I can talk to you."

OpenLlamaForSequenceClassification

class transformers.OpenLlamaForSequenceClassification

< >

( config )

引數

  • config (OpenLlamaConfig) — 模型配置類，包含模型的所有引數。使用配置檔案初始化不會載入與模型相關的權重，只會載入配置。請檢視 from_pretrained() 方法來載入模型權重。

在 LLaMa 模型 Transformer 的頂部添加了一個序列分類頭（線性層）。

OpenLlamaForSequenceClassification 使用最後一個標記進行分類，就像其他因果模型（例如 GPT-2）一樣。

由於它對最後一個標記進行分類，因此需要知道最後一個標記的位置。如果配置中定義了 pad_token_id，它會找到每行中不是填充標記的最後一個標記。如果沒有定義 pad_token_id，它會簡單地取每行批次中的最後一個值。由於在傳遞 inputs_embeds 而不是 input_ids 時無法猜測填充標記，它會做同樣的操作（取每行批次中的最後一個值）。

該模型繼承自 PreTrainedModel。請檢視超類文件，瞭解庫為所有模型實現的通用方法（例如下載或儲存、調整輸入嵌入大小、修剪注意力頭等）。

此模型也是 PyTorch torch.nn.Module 的子類。可以像常規 PyTorch 模組一樣使用它，並參考 PyTorch 文件瞭解所有與常規用法和行為相關的事項。

forward

< >

( input_ids: typing.Optional[torch.LongTensor] = None attention_mask: typing.Optional[torch.Tensor] = None position_ids: typing.Optional[torch.LongTensor] = None past_key_values: typing.Optional[list[torch.FloatTensor]] = None inputs_embeds: typing.Optional[torch.FloatTensor] = None labels: typing.Optional[torch.LongTensor] = None use_cache: typing.Optional[bool] = None output_attentions: typing.Optional[bool] = None output_hidden_states: typing.Optional[bool] = None return_dict: typing.Optional[bool] = None )

引數

  • input_ids (torch.LongTensor，形狀為 (batch_size, sequence_length)) — 詞彙表中輸入序列標記的索引。如果提供填充，預設情況下將被忽略。

    可以使用 AutoTokenizer 獲取索引。有關詳細資訊，請參閱 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。

    什麼是輸入 ID？

  • attention_mask (torch.Tensor，形狀為 (batch_size, sequence_length), 可選) — 用於避免對填充標記索引執行注意力操作的掩碼。掩碼值選自 [0, 1]：

    • 1 表示標記未被掩碼，
    • 0 表示標記被掩碼。

    什麼是注意力掩碼？

    可以使用 AutoTokenizer 獲取索引。有關詳細資訊，請參閱 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。

    如果使用 past_key_values，則可以選擇只輸入最後一個 decoder_input_ids（參見 past_key_values）。

    如果你想更改填充行為，應閱讀 modeling_opt._prepare_decoder_attention_mask 並根據需要進行修改。有關預設策略的更多資訊，請參閱論文中的圖 1。

    • 1 表示注意力頭未被掩碼，
    • 0 表示注意力頭被掩碼。
  • position_ids (torch.LongTensor，形狀為 (batch_size, sequence_length), 可選) — 位置嵌入中每個輸入序列標記的位置索引。選定範圍為 [0, config.n_positions - 1]。

    什麼是位置 ID？

  • past_key_values (tuple(tuple(torch.FloatTensor)), 可選，當傳遞 use_cache=True 或 config.use_cache=True 時返回) — 長度為 config.n_layers 的 tuple(torch.FloatTensor) 元組，每個元組包含 2 個形狀為 (batch_size, num_heads, sequence_length, embed_size_per_head) 的張量和 2 個形狀為 (batch_size, num_heads, encoder_sequence_length, embed_size_per_head) 的附加張量。

    包含預計算的隱藏狀態（自注意力和交叉注意力塊中的鍵和值），可用於加速順序解碼（參見 past_key_values 輸入）。

    如果使用 past_key_values，使用者可以選擇只輸入最後一個 decoder_input_ids（那些沒有為其提供過去鍵值狀態的標記），其形狀為 (batch_size, 1)，而不是所有形狀為 (batch_size, sequence_length) 的 decoder_input_ids。

  • inputs_embeds (torch.FloatTensor，形狀為 (batch_size, sequence_length, hidden_size), 可選) — 可選地，你可以選擇直接傳遞嵌入表示，而不是傳遞 input_ids。如果你希望比模型內部的嵌入查詢矩陣有更多控制權來將 input_ids 索引轉換為關聯向量，這會很有用。
  • use_cache (bool, 可選) — 如果設定為 True，將返回 past_key_values 鍵值狀態，可用於加速解碼（參見 past_key_values）。
  • output_attentions (bool, 可選) — 是否返回所有注意力層的注意力張量。有關更多詳細資訊，請參閱返回張量下的 attentions。
  • output_hidden_states (bool, 可選) — 是否返回所有層的隱藏狀態。有關更多詳細資訊，請參閱返回張量下的 hidden_states。
  • return_dict (bool, 可選) — 是否返回一個 ModelOutput 而不是一個普通的元組。
  • labels (torch.LongTensor，形狀為 (batch_size,), 可選) — 用於計算序列分類/迴歸損失的標籤。索引應在 [0, ..., config.num_labels - 1] 範圍內。如果 config.num_labels == 1，則計算迴歸損失（均方損失），如果 config.num_labels > 1，則計算分類損失（交叉熵）。

OpenLlamaForSequenceClassification 的 forward 方法重寫了 __call__ 特殊方法。

儘管前向傳播的流程需要在此函式中定義，但之後應該呼叫 Module 例項而不是這個函式，因為前者會負責執行前處理和後處理步驟，而後者會靜默地忽略它們。

< > 在 GitHub 上更新

←OLMoE OPT→
© . This site is unofficial and not affiliated with Hugging Face, Inc.