transformers/main/pt/model_doc/bitnet.md

BitNet

Visão geral

Treinado em um corpus de 4 trilhões de tokens, este modelo demonstra que LLMs nativos de 1 bit podem alcançar desempenho comparável ao de modelos de peso aberto e precisão completa de tamanho semelhante, oferecendo, ao mesmo tempo, vantagens substanciais em eficiência computacional (memória, energia, latência).

➡️ Relatório técnico: Relatório técnico do BitNet b1.58 2B4T

➡️ Código de Inferência Oficial: microsoft/BitNet (bitnet.cpp)

Variantes de Modelo

Várias versões dos pesos do modelo estão disponíveis no Hugging Face:

• microsoft/bitnet-b1.58-2B-4T: Contém os pesos empacotados de 1,58 bits otimizados para inferência eficiente. Use este para implantação.

• microsoft/bitnet-b1.58-2B-4T-bf16: Contém os pesos mestres em formato BF16. Use apenas para fins de treinamento ou ajuste fino.

• microsoft/bitnet-b1.58-2B-4T-gguf: Contém os pesos do modelo no formato GGUF, compatível com a biblioteca bitnet.cpp para inferência em CPU.

Detalhes do Modelo

• Arquitetura: baseada em Transformer, modificada com camadas BitLinear (framework BitNet).
  • Usa incorporações de posição rotativas (RoPE).
  • Usa a ativação ReLU ao quadrado (ReLU²) nas camadas FFN.
  • Utiliza a normalização subln.
  • Sem termos de viés em camadas lineares ou de normalização.
• Quantização: Pesos nativos de 1,58 bits e ativações de 8 bits (W1.58A8).
  • Os pesos são quantizados para valores ternários {-1, 0, +1} usando quantização absmean durante a passagem direta.
  • As ativações são quantizadas para inteiros de 8 bits usando quantização absmax (por token).
  • Crucialmente, o modelo foi treinado do zero com esse esquema de quantização, e não quantizado após o treinamento.
• Parâmetros: ~2 Bilhões
• Tokens de treinamento: 4 trilhões
• Comprimento do contexto: comprimento máximo da sequência de 4096 tokens.
  • Recomendação: Para desempenho ideal em tarefas que exigem contextos muito longos (além do comprimento do pré-treinamento ou para tarefas especializadas de raciocínio longo), recomendamos realizar uma adaptação/treinamento intermediário de sequência longa antes da etapa final de ajuste fino.
• Etapas de Treinamento:
  1. Pré-treino: Treinamento em larga escala em texto/código públicos e dados matemáticos sintéticos, utilizando um agendamento de taxa de aprendizado e de decaimento de peso em duas etapas.
  2. Ajuste fino supervisionado (SFT): Ajuste fino realizado em conjuntos de dados de seguimento de instruções e conversacionais, utilizando agregação de perda por soma e ajuste específico de hiperparâmetros.
  3. Otimização de Preferência Direta (DPO): Alinhado a preferências humanas usando pares de preferências.
• Tokenizer: Tokenizer do LLaMA 3 (tamanho do vocabulário: 128.256).

Dicas de uso

OBSERVAÇÃO MUITO IMPORTANTE SOBRE EFICIÊNCIA

Não espere ganhos de eficiência de desempenho (em termos de velocidade, latência ou consumo de energia) ao usar este modelo com a biblioteca padrão transformers.

Os caminhos de execução atuais dentro do transformers não contêm os kernels computacionais especializados e altamente otimizados necessários para aproveitar as vantagens da arquitetura BitNet. Executar o modelo via transformers provavelmente resultará em velocidades de inferência e consumo de energia comparáveis, ou potencialmente piores, do que os de modelos de precisão padrão dentro deste framework, tanto em CPU quanto em GPU.

Embora você possa observar uma redução no uso de memória devido aos pesos quantizados, os principais benefícios de eficiência computacional não estão acessíveis por meio deste caminho padrão de uso do transformers.

Para alcançar os benefícios de eficiência demonstrados no artigo técnico, você DEVE usar a implementação C++ dedicada: bitnet.cpp.

Requisitos

pip install transformers

Exemplo

from transformers import AutoModelForCausalLM, AutoTokenizer

model_id = "microsoft/bitnet-b1.58-2B-4T"

# Load tokenizer and model
tokenizer = AutoTokenizer.from_pretrained(model_id)
model = AutoModelForCausalLM.from_pretrained(
    model_id,
 device_map="auto")

# Apply the chat template
messages = [
    {"role": "system", "content": "You are a helpful AI assistant."},
    {"role": "user", "content": "How are you?"},
]
chat_input = tokenizer.apply_chat_template(messages, tokenize=True, add_generation_prompt=True, return_tensors="pt").to(model.device)

# Generate response
chat_outputs = model.generate(chat_input, max_new_tokens=50)
response = tokenizer.decode(chat_outputs[0][chat_input.shape[-1]:], skip_special_tokens=True) # Decode only the response part
print("\nAssistant Response:", response)

BitNetConfig[[transformers.BitNetConfig]]

transformers.BitNetConfig[[transformers.BitNetConfig]]

transformers.BitNetConfig(transformers_version: str | None = None, architectures: list[str] | None = None, output_hidden_states: bool | None = False, return_dict: bool | None = True, dtype: str | torch.dtype | None = None, chunk_size_feed_forward: int = 0, is_encoder_decoder: bool = False, id2label: dict[int, str] | dict[str, str] | None = None, label2id: dict[str, int] | dict[str, str] | None = None, problem_type: Literal['regression', 'single_label_classification', 'multi_label_classification'] | None = None, vocab_size: int = 128256, hidden_size: int = 2560, intermediate_size: int = 6912, num_hidden_layers: int = 30, num_attention_heads: int = 20, num_key_value_heads: int | None = 5, hidden_act: str = 'relu2', max_position_embeddings: int = 2048, initializer_range: float = 0.02, rms_norm_eps: float = 1e-05, use_cache: bool = True, pad_token_id: int | None = None, bos_token_id: int | None = 128000, eos_token_id: int | list[int] | None = 128001, tie_word_embeddings: bool = False, attention_bias: bool = False, attention_dropout: float | int | None = 0.0, rope_parameters: transformers.modeling_rope_utils.RopeParameters | dict | None = None)

Origem

Parâmetros:

vocab_size (int, opcional, padrão 128256) : Tamanho do vocabulário do modelo. Define o número de tokens diferentes que podem ser representados pelos input_ids.

hidden_size (int, opcional, padrão 2560) : Dimensão das representações ocultas.

intermediate_size (int, opcional, padrão 6912) : Dimensão das representações do MLP.

num_hidden_layers (int, opcional, padrão 30) : Número de camadas ocultas no decodificador do Transformer.

num_attention_heads (int, opcional, padrão 20) : Número de cabeças de atenção para cada camada de atenção no decodificador do Transformer.

num_key_value_heads (int, opcional, padrão 5) : Este é o número de cabeças de key_value que devem ser usadas para implementar Grouped Query Attention. Se num_key_value_heads=num_attention_heads, o modelo usará Multi Head Attention (MHA); se num_key_value_heads=1, o modelo usará Multi Query Attention (MQA); caso contrário, será usado GQA. Ao converter um checkpoint multi-head para um checkpoint GQA, cada cabeça de chave e valor do grupo deve ser construída pela média (meanpooling) de todas as cabeças originais dentro desse grupo. Para mais detalhes, consulte este artigo. Se não for especificado, o valor padrão será num_attention_heads.

hidden_act (str, opcional, padrão relu2) : A função de ativação não linear (função ou string) no decodificador. Por exemplo, "gelu", "relu", "silu", etc.

max_position_embeddings (int, opcional, padrão 2048) : O comprimento máximo de sequência com o qual este modelo pode ser utilizado.

initializer_range (float, opcional, padrão 0.02) : O desvio padrão do truncated_normal_initializer para inicializar todas as matrizes de pesos.

rms_norm_eps (float, opcional, padrão 1e-05) : O epsilon usado pelas camadas de normalização rms.

use_cache (bool, opcional, padrão True) : Indica se o modelo deve retornar as últimas atenções de chave/valor (não utilizado por todos os modelos). Relevante apenas se config.is_decoder=True ou quando o modelo for um modelo generativo somente de decodificador.

pad_token_id (int, opcional) : ID do token usado para preenchimento (padding) no vocabulário.

bos_token_id (int, opcional, padrão 128000) : ID do token usado para o início do fluxo no vocabulário.

eos_token_id (Union[int, list[int]], opcional, padrão 128001) : ID do token usado para o fim do fluxo no vocabulário.

tie_word_embeddings (bool, opcional, padrão False) : Se deve vincular as embeddings de pesos de acordo com o mapeamento tied_weights_keys do modelo.

attention_bias (bool, opcional, padrão False) : Se deve usar um viés nas camadas de projeção de query, key, value e output durante a autoatenção.

attention_dropout (Union[float, int], opcional, padrão 0.0) : A taxa de dropout para as probabilidades de atenção.

rope_parameters (Union[~modeling_rope_utils.RopeParameters, dict], opcional) : Dicionário contendo os parâmetros de configuração para os embeddings RoPE. O dicionário deve conter um valor para rope_theta e, opcionalmente, parâmetros usados para escalonamento, caso você queira usar RoPE com max_position_embeddings maiores.

Esta é a classe de configuração para armazenar a configuração de um BitNetModel. Ela é usada para instanciar um modelo Bitnet de acordo com os argumentos especificados, definindo a arquitetura do modelo. Instanciar uma configuração com os padrões resultará em uma configuração semelhante à do microsoft/bitnet-b1.58-2B-4T

Os objetos de configuração herdam de PreTrainedConfig e podem ser usados para controlar as saídas do modelo. Leia a documentação de PreTrainedConfig para mais informações.

>>> from transformers import BitNetModel, BitNetConfig

>>> # Initializing a BitNet style configuration
>>> configuration = BitNetConfig()

>>> # Initializing a model from the BitNet style configuration
>>> model = BitNetModel(configuration)

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

BitNetModel[[transformers.BitNetModel]]

transformers.BitNetModel[[transformers.BitNetModel]]

transformers.BitNetModel(config: BitNetConfig)

Origem

Parâmetros:

config (BitNetConfig) : Classe de configuração do modelo com todos os parâmetros do modelo. A inicialização com um arquivo de configuração não carrega os pesos associados ao modelo, apenas a configuração. Consulte o método from_pretrained() para carregar os pesos do modelo.

O modelo Bitnet puro, que produz estados ocultos brutos sem nenhum cabeçalho específico no topo.

Este modelo herda de PreTrainedModel. Consulte a documentação da classe pai para os métodos genéricos que a biblioteca implementa para todos os seus modelos (como download ou salvamento, redimensionamento dos embeddings de entrada, poda de cabeças, etc.).

Este modelo também é uma subclasse de torch.nn.Module do PyTorch. Use-o como um Módulo PyTorch regular e consulte a documentação do PyTorch para todos os assuntos relacionados ao uso e comportamento gerais.

forward[[transformers.BitNetModel.forward]]

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: transformers.cache_utils.Cache | None = None, inputs_embeds: typing.Optional[torch.Tensor] = None, use_cache: bool | None = None, **kwargs: *<class 'transformers.utils.generic.TransformersKwargs'>)

Origem

Parâmetros:

input_ids (torch.LongTensor de forma (batch_size, sequence_length), opcional) : Índices dos tokens da sequência de entrada no vocabulário. O preenchimento (padding) será ignorado por padrão. Os índices podem ser obtidos usando AutoTokenizer. Consulte PreTrainedTokenizer.encode() e PreTrainedTokenizer.call() para mais detalhes. O que são IDs de entrada?

attention_mask (torch.Tensor de forma (batch_size, sequence_length), opcional) : Máscara para evitar a execução de atenção nos índices de tokens de preenchimento. Valores de máscara selecionados em [0, 1]: - 1 para tokens que não estão mascarados, - 0 para tokens que estão mascarados. O que são máscaras de atenção?

position_ids (torch.LongTensor de forma (batch_size, sequence_length), opcional) : Índices das posições dos tokens de cada sequência de entrada nos embeddings de posição. Selecionados no intervalo [0, config.n_positions - 1]. O que são IDs de posição?

past_key_values (~cache_utils.Cache, opcional) : hidden-states pré-computados (chaves e valores nos blocos de autoatenção e nos blocos de atenção cruzada) que podem ser usados para acelerar a decodificação sequencial. Isso geralmente consiste nos past_key_values retornados pelo modelo em uma etapa anterior da decodificação, quando use_cache=True ou config.use_cache=True. Apenas uma instância de Cache é permitida como entrada, consulte nosso guia de kv cache. Se nenhum past_key_values for passado, DynamicCache será inicializado por padrão. O modelo sairá no mesmo formato de cache que foi fornecido como entrada. Se past_key_values forem usados, espera-se que o usuário insira apenas input_ids não processados (aqueles que não têm seus estados de chave e valor passados para este modelo) com a forma (batch_size, unprocessed_length) em vez de todos os input_ids com a forma (batch_size, sequence_length).

inputs_embeds (torch.Tensor de forma (batch_size, sequence_length, hidden_size), opcional) : Opcionalmente, em vez de passar input_ids, você pode escolher passar diretamente uma representação incorporada. Isso é útil se você quiser ter mais controle sobre como converter os índices de input_ids nos vetores associados do que a matriz de busca de incorporação interna do modelo.

use_cache (bool, opcional) : Se definido como True, os estados de chave-valor de past_key_values são retornados e podem ser usados para acelerar a decodificação (veja past_key_values).

Retorna: BaseModelOutputWithPast ou tuple(torch.Tensor)

Um BaseModelOutputWithPast ou uma tupla de torch.Tensor (se return_dict=False for passado ou quando config.return_dict=False), composto por diversos elementos, dependendo da configuração (BitNetConfig) e das entradas.

O método forward do BitNetModel substitui o método especial __call__.

Embora a receita para a passagem direta precise ser definida dentro desta função, deve-se chamar a instância de Module em seguida, em vez desta, pois a primeira cuida da execução das etapas de pré e pós-processamento, enquanto a segunda as ignora silenciosamente.

• last_hidden_state (torch.Tensor de forma (batch_size, sequence_length, hidden_size)) -- Sequência de estados ocultos na saída da última camada do modelo.

  Se past_key_values for usado, apenas o último hidden-state das sequências, com forma (batch_size, 1, hidden_size), é retornado.

• past_key_values (Cache, opcional, retornado quando use_cache=True é passado ou quando config.use_cache=True) -- Trata-se de uma instância de Cache. Para mais detalhes, consulte nosso guia de cache kv.

  Contém estados ocultos pré-computados (chaves e valores nos blocos de autoatenção e, opcionalmente, se config.is_encoder_decoder=True, nos blocos de atenção cruzada) que podem ser usados (veja a entrada past_key_values) para acelerar a decodificação sequencial.

• hidden_states (tuple(torch.Tensor), opcional, retornado quando output_hidden_states=True é passado ou quando config.output_hidden_states=True) -- Tupla de torch.Tensor (um para a saída dos embeddings, se o modelo tiver uma camada de embedding, + um para a saída de cada camada) com a forma (batch_size, sequence_length, hidden_size).

  Estados ocultos do modelo na saída de cada camada, além das saídas opcionais do embedding inicial.

• attentions (tuple(torch.Tensor), opcional, retornado quando output_attentions=True é passado ou quando config.output_attentions=True) -- Tupla de torch.Tensor (um para cada camada) com a forma (batch_size, num_heads, sequence_length, sequence_length).

  Pesos de atenção após o softmax de atenção, usados para calcular a média ponderada nas cabeças de autoatenção.

BitNetForCausalLM[[transformers.BitNetForCausalLM]]

transformers.BitNetForCausalLM[[transformers.BitNetForCausalLM]]

transformers.BitNetForCausalLM(config: BitNetConfig)

Origem

Parâmetros:

config (BitNetConfig) : Classe de configuração do modelo com todos os parâmetros do modelo. A inicialização com um arquivo de configuração não carrega os pesos associados ao modelo, apenas a configuração. Consulte o método from_pretrained() para carregar os pesos do modelo.

O modelo Bitnet para modelagem de linguagem causal.

Este modelo herda de PreTrainedModel. Consulte a documentação da classe pai para os métodos genéricos que a biblioteca implementa para todos os seus modelos (como download ou salvamento, redimensionamento dos embeddings de entrada, poda de cabeças, etc.).

Este modelo também é uma subclasse de torch.nn.Module do PyTorch. Use-o como um Módulo PyTorch regular e consulte a documentação do PyTorch para todos os assuntos relacionados ao uso e comportamento gerais.

forward[[transformers.BitNetForCausalLM.forward]]

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: transformers.cache_utils.Cache | None = None, inputs_embeds: typing.Optional[torch.Tensor] = None, labels: typing.Optional[torch.LongTensor] = None, use_cache: bool | None = None, logits_to_keep: typing.Union[int, torch.Tensor] = 0, **kwargs: *<class 'transformers.utils.generic.TransformersKwargs'>)

Origem

Parâmetros:

input_ids (torch.LongTensor de forma (batch_size, sequence_length), opcional) : Índices dos tokens da sequência de entrada no vocabulário. O preenchimento (padding) será ignorado por padrão. Os índices podem ser obtidos usando AutoTokenizer. Consulte PreTrainedTokenizer.encode() e PreTrainedTokenizer.call() para mais detalhes. O que são IDs de entrada?

attention_mask (torch.Tensor de forma (batch_size, sequence_length), opcional) : Máscara para evitar a execução de atenção nos índices de tokens de preenchimento. Valores de máscara selecionados em [0, 1]: - 1 para tokens que não estão mascarados, - 0 para tokens que estão mascarados. O que são máscaras de atenção?

position_ids (torch.LongTensor de forma (batch_size, sequence_length), opcional) : Índices das posições dos tokens de cada sequência de entrada nos embeddings de posição. Selecionados no intervalo [0, config.n_positions - 1]. O que são IDs de posição?

past_key_values (~cache_utils.Cache, opcional) : hidden-states pré-computados (chaves e valores nos blocos de autoatenção e nos blocos de atenção cruzada) que podem ser usados para acelerar a decodificação sequencial. Isso geralmente consiste nos past_key_values retornados pelo modelo em uma etapa anterior da decodificação, quando use_cache=True ou config.use_cache=True. Apenas uma instância de Cache é permitida como entrada, consulte nosso guia de kv cache. Se nenhum past_key_values for passado, DynamicCache será inicializado por padrão. O modelo sairá no mesmo formato de cache que foi fornecido como entrada. Se past_key_values forem usados, espera-se que o usuário insira apenas input_ids não processados (aqueles que não têm seus estados de chave e valor passados para este modelo) com a forma (batch_size, unprocessed_length) em vez de todos os input_ids com a forma (batch_size, sequence_length).

inputs_embeds (torch.Tensor de forma (batch_size, sequence_length, hidden_size), opcional) : Opcionalmente, em vez de passar input_ids, você pode escolher passar diretamente uma representação incorporada. Isso é útil se você quiser ter mais controle sobre como converter os índices de input_ids nos vetores associados do que a matriz de busca de incorporação interna do modelo.

labels (torch.LongTensor de forma (batch_size, sequence_length), opcional) : Rótulos para calcular a perda de modelagem de linguagem mascarada. Os índices devem estar em [0, transformers., config.vocab_size] ou ser -100 (veja a docstring de input_ids). Tokens com índices definidos como -100 são ignorados (mascarados); a perda é calculada apenas para os tokens com rótulos em [0, transformers., config.vocab_size].

use_cache (bool, opcional) : Se definido como True, os estados de chave-valor de past_key_values são retornados e podem ser usados para acelerar a decodificação (veja past_key_values).

logits_to_keep (Union[int, torch.Tensor], opcional, padrão 0) : Se for um int, calcula os logits para os últimos logits_to_keep tokens. Se for 0, calcula os logits para todos os input_ids (caso especial). Apenas os logits do último token são necessários para a geração, e calculá-los apenas para esse token pode economizar memória, o que se torna bastante significativo para sequências longas ou tamanho de vocabulário grande. Se for um torch.Tensor, deve ser 1D, correspondendo aos índices a serem mantidos na dimensão de comprimento da sequência. Isso é útil ao usar o formato de tensor empacotado (uma única dimensão para lote e comprimento da sequência).

Retorna: CausalLMOutputWithPast ou tuple(torch.Tensor)

Um CausalLMOutputWithPast ou uma tupla de torch.Tensor (se return_dict=False for passado ou quando config.return_dict=False) contendo diversos elementos, dependendo da configuração (BitNetConfig) e das entradas.

O método forward de BitNetForCausalLM substitui o método especial __call__.

Embora a receita para a passagem direta precise ser definida dentro desta função, deve-se chamar a instância de Module em seguida, em vez desta, pois a primeira cuida da execução das etapas de pré e pós-processamento, enquanto a segunda as ignora silenciosamente.

• loss (torch.Tensor de forma (1,), opcional, retornado quando labels é fornecido) -- Perda de modelagem de linguagem (para previsão do próximo token).

• logits (torch.Tensor de forma (batch_size, sequence_length, config.vocab_size)) -- Pontuações de previsão da cabeça de modelagem de linguagem (pontuações para cada token do vocabulário antes do SoftMax).

• past_key_values (Cache, opcional, retornado quando use_cache=True é passado ou quando config.use_cache=True) -- Trata-se de uma instância de Cache. Para mais detalhes, consulte nosso guia de cache kv.

  Contém estados ocultos pré-computados (chaves e valores nos blocos de autoatenção) que podem ser usados (veja a entrada past_key_values) para acelerar a decodificação sequencial.

• hidden_states (tuple(torch.Tensor), opcional, retornado quando output_hidden_states=True é passado ou quando config.output_hidden_states=True) -- Tupla de torch.Tensor (um para a saída dos embeddings, se o modelo tiver uma camada de embedding, + um para a saída de cada camada) com a forma (batch_size, sequence_length, hidden_size).

  Estados ocultos do modelo na saída de cada camada, além das saídas opcionais do embedding inicial.

• attentions (tuple(torch.Tensor), opcional, retornado quando output_attentions=True é passado ou quando config.output_attentions=True) -- Tupla de torch.Tensor (um para cada camada) com a forma (batch_size, num_heads, sequence_length, sequence_length).

  Pesos de atenção após o softmax de atenção, usados para calcular a média ponderada nas cabeças de autoatenção.

Exemplo:

>>> from transformers import AutoTokenizer, BitNetForCausalLM

>>> model = BitNetForCausalLM.from_pretrained("microsoft/bitnet-b1.58-2B-4T")
>>> tokenizer = AutoTokenizer.from_pretrained("microsoft/bitnet-b1.58-2B-4T")

>>> prompt = f'<|begin_of_text|>User: Hey, are you conscious? Can you talk to me?<|eot_id|>Assistant: '
>>> inputs = tokenizer(prompt, return_tensors="pt")

>>> # Generate
>>> generate_ids = model.generate(inputs.input_ids, max_length=100)
>>> tokenizer.batch_decode(generate_ids, skip_special_tokens=True, clean_up_tokenization_spaces=False)[0]
"User: Hey, are you conscious? Can you talk to me?Assistant: No, I'm not conscious. I'm an artificial intelligence designed to assist with information and tasks. How can I help you today?"