Transformers 文档
DBRX
并获得增强的文档体验
开始使用
该模型于 2024-03-27 发布，并于 2024-04-18 添加到 Hugging Face Transformers。
DBRX
概述
DBRX 是一个 基于 Transformer 的仅解码器的大型语言模型（LLM），通过下一个 token 预测进行训练。它采用细粒度的专家混合（MoE）架构，总共有 1320 亿个参数，其中 360 亿个参数在任何输入上是激活的。它在 12T 个 token 的文本和代码数据上进行了预训练。与 Mixtral-8x7B 和 Grok-1 等其他开放式 MoE 模型相比，DBRX 是细粒度的，这意味着它使用更多数量的较小专家。DBRX 有 16 个专家并选择 4 个，而 Mixtral-8x7B 和 Grok-1 有 8 个专家并选择 2 个。这提供了 65 倍更多的专家组合的可能性，并且我们发现这可以提高模型质量。DBRX 使用旋转位置编码（RoPE）、门控线性单元（GLU）和分组查询注意力（GQA）。它是一个基于 BPE 的模型，并使用 GPT-4 分词器，正如 tiktoken 存储库中所述。我们根据详尽的评估和扩展实验做出了这些选择。
DBRX 在 12T 个精心策划的数据 token 上进行了预训练，最大上下文长度为 32K token。我们估计，与我们用于预训练 MPT 系列模型的 MPT 系列数据相比，这些新数据的 token 质量至少提高了 2 倍。新数据集是使用全套 Databricks 工具开发的，包括用于数据处理的 Apache Spark™ 和 Databricks notebooks，以及用于数据管理和治理的 Unity Catalog。我们在预训练中使用了课程学习，通过改变训练中的数据混合方式，显著提高了模型质量。
有关 DBRX Instruct 和 DBRX Base 的更详细信息，请参阅我们的技术博客文章。
此模型由 eitan-turok 和 abhi-db 贡献。注意：原始的 databricks/dbrx-instruct 检查点已关闭；transformers-community/dbrx-instruct 是为了兼容性而重新上传的，并且下面的代码片段使用了这个重新上传的版本。
用法示例
您可以使用 generate() 方法使用 DBRX 生成文本。您可以使用标准的注意力实现、flash-attention 和 PyTorch 缩放点积注意力进行生成。后两种注意力实现可以加快速度。
from transformers import DbrxForCausalLM, AutoTokenizer
import torch
tokenizer = AutoTokenizer.from_pretrained("transformers-community/dbrx-instruct", token="YOUR_HF_TOKEN")
model = DbrxForCausalLM.from_pretrained(
"transformers-community/dbrx-instruct",
device_map="auto",
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(model.device)
outputs = model.generate(**input_ids, max_new_tokens=200)
print(tokenizer.decode(outputs[0]))如果您已安装 flash-attention（pip install flash-attn），则可以更快地生成。（Flash-attention 的 HuggingFace 文档 在此处。）
from transformers import DbrxForCausalLM, AutoTokenizer
import torch
tokenizer = AutoTokenizer.from_pretrained("transformers-community/dbrx-instruct", token="YOUR_HF_TOKEN")
model = DbrxForCausalLM.from_pretrained(
"transformers-community/dbrx-instruct",
device_map="auto",
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(model.device)
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("transformers-community/dbrx-instruct", token="YOUR_HF_TOKEN")
model = DbrxForCausalLM.from_pretrained(
"transformers-community/dbrx-instruct",
device_map="auto",
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(model.device)
outputs = model.generate(**input_ids, max_new_tokens=200)
print(tokenizer.decode(outputs[0]))DbrxConfig
class transformers.DbrxConfig
< source >( d_model: int | None = 2048 n_heads: int | None = 16 n_layers: int | None = 24 max_seq_len: int | None = 2048 vocab_size: int | None = 32000 resid_pdrop: float | None = 0.0 emb_pdrop: float | None = 0.0 attn_config: transformers.models.dbrx.configuration_dbrx.DbrxAttentionConfig | None = None ffn_config: transformers.models.dbrx.configuration_dbrx.DbrxFFNConfig | None = None use_cache: bool | None = True initializer_range: float | None = 0.02 output_router_logits: bool | None = False rope_parameters: transformers.modeling_rope_utils.RopeParameters | dict[str, transformers.modeling_rope_utils.RopeParameters] | None = None pad_token_id: int | None = None bos_token_id: int | None = None eos_token_id: int | None = None tie_word_embeddings: bool | None = False **kwargs: typing.Any )
参数
- d_model (
int, optional, defaults to 2048) — 嵌入和隐藏状态的维度。 - n_heads (
int, optional, defaults to 16) — Transformer encoder中每个注意力层使用的注意力头数量。 - n_layers (
int, optional, defaults to 24) — Transformer encoder中的隐藏层数。 - max_seq_len (
int, optional, defaults to 2048) — 模型的最大序列长度。 - vocab_size (
int, optional, defaults to 32000) — Dbrx 模型的词汇量大小。定义在调用 DbrxModel 时传入的inputs_ids所能表示的最大不同 token 数。 - resid_pdrop (
float, optional, defaults to 0.0) — 在组合残差之前应用于注意力输出的 dropout 概率。 - emb_pdrop (
float, optional, defaults to 0.0) — 嵌入层的 dropout 概率。 - attn_config (
dict, optional) — 用于配置模型注意力模块的字典。 - ffn_config (
dict, optional) — 用于配置模型 FFN 模块的字典。 - use_cache (
bool, optional, defaults toTrue) — 模型是否应返回最后一个键/值注意力（并非所有模型都使用）。 - initializer_range (
float, optional, defaults to 0.02) — 用于初始化所有权重矩阵的 truncated_normal_initializer 的标准差。 - output_router_logits (
bool, optional, defaults toFalse) — 路由器的 logits 是否应由模型返回。启用此项还将允许模型输出辅助损失。有关更多详细信息，请参阅此处。
这是用于存储 DbrxModel 配置的配置类。它用于根据指定的参数实例化 Dbrx 模型，定义模型架构。使用默认值实例化配置将产生与 transformers-community/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.configDbrxModel
class transformers.DbrxModel
< source >( config: DbrxConfig )
参数
- config (DbrxConfig) — 包含模型所有参数的模型配置类。使用配置文件初始化不会加载与模型相关的权重，仅加载配置。请查看 from_pretrained() 方法来加载模型权重。
Bare Dbrx 模型，在顶部没有任何特定头部的情况下输出原始隐藏状态。
此模型继承自 PreTrainedModel。查看其父类文档，了解库为所有模型实现的通用方法（例如下载或保存、调整输入嵌入大小、修剪头等）。
此模型也是一个 PyTorch torch.nn.Module 子类。像普通的 PyTorch Module 一样使用它，并参考 PyTorch 文档了解一般用法和行为的所有相关信息。
forward
< source >( input_ids: torch.LongTensor | None = None attention_mask: torch.Tensor | None = None position_ids: torch.LongTensor | None = None past_key_values: transformers.cache_utils.Cache | None = None inputs_embeds: torch.FloatTensor | None = None use_cache: bool | None = None cache_position: torch.LongTensor | None = None **kwargs: typing_extensions.Unpack[transformers.utils.generic.TransformersKwargs] ) → transformers.modeling_outputs.MoeModelOutputWithPast or tuple(torch.FloatTensor)
参数
- input_ids (
torch.LongTensorof shape(batch_size, sequence_length), optional) — 词汇表中的输入序列 token 索引。默认情况下将忽略 padding。可以使用 AutoTokenizer 获取索引。有关详细信息，请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- attention_mask (
torch.Tensorof shape(batch_size, sequence_length), optional) — 用于避免对 padding token 索引执行注意力的掩码。掩码值选择在[0, 1]中：- 1 表示未掩码的 token，
- 0 表示已掩码的 token。
- position_ids (
torch.LongTensorof shape(batch_size, sequence_length), optional) — 位置嵌入中每个输入序列 token 的位置索引。选择范围在[0, config.n_positions - 1]之间。 - past_key_values (
~cache_utils.Cache, optional) — 预计算的隐藏状态（自注意力块和交叉注意力块中的键和值），可用于加速顺序解码。这通常由模型在解码的早期阶段返回的past_key_values组成，当use_cache=True或config.use_cache=True时。只允许使用 Cache 实例作为输入，请参阅我们的 kv 缓存指南。如果未传入
past_key_values，默认将初始化 DynamicCache。模型将输出与输入相同的缓存格式。
如果使用了
past_key_values，用户需要仅输入未处理的input_ids（即未提供其 past key value 状态给此模型的那些）形状为(batch_size, unprocessed_length)，而不是所有input_ids形状为(batch_size, sequence_length)。 - inputs_embeds (
torch.FloatTensorof shape(batch_size, sequence_length, hidden_size), optional) — 可选地，除了传入input_ids之外，您还可以选择直接传入嵌入表示。如果您希望对如何将input_ids索引转换为关联向量的控制程度超过模型的内部嵌入查找矩阵，这将很有用。 - use_cache (
bool, optional) — 如果设置为True，则返回past_key_values键值状态，并可用于加速解码（请参阅past_key_values）。 - cache_position (
torch.LongTensorof shape(sequence_length), optional) — 表示输入序列 token 在序列中的位置的索引。与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, optional, 当传递use_cache=True或当config.use_cache=True时返回) — 它是 Cache 实例。更多详情，请参阅我们的 kv cache 指南。Contains pre-computed hidden-states (key and values in the self-attention blocks and optionally if
config.is_encoder_decoder=Truein the cross-attention blocks) that can be used (seepast_key_valuesinput) to speed up sequential decoding. -
hidden_states (
tuple(torch.FloatTensor), optional, 当传递output_hidden_states=True或当config.output_hidden_states=True时返回) —torch.FloatTensor的元组（一个用于嵌入层的输出，如果模型有嵌入层；+一个用于每个层的输出），形状为(batch_size, sequence_length, hidden_size)。模型在每个层输出的隐藏状态以及可选的初始嵌入输出。
-
attentions (
tuple(torch.FloatTensor), optional, 当传递output_attentions=True或当config.output_attentions=True时返回) —torch.FloatTensor的元组（每个层一个），形状为(batch_size, num_heads, sequence_length, sequence_length)。注意力 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 的 forward 方法，覆盖了 __call__ 特殊方法。
虽然 forward pass 的实现需要在此函数中定义，但你应该在之后调用
Module实例而不是这个，因为前者负责运行预处理和后处理步骤，而后者会静默地忽略它们。
DbrxForCausalLM
forward
< source >( input_ids: torch.LongTensor | None = None attention_mask: torch.Tensor | None = None position_ids: torch.LongTensor | None = None past_key_values: transformers.cache_utils.Cache | None = None inputs_embeds: torch.FloatTensor | None = None labels: torch.LongTensor | None = None use_cache: bool | None = None output_router_logits: bool | None = None cache_position: torch.LongTensor | None = None logits_to_keep: int | torch.Tensor = 0 **kwargs: typing_extensions.Unpack[transformers.utils.generic.TransformersKwargs] ) → transformers.modeling_outputs.MoeCausalLMOutputWithPast 或 tuple(torch.FloatTensor)
参数
- input_ids (
torch.LongTensorof shape(batch_size, sequence_length), optional) — 词汇表中输入序列 token 的索引。默认情况下将忽略填充。可以使用 AutoTokenizer 获取索引。有关详细信息，请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- attention_mask (
torch.Tensorof shape(batch_size, sequence_length), optional) — 防止在填充 token 索引上执行注意力操作的掩码。选择的值在[0, 1]中：- 1 表示未掩码的 token，
- 0 表示已掩码的 token。
- position_ids (
torch.LongTensorof shape(batch_size, sequence_length), optional) — 位置嵌入中每个输入序列 token 的位置索引。选择范围为[0, config.n_positions - 1]。 - past_key_values (
~cache_utils.Cache, optional) — 预计算的隐藏状态（自注意力块和交叉注意力块中的键和值），可用于加速顺序解码。这通常由模型在解码的早期阶段返回的past_key_values组成，当use_cache=True或config.use_cache=True时。只允许使用 Cache 实例作为输入，请参阅我们的 kv 缓存指南。如果未传入
past_key_values，默认将初始化 DynamicCache。模型将输出与输入相同的缓存格式。
如果使用了
past_key_values，用户需要仅输入未处理的input_ids（即未提供其 past key value 状态给此模型的那些）形状为(batch_size, unprocessed_length)，而不是所有input_ids形状为(batch_size, sequence_length)。 - inputs_embeds (
torch.FloatTensorof shape(batch_size, sequence_length, hidden_size), optional) — 可选地，除了传入input_ids之外，您还可以选择直接传入嵌入表示。如果您希望对如何将input_ids索引转换为关联向量的控制程度超过模型的内部嵌入查找矩阵，这将很有用。 - labels (
torch.LongTensorof shape(batch_size, sequence_length), optional) — 用于计算掩码语言模型损失的标签。索引应在[0, ..., config.vocab_size]或 -100 范围内（请参阅input_ids文档字符串）。索引设置为-100的 token 将被忽略（掩码），仅为标签在[0, ..., config.vocab_size]范围内的 token 计算损失。 - use_cache (
bool, optional) — 如果设置为True，则返回past_key_values键值状态，并可用于加速解码（请参阅past_key_values）。 - output_router_logits (
bool, optional) — 是否返回所有路由器的 logits。它们有助于计算路由器损失，并且在推理过程中不应返回。 - cache_position (
torch.LongTensorof shape(sequence_length), optional) — 表示输入序列 token 在序列中的位置的索引。与position_ids相反，此张量不受填充的影响。它用于在正确的位置更新缓存并推断完整的序列长度。 - logits_to_keep (
Union[int, torch.Tensor], optional, defaults to0) — 如果是int，则计算最后logits_to_keep个 token 的 logits。如果为0，则为所有input_ids计算 logits（特殊情况）。仅生成需要最后一个 token 的 logits，并且仅为该 token 计算可以节省内存，这对于长序列或大词汇量来说非常重要。如果为torch.Tensor，则必须是 1D，对应于序列长度维度中要保留的索引。这在使用打包张量格式（批次和序列长度的单维）时非常有用。
返回
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, optional, 当传递use_cache=True或当config.use_cache=True时返回) — 它是 Cache 实例。更多详情，请参阅我们的 kv cache 指南。包含预计算的隐藏状态（自注意力块中的键和值），可用于（参见
past_key_values输入）加速顺序解码。 -
hidden_states (
tuple(torch.FloatTensor), optional, 当传递output_hidden_states=True或当config.output_hidden_states=True时返回) —torch.FloatTensor的元组（一个用于嵌入层的输出，如果模型有嵌入层；+一个用于每个层的输出），形状为(batch_size, sequence_length, hidden_size)。模型在每个层输出的隐藏状态以及可选的初始嵌入输出。
-
attentions (
tuple(torch.FloatTensor), optional, 当传递output_attentions=True或当config.output_attentions=True时返回) —torch.FloatTensor的元组（每个层一个），形状为(batch_size, num_heads, sequence_length, sequence_length)。注意力 softmax 后的注意力权重，用于计算自注意力头中的加权平均值。
DbrxForCausalLM 的 forward 方法，覆盖了 __call__ 特殊方法。
虽然 forward pass 的实现需要在此函数中定义，但你应该在之后调用
Module实例而不是这个，因为前者负责运行预处理和后处理步骤，而后者会静默地忽略它们。
示例
>> from transformers import AutoTokenizer, DbrxForCausalLM
>> model = DbrxForCausalLM.from_pretrained("transformers-community/dbrx-instruct")
>> tokenizer = AutoTokenizer.from_pretrained("transformers-community/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."