Transformers 文件

DBRX

Transformers

加入 Hugging Face 社群

並獲得增強的文件體驗

在模型、資料集和 Spaces 上進行協作

透過加速推理獲得更快的示例

切換文件主題

開始使用

DBRX

概述

DBRX 是一款基於 Transformer 的僅解碼器大型語言模型（LLM），透過下一個詞元預測進行訓練。它採用細粒度的混合專家（MoE）架構，總引數量為 1320 億，其中任意輸入上啟用的引數為 360 億。它在 12 萬億詞元的文字和程式碼資料上進行了預訓練。與其他開放的 MoE 模型如 Mixtral-8x7B 和 Grok-1 相比，DBRX 是細粒度的，意味著它使用更多數量的較小專家。DBRX 有 16 個專家並選擇 4 個，而 Mixtral-8x7B 和 Grok-1 有 8 個專家並選擇 2 個。這提供了 65 倍更多的專家組合可能性，我們發現這提高了模型質量。DBRX 使用旋轉位置編碼（RoPE）、門控線性單元（GLU）和分組查詢注意力（GQA）。它是一個基於 BPE 的模型，並使用 tiktoken 倉庫中描述的 GPT-4 分詞器。我們基於詳盡的評估和擴充套件實驗做出了這些選擇。

DBRX 在 12 萬億詞元的精心策劃資料上進行了預訓練，最大上下文長度為 32K 詞元。我們估計，這些資料在單位詞元上的質量比我們用於預訓練 MPT 系列模型的資料至少好 2 倍。這個新資料集是使用全套 Databricks 工具開發的，包括用於資料處理的 Apache Spark™ 和 Databricks notebooks，以及用於資料管理和治理的 Unity Catalog。我們使用課程學習進行預訓練，在訓練過程中改變資料混合方式，我們發現這種方式能顯著提高模型質量。

關於 DBRX Instruct 和 DBRX Base 的更詳細資訊可以在我們的技術部落格文章中找到。

此模型由 eitan-turok 和 abhi-db 貢獻。原始程式碼可以在這裡找到，但這可能不是最新的。

用法示例

generate() 方法可用於使用 DBRX 生成文字。您可以使用標準注意力實現、flash-attention 和 PyTorch 縮放點積注意力進行生成。後兩種注意力實現可以提速。

from transformers import DbrxForCausalLM, AutoTokenizer
import torch

tokenizer = AutoTokenizer.from_pretrained("databricks/dbrx-instruct", token="YOUR_HF_TOKEN")
model = DbrxForCausalLM.from_pretrained(
    "databricks/dbrx-instruct",
    device_map="auto",
    torch_dtype=torch.bfloat16,
    token="YOUR_HF_TOKEN",
    )

input_text = "What does it take to build a great LLM?"
messages = [{"role": "user", "content": input_text}]
input_ids = tokenizer.apply_chat_template(messages, return_dict=True, tokenize=True, add_generation_prompt=True, return_tensors="pt").to("cuda")

outputs = model.generate(**input_ids, max_new_tokens=200)
print(tokenizer.decode(outputs[0]))

如果您已安裝 flash-attention (pip install flash-attn)，則可以更快地生成。（HuggingFace 關於 flash-attention 的文件可以在這裡找到。）

from transformers import DbrxForCausalLM, AutoTokenizer
import torch

tokenizer = AutoTokenizer.from_pretrained("databricks/dbrx-instruct", token="YOUR_HF_TOKEN")
model = DbrxForCausalLM.from_pretrained(
    "databricks/dbrx-instruct",
    device_map="auto",
    torch_dtype=torch.bfloat16,
    token="YOUR_HF_TOKEN",
    attn_implementation="flash_attention_2",
    )

input_text = "What does it take to build a great LLM?"
messages = [{"role": "user", "content": input_text}]
input_ids = tokenizer.apply_chat_template(messages, return_dict=True, tokenize=True, add_generation_prompt=True, return_tensors="pt").to("cuda")

outputs = model.generate(**input_ids, max_new_tokens=200)
print(tokenizer.decode(outputs[0]))

您還可以使用 PyTorch 縮放點積注意力來更快地生成。（HuggingFace 關於縮放點積注意力的文件可以在這裡找到。）

from transformers import DbrxForCausalLM, AutoTokenizer
import torch

tokenizer = AutoTokenizer.from_pretrained("databricks/dbrx-instruct", token="YOUR_HF_TOKEN")
model = DbrxForCausalLM.from_pretrained(
    "databricks/dbrx-instruct",
    device_map="auto",
    torch_dtype=torch.bfloat16,
    token="YOUR_HF_TOKEN",
    attn_implementation="sdpa",
    )

input_text = "What does it take to build a great LLM?"
messages = [{"role": "user", "content": input_text}]
input_ids = tokenizer.apply_chat_template(messages, return_dict=True, tokenize=True, add_generation_prompt=True, return_tensors="pt").to("cuda")

outputs = model.generate(**input_ids, max_new_tokens=200)
print(tokenizer.decode(outputs[0]))

DbrxConfig

class transformers.DbrxConfig

< 源 >

( d_model: int = 2048 n_heads: int = 16 n_layers: int = 24 max_seq_len: int = 2048 vocab_size: int = 32000 resid_pdrop: float = 0.0 emb_pdrop: float = 0.0 attn_config: typing.Optional[transformers.models.dbrx.configuration_dbrx.DbrxAttentionConfig] = None ffn_config: typing.Optional[transformers.models.dbrx.configuration_dbrx.DbrxFFNConfig] = None use_cache: bool = True initializer_range: float = 0.02 output_router_logits: bool = False **kwargs: typing.Any )

引數

d_model (int, 可選, 預設為 2048) — 嵌入和隱藏狀態的維度。
n_heads (int, 可選, 預設為 16) — Transformer 編碼器中每個注意力層的注意力頭數。
n_layers (int, 可選, 預設為 24) — Transformer 編碼器中的隱藏層數。
max_seq_len (int, 可選, 預設為 2048) — 模型的最大序列長度。
vocab_size (int, 可選, 預設為 32000) — Dbrx 模型的詞彙表大小。定義了呼叫 DbrxModel 時傳入的 inputs_ids 可以表示的最大不同詞元數量。
resid_pdrop (float, 可選, 預設為 0.0) — 應用於注意力輸出（在與殘差結合之前）的 dropout 機率。
emb_pdrop (float, 可選, 預設為 0.0) — 嵌入層的 dropout 機率。
attn_config (dict, 可選) — 用於配置模型注意力模組的字典。
ffn_config (dict, 可選) — 用於配置模型 FFN 模組的字典。
use_cache (bool, 可選, 預設為 True) — 模型是否應返回最後一個鍵/值注意力（並非所有模型都使用）。
initializer_range (float, 可選, 預設為 0.02) — 用於初始化所有權重矩陣的 truncated_normal_initializer 的標準差。
output_router_logits (bool, 可選, 預設為 False) — 是否由模型返回路由器 logits。啟用此選項還將允許模型輸出輔助損失。有關更多詳細資訊，請參見此處。

這是用於儲存 DbrxModel 配置的配置類。它用於根據指定的引數例項化 Dbrx 模型，定義模型架構。使用預設值例項化配置將產生與 databricks/dbrx-instruct 架構不同的配置。

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

示例

>>> from transformers import DbrxConfig, DbrxModel

>>> # Initializing a Dbrx configuration
>>> configuration = DbrxConfig(n_layers=2, d_model=256, n_heads=8, vocab_size=128)

>>> # Initializing a model (with random weights) from the configuration
>>> model = DbrxModel(configuration)

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

DbrxModel

class transformers.DbrxModel

< 源 >

( config: DbrxConfig )

引數

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

原始的 Dbrx 模型，輸出原始的隱藏狀態，沒有任何特定的頭部。

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

該模型也是 PyTorch torch.nn.Module 的子類。可以像常規的 PyTorch Module 一樣使用它，並參考 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[transformers.cache_utils.Cache] = None inputs_embeds: typing.Optional[torch.Tensor] = None use_cache: typing.Optional[bool] = None output_attentions: typing.Optional[bool] = None output_hidden_states: typing.Optional[bool] = None output_router_logits: typing.Optional[bool] = None return_dict: typing.Optional[bool] = None cache_position: typing.Optional[torch.LongTensor] = None **kwargs ) → transformers.modeling_outputs.MoeModelOutputWithPast 或 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 表示被掩碼的詞元。
什麼是注意力掩碼？
position_ids (torch.LongTensor，形狀為 (batch_size, sequence_length)，可選) — 位置嵌入中每個輸入序列詞元的位置索引。選定範圍為 [0, config.n_positions - 1]。

什麼是位置 ID？
past_key_values (~cache_utils.Cache, 可選) — 預計算的隱藏狀態（自注意力塊和交叉注意力塊中的鍵和值），可用於加速序列解碼。這通常包括在解碼的前一階段由模型返回的 `past_key_values`，當 `use_cache=True` 或 `config.use_cache=True` 時。

允許兩種格式：
- 一個 Cache 例項，請參閱我們的 kv 快取指南；
- 長度為 `config.n_layers` 的 `tuple(torch.FloatTensor)` 元組，每個元組有兩個形狀為 `(batch_size, num_heads, sequence_length, embed_size_per_head)` 的張量。這也稱為舊版快取格式。
模型將輸出與輸入相同的快取格式。如果未傳遞 `past_key_values`，將返回舊版快取格式。

如果使用 `past_key_values`，使用者可以選擇只輸入最後一個 `input_ids`（那些沒有為其提供過去鍵值狀態的 `input_ids`），形狀為 `(batch_size, 1)`，而不是所有形狀為 `(batch_size, sequence_length)` 的 `input_ids`。
inputs_embeds (torch.Tensor，形狀為 (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`。
output_router_logits (bool, 可選) — 是否返回所有路由器的 logits。它們對於計算路由器損失很有用，在推理期間不應返回。
return_dict (bool, 可選) — 是否返回一個 ModelOutput 而不是一個普通的元組。
cache_position (形狀為 (sequence_length) 的 torch.LongTensor, 可選) — 表示輸入序列中詞元位置的索引。與 position_ids 不同，此張量不受填充的影響。它用於在正確的位置更新快取並推斷完整的序列長度。

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

一個 transformers.modeling_outputs.MoeModelOutputWithPast 或一個 torch.FloatTensor 的元組（如果傳遞了 return_dict=False 或 config.return_dict=False），根據配置（DbrxConfig）和輸入，包含不同的元素。

last_hidden_state (torch.FloatTensor, 形狀為 (batch_size, sequence_length, hidden_size)) — 模型最後一層輸出的隱藏狀態序列。
past_key_values (Cache, 可選, 在傳遞 use_cache=True 或 config.use_cache=True 時返回) — 這是一個 Cache 例項。更多詳情，請參閱我們的 kv 快取指南。

包含預先計算的隱藏狀態（自注意力塊中的鍵和值，如果 config.is_encoder_decoder=True，則還包括交叉注意力塊中的鍵和值），可用於（參見 past_key_values 輸入）加速序列解碼。
hidden_states (tuple(torch.FloatTensor), 可選, 在傳遞 output_hidden_states=True 或 config.output_hidden_states=True 時返回) — 形狀為 (batch_size, sequence_length, hidden_size) 的 torch.FloatTensor 元組（一個用於嵌入層的輸出，如果模型有嵌入層，+ 一個用於每層的輸出）。

模型在每個層輸出的隱藏狀態以及可選的初始嵌入輸出。
attentions (tuple(torch.FloatTensor), 可選, 在傳遞 output_attentions=True 或 config.output_attentions=True 時返回) — 形狀為 (batch_size, num_heads, sequence_length, sequence_length) 的 torch.FloatTensor 元組（每層一個）。

注意力 softmax 後的注意力權重，用於計算自注意力頭中的加權平均值。
router_logits (tuple(torch.FloatTensor), 可選, 在傳遞 output_router_probs=True 和 config.add_router_probs=True 或 config.output_router_probs=True 時返回) — 形狀為 (batch_size, sequence_length, num_experts) 的 torch.FloatTensor 元組（每層一個）。

由 MoE 路由器計算的原始路由器對數（softmax 後），這些術語用於計算專家混合模型的輔助損失。

DbrxModel 的前向方法，覆蓋了 __call__ 特殊方法。

雖然前向傳遞的流程需要在此函式內定義，但之後應該呼叫 Module 例項而不是此函式，因為前者會處理執行前後處理步驟，而後者會靜默地忽略它們。

DbrxForCausalLM

class transformers.DbrxForCausalLM

< source >

( config: DbrxConfig )

引數

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

用於因果語言建模的 DBRX 模型轉換器。

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

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

forward

< source >

( 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[transformers.cache_utils.Cache] = None inputs_embeds: typing.Optional[torch.Tensor] = 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 output_router_logits: typing.Optional[bool] = None return_dict: typing.Optional[bool] = None cache_position: typing.Optional[torch.LongTensor] = None logits_to_keep: typing.Union[int, torch.Tensor] = 0 **kwargs ) → transformers.modeling_outputs.MoeCausalLMOutputWithPast 或 tuple(torch.FloatTensor)

引數

input_ids (形狀為 (batch_size, sequence_length) 的 torch.LongTensor, 可選) — 詞彙表中輸入序列詞元的索引。預設情況下會忽略填充。

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

什麼是輸入 ID？
attention_mask (形狀為 (batch_size, sequence_length) 的 torch.Tensor, 可選) — 用於避免在填充詞元索引上執行注意力的掩碼。掩碼值在 [0, 1] 中選擇：
- 1 表示未被遮蔽的詞元，
- 0 表示被遮蔽的詞元。
什麼是注意力掩碼？
position_ids (形狀為 (batch_size, sequence_length) 的 torch.LongTensor, 可選) — 位置嵌入中每個輸入序列詞元的位置索引。在 [0, config.n_positions - 1] 範圍內選擇。

什麼是位置 ID？
past_key_values (~cache_utils.Cache, 可選) — 預先計算的隱藏狀態（自注意力塊和交叉注意力塊中的鍵和值），可用於加速序列解碼。這通常是模型在先前解碼階段返回的 past_key_values，當 use_cache=True 或 config.use_cache=True 時。

允許兩種格式：
- 一個 Cache 例項，請參閱我們的 kv 快取指南；
- 長度為 config.n_layers 的 tuple(torch.FloatTensor) 元組，每個元組有兩個形狀為 (batch_size, num_heads, sequence_length, embed_size_per_head) 的張量）。這也被稱為傳統快取格式。
模型將輸出與輸入相同的快取格式。如果未傳遞 past_key_values，將返回傳統快取格式。

如果使用 past_key_values，使用者可以選擇只輸入最後一個 input_ids（那些沒有提供過去鍵值狀態的詞元），形狀為 (batch_size, 1)，而不是所有形狀為 (batch_size, sequence_length) 的 input_ids。
inputs_embeds (形狀為 (batch_size, sequence_length, hidden_size) 的 torch.Tensor, 可選) — 可選地，你可以選擇直接傳遞嵌入表示而不是 input_ids。如果你希望比模型的內部嵌入查詢矩陣更好地控制如何將 input_ids 索引轉換為相關向量，這將非常有用。
labels (形狀為 (batch_size, sequence_length) 的 torch.LongTensor, 可選) — 用於計算掩碼語言建模損失的標籤。索引應在 [0, ..., config.vocab_size] 或 -100 之間（參見 input_ids 文件字串）。索引設定為 -100 的詞元將被忽略（遮蔽），損失僅對標籤在 [0, ..., config.vocab_size] 範圍內的詞元計算。
use_cache (bool, 可選) — 如果設定為 True，將返回 past_key_values 鍵值狀態，可用於加速解碼（參見 past_key_values）。
output_attentions (bool, 可選) — 是否返回所有注意力層的注意力張量。有關更多詳細資訊，請參閱返回張量下的 attentions。
output_hidden_states (bool, 可選) — 是否返回所有層的隱藏狀態。有關更多詳細資訊，請參閱返回張量下的 hidden_states。
output_router_logits (bool, 可選) — 是否返回所有路由器的 logits。它們對於計算路由器損失很有用，在推理期間不應返回。
return_dict (bool, 可選) — 是否返回一個 ModelOutput 而不是一個普通的元組。
cache_position (形狀為 (sequence_length) 的 torch.LongTensor, 可選) — 表示輸入序列中詞元位置的索引。與 position_ids 不同，此張量不受填充的影響。它用於在正確的位置更新快取並推斷完整的序列長度。
logits_to_keep (Union[int, torch.Tensor], 預設為 0) — 如果是 int，則為最後 logits_to_keep 個詞元計算 logits。如果是 0，則為所有 input_ids 計算 logits（特殊情況）。生成時只需要最後一個詞元的 logits，僅為此詞元計算可以節省記憶體，這對於長序列或大詞彙表大小非常重要。如果是一個 torch.Tensor，則必須是一維的，對應於序列長度維度中要保留的索引。這在使用打包張量格式（批處理和序列長度的單個維度）時很有用。

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

一個 transformers.modeling_outputs.MoeCausalLMOutputWithPast 或一個 torch.FloatTensor 的元組（如果傳遞了 return_dict=False 或 config.return_dict=False），根據配置（DbrxConfig）和輸入，包含不同的元素。

loss (torch.FloatTensor 形狀為 (1,)，可選，當提供 labels 時返回) — 語言建模損失（用於下一個 token 預測）。
logits (形狀為 (batch_size, sequence_length, config.vocab_size) 的 torch.FloatTensor) — 語言建模頭部的預測分數（SoftMax 之前的每個詞彙標記的分數）。
aux_loss (torch.FloatTensor，可選，當提供 labels 時返回) — 稀疏模組的輔助損失。
router_logits (tuple(torch.FloatTensor), 可選, 在傳遞 output_router_probs=True 和 config.add_router_probs=True 或 config.output_router_probs=True 時返回) — 形狀為 (batch_size, sequence_length, num_experts) 的 torch.FloatTensor 元組（每層一個）。

由 MoE 路由器計算的原始路由器對數（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 時返回) — 形狀為 (batch_size, sequence_length, hidden_size) 的 torch.FloatTensor 元組（一個用於嵌入層的輸出，如果模型有嵌入層，+ 一個用於每層的輸出）。

模型在每個層輸出的隱藏狀態以及可選的初始嵌入輸出。
attentions (tuple(torch.FloatTensor), 可選, 在傳遞 output_attentions=True 或 config.output_attentions=True 時返回) — 形狀為 (batch_size, num_heads, sequence_length, sequence_length) 的 torch.FloatTensor 元組（每層一個）。

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

DbrxForCausalLM 的前向方法，覆蓋了 __call__ 特殊方法。

雖然前向傳遞的流程需要在此函式內定義，但之後應該呼叫 Module 例項而不是此函式，因為前者會處理執行前後處理步驟，而後者會靜默地忽略它們。

示例

>> from transformers import AutoTokenizer, DbrxForCausalLM

>> model = DbrxForCausalLM.from_pretrained("databricks/dbrx-instruct")
>> tokenizer = AutoTokenizer.from_pretrained("databricks/dbrx-instruct")

>> 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."

< > 在 GitHub 上更新

←CTRL DeBERTa→