Text Generation
Transformers
PyTorch
Safetensors
English
Chinese
llama
conversational
custom_code
text-generation-inference
Instructions to use openbmb/NOSA-3B with libraries, inference providers, notebooks, and local apps. Follow these links to get started.
- Libraries
- Transformers
How to use openbmb/NOSA-3B with Transformers:
# Use a pipeline as a high-level helper from transformers import pipeline pipe = pipeline("text-generation", model="openbmb/NOSA-3B", trust_remote_code=True) messages = [ {"role": "user", "content": "Who are you?"}, ] pipe(messages)# Load model directly from transformers import AutoTokenizer, AutoModelForCausalLM tokenizer = AutoTokenizer.from_pretrained("openbmb/NOSA-3B", trust_remote_code=True) model = AutoModelForCausalLM.from_pretrained("openbmb/NOSA-3B", trust_remote_code=True) messages = [ {"role": "user", "content": "Who are you?"}, ] inputs = tokenizer.apply_chat_template( messages, add_generation_prompt=True, tokenize=True, return_dict=True, return_tensors="pt", ).to(model.device) outputs = model.generate(**inputs, max_new_tokens=40) print(tokenizer.decode(outputs[0][inputs["input_ids"].shape[-1]:])) - Notebooks
- Google Colab
- Kaggle
- Local Apps Settings
- vLLM
How to use openbmb/NOSA-3B with vLLM:
Install from pip and serve model
# Install vLLM from pip: pip install vllm # Start the vLLM server: vllm serve "openbmb/NOSA-3B" # Call the server using curl (OpenAI-compatible API): curl -X POST "http://localhost:8000/v1/chat/completions" \ -H "Content-Type: application/json" \ --data '{ "model": "openbmb/NOSA-3B", "messages": [ { "role": "user", "content": "What is the capital of France?" } ] }'Use Docker
docker model run hf.co/openbmb/NOSA-3B
- SGLang
How to use openbmb/NOSA-3B with SGLang:
Install from pip and serve model
# Install SGLang from pip: pip install sglang # Start the SGLang server: python3 -m sglang.launch_server \ --model-path "openbmb/NOSA-3B" \ --host 0.0.0.0 \ --port 30000 # Call the server using curl (OpenAI-compatible API): curl -X POST "http://localhost:30000/v1/chat/completions" \ -H "Content-Type: application/json" \ --data '{ "model": "openbmb/NOSA-3B", "messages": [ { "role": "user", "content": "What is the capital of France?" } ] }'Use Docker images
docker run --gpus all \ --shm-size 32g \ -p 30000:30000 \ -v ~/.cache/huggingface:/root/.cache/huggingface \ --env "HF_TOKEN=<secret>" \ --ipc=host \ lmsysorg/sglang:latest \ python3 -m sglang.launch_server \ --model-path "openbmb/NOSA-3B" \ --host 0.0.0.0 \ --port 30000 # Call the server using curl (OpenAI-compatible API): curl -X POST "http://localhost:30000/v1/chat/completions" \ -H "Content-Type: application/json" \ --data '{ "model": "openbmb/NOSA-3B", "messages": [ { "role": "user", "content": "What is the capital of France?" } ] }' - Docker Model Runner
How to use openbmb/NOSA-3B with Docker Model Runner:
docker model run hf.co/openbmb/NOSA-3B
| # coding=utf-8 | |
| # Copyright 2022 EleutherAI and the HuggingFace Inc. team. All rights reserved. | |
| # | |
| # This code is based on EleutherAI's GPT-NeoX library and the GPT-NeoX | |
| # and OPT implementations in this library. It has been modified from its | |
| # original forms to accommodate minor architectural differences compared | |
| # to GPT-NeoX and OPT used by the Meta AI team that trained the model. | |
| # | |
| # Licensed under the Apache License, Version 2.0 (the "License"); | |
| # you may not use this file except in compliance with the License. | |
| # You may obtain a copy of the License at | |
| # | |
| # http://www.apache.org/licenses/LICENSE-2.0 | |
| # | |
| # Unless required by applicable law or agreed to in writing, software | |
| # distributed under the License is distributed on an "AS IS" BASIS, | |
| # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | |
| # See the License for the specific language governing permissions and | |
| # limitations under the License. | |
| import math | |
| from typing import List, Optional, Tuple, Union | |
| import torch | |
| import torch.nn.functional as F | |
| import torch.utils.checkpoint | |
| from torch import nn | |
| from torch.nn import BCEWithLogitsLoss, CrossEntropyLoss, MSELoss | |
| from transformers.activations import ACT2FN | |
| from transformers.cache_utils import Cache, DynamicCache, StaticCache | |
| from transformers.generation import GenerationMixin | |
| from transformers.modeling_attn_mask_utils import AttentionMaskConverter | |
| from transformers.modeling_flash_attention_utils import _flash_attention_forward | |
| from transformers.modeling_outputs import ( | |
| BaseModelOutputWithPast, | |
| CausalLMOutputWithPast, | |
| QuestionAnsweringModelOutput, | |
| SequenceClassifierOutputWithPast, | |
| TokenClassifierOutput, | |
| ) | |
| from transformers.modeling_rope_utils import ROPE_INIT_FUNCTIONS | |
| from transformers.modeling_utils import PreTrainedModel | |
| from transformers.pytorch_utils import ALL_LAYERNORM_LAYERS | |
| from transformers.utils import ( | |
| add_start_docstrings, | |
| add_start_docstrings_to_model_forward, | |
| is_flash_attn_greater_or_equal_2_10, | |
| is_torchdynamo_compiling, | |
| logging, | |
| replace_return_docstrings, | |
| ) | |
| from transformers.models.llama.configuration_llama import LlamaConfig | |
| from functools import lru_cache | |
| from .cis_pooling import nosa_mean_pooling | |
| logger = logging.get_logger(__name__) | |
| _CONFIG_FOR_DOC = "LlamaConfig" | |
| def _prepare_4d_causal_attention_mask_with_cache_position( | |
| attention_mask: torch.Tensor, | |
| sequence_length: int, | |
| target_length: int, | |
| dtype: torch.dtype, | |
| device: torch.device, | |
| min_dtype: float, | |
| cache_position: torch.Tensor, | |
| batch_size: int, | |
| ): | |
| """ | |
| Creates a causal 4D mask of shape `(batch_size, 1, query_length, key_value_length)` from a 2D mask of shape | |
| `(batch_size, key_value_length)`, or if the input `attention_mask` is already 4D, do nothing. | |
| Args: | |
| attention_mask (`torch.Tensor`): | |
| A 2D attention mask of shape `(batch_size, key_value_length)` or a 4D attention mask of shape `(batch_size, 1, query_length, key_value_length)`. | |
| sequence_length (`int`): | |
| The sequence length being processed. | |
| target_length (`int`): | |
| The target length: when generating with static cache, the mask should be as long as the static cache, to account for the 0 padding, the part of the cache that is not filled yet. | |
| dtype (`torch.dtype`): | |
| The dtype to use for the 4D attention mask. | |
| device (`torch.device`): | |
| The device to plcae the 4D attention mask on. | |
| min_dtype (`float`): | |
| The minimum value representable with the dtype `dtype`. | |
| cache_position (`torch.Tensor`): | |
| Indices depicting the position of the input sequence tokens in the sequence. | |
| batch_size (`torch.Tensor`): | |
| Batch size. | |
| """ | |
| if attention_mask is not None and attention_mask.dim() == 4: | |
| # In this case we assume that the mask comes already in inverted form and requires no inversion or slicing. | |
| causal_mask = attention_mask | |
| else: | |
| causal_mask = torch.full((sequence_length, target_length), fill_value=min_dtype, dtype=dtype, device=device) | |
| if sequence_length != 1: | |
| causal_mask = torch.triu(causal_mask, diagonal=1) | |
| causal_mask *= torch.arange(target_length, device=device) > cache_position.reshape(-1, 1) | |
| causal_mask = causal_mask[None, None, :, :].expand(batch_size, 1, -1, -1) | |
| if attention_mask is not None: | |
| causal_mask = causal_mask.clone() # copy to contiguous memory for in-place edit | |
| mask_length = attention_mask.shape[-1] | |
| padding_mask = causal_mask[:, :, :, :mask_length] + attention_mask[:, None, None, :] | |
| padding_mask = padding_mask == 0 | |
| causal_mask[:, :, :, :mask_length] = causal_mask[:, :, :, :mask_length].masked_fill( | |
| padding_mask, min_dtype | |
| ) | |
| return causal_mask | |
| class LlamaRMSNorm(nn.Module): | |
| def __init__(self, hidden_size, eps=1e-6): | |
| """ | |
| LlamaRMSNorm is equivalent to T5LayerNorm | |
| """ | |
| super().__init__() | |
| self.weight = nn.Parameter(torch.ones(hidden_size)) | |
| self.variance_epsilon = eps | |
| def forward(self, hidden_states): | |
| input_dtype = hidden_states.dtype | |
| hidden_states = hidden_states.to(torch.float32) | |
| variance = hidden_states.pow(2).mean(-1, keepdim=True) | |
| hidden_states = hidden_states * torch.rsqrt(variance + self.variance_epsilon) | |
| return self.weight * hidden_states.to(input_dtype) | |
| def extra_repr(self): | |
| return f"{tuple(self.weight.shape)}, eps={self.variance_epsilon}" | |
| ALL_LAYERNORM_LAYERS.append(LlamaRMSNorm) | |
| class LlamaRotaryEmbedding(nn.Module): | |
| def __init__( | |
| self, | |
| dim=None, | |
| max_position_embeddings=2048, | |
| base=10000, | |
| device=None, | |
| scaling_factor=1.0, | |
| rope_type="default", | |
| config: Optional[LlamaConfig] = None, | |
| ): | |
| super().__init__() | |
| # TODO (joao): remove the `if` below, only used for BC | |
| self.rope_kwargs = {} | |
| if config is None: | |
| logger.warning_once( | |
| "`LlamaRotaryEmbedding` can now be fully parameterized by passing the model config through the " | |
| "`config` argument. All other arguments will be removed in v4.46" | |
| ) | |
| self.rope_kwargs = { | |
| "rope_type": rope_type, | |
| "factor": scaling_factor, | |
| "dim": dim, | |
| "base": base, | |
| "max_position_embeddings": max_position_embeddings, | |
| } | |
| self.rope_type = rope_type | |
| self.max_seq_len_cached = max_position_embeddings | |
| self.original_max_seq_len = max_position_embeddings | |
| else: | |
| # BC: "rope_type" was originally "type" | |
| if config.rope_scaling is not None: | |
| self.rope_type = config.rope_scaling.get("rope_type", config.rope_scaling.get("type")) | |
| else: | |
| self.rope_type = "default" | |
| self.max_seq_len_cached = config.max_position_embeddings | |
| self.original_max_seq_len = config.max_position_embeddings | |
| self.config = config | |
| self.rope_init_fn = ROPE_INIT_FUNCTIONS[self.rope_type] | |
| inv_freq, self.attention_scaling = self.rope_init_fn(self.config, device, **self.rope_kwargs) | |
| self.register_buffer("inv_freq", inv_freq, persistent=False) | |
| self.original_inv_freq = self.inv_freq | |
| def _dynamic_frequency_update(self, position_ids, device): | |
| """ | |
| dynamic RoPE layers should recompute `inv_freq` in the following situations: | |
| 1 - growing beyond the cached sequence length (allow scaling) | |
| 2 - the current sequence length is in the original scale (avoid losing precision with small sequences) | |
| """ | |
| seq_len = torch.max(position_ids) + 1 | |
| if seq_len > self.max_seq_len_cached: # growth | |
| inv_freq, self.attention_scaling = self.rope_init_fn( | |
| self.config, device, seq_len=seq_len, **self.rope_kwargs | |
| ) | |
| self.register_buffer("inv_freq", inv_freq, persistent=False) # TODO joao: may break with compilation | |
| self.max_seq_len_cached = seq_len | |
| if seq_len < self.original_max_seq_len and self.max_seq_len_cached > self.original_max_seq_len: # reset | |
| self.register_buffer("inv_freq", self.original_inv_freq, persistent=False) | |
| self.max_seq_len_cached = self.original_max_seq_len | |
| def forward(self, x, position_ids): | |
| if "dynamic" in self.rope_type: | |
| self._dynamic_frequency_update(position_ids, device=x.device) | |
| # Core RoPE block | |
| inv_freq_expanded = self.inv_freq[None, :, None].float().expand(position_ids.shape[0], -1, 1) | |
| position_ids_expanded = position_ids[:, None, :].float() | |
| # Force float32 (see https://github.com/huggingface/transformers/pull/29285) | |
| device_type = x.device.type | |
| device_type = device_type if isinstance(device_type, str) and device_type != "mps" else "cpu" | |
| with torch.autocast(device_type=device_type, enabled=False): | |
| freqs = (inv_freq_expanded.float() @ position_ids_expanded.float()).transpose(1, 2) | |
| emb = torch.cat((freqs, freqs), dim=-1) | |
| cos = emb.cos() | |
| sin = emb.sin() | |
| # Advanced RoPE types (e.g. yarn) apply a post-processing scaling factor, equivalent to scaling attention | |
| cos = cos * self.attention_scaling | |
| sin = sin * self.attention_scaling | |
| return cos.to(dtype=x.dtype), sin.to(dtype=x.dtype) | |
| class LlamaLinearScalingRotaryEmbedding(LlamaRotaryEmbedding): | |
| """LlamaRotaryEmbedding extended with linear scaling. Credits to the Reddit user /u/kaiokendev""" | |
| def __init__(self, *args, **kwargs): | |
| logger.warning_once( | |
| "`LlamaLinearScalingRotaryEmbedding` is deprecated an will be removed in v4.46. Please use " | |
| "`LlamaRotaryEmbedding`, which now also does linear scaling (simply pass the model config to __init__)." | |
| ) | |
| kwargs["rope_type"] = "linear" | |
| super().__init__(*args, **kwargs) | |
| class LlamaDynamicNTKScalingRotaryEmbedding(LlamaRotaryEmbedding): | |
| """LlamaRotaryEmbedding extended with Dynamic NTK scaling. Credits to the Reddit users /u/bloc97 and /u/emozilla""" | |
| def __init__(self, *args, **kwargs): | |
| logger.warning_once( | |
| "`LlamaDynamicNTKScalingRotaryEmbedding` is deprecated an will be removed in v4.46. Please use " | |
| "`LlamaRotaryEmbedding`, which now also does dynamic ntk scaling (simply pass the model config to " | |
| "__init__)." | |
| ) | |
| kwargs["rope_type"] = "dynamic" | |
| super().__init__(*args, **kwargs) | |
| def rotate_half(x): | |
| """Rotates half the hidden dims of the input.""" | |
| x1 = x[..., : x.shape[-1] // 2] | |
| x2 = x[..., x.shape[-1] // 2 :] | |
| return torch.cat((-x2, x1), dim=-1) | |
| def apply_rotary_pos_emb(q, k, cos, sin, position_ids=None, unsqueeze_dim=1): | |
| """Applies Rotary Position Embedding to the query and key tensors. | |
| Args: | |
| q (`torch.Tensor`): The query tensor. | |
| k (`torch.Tensor`): The key tensor. | |
| cos (`torch.Tensor`): The cosine part of the rotary embedding. | |
| sin (`torch.Tensor`): The sine part of the rotary embedding. | |
| position_ids (`torch.Tensor`, *optional*): | |
| Deprecated and unused. | |
| unsqueeze_dim (`int`, *optional*, defaults to 1): | |
| The 'unsqueeze_dim' argument specifies the dimension along which to unsqueeze cos[position_ids] and | |
| sin[position_ids] so that they can be properly broadcasted to the dimensions of q and k. For example, note | |
| that cos[position_ids] and sin[position_ids] have the shape [batch_size, seq_len, head_dim]. Then, if q and | |
| k have the shape [batch_size, heads, seq_len, head_dim], then setting unsqueeze_dim=1 makes | |
| cos[position_ids] and sin[position_ids] broadcastable to the shapes of q and k. Similarly, if q and k have | |
| the shape [batch_size, seq_len, heads, head_dim], then set unsqueeze_dim=2. | |
| Returns: | |
| `tuple(torch.Tensor)` comprising of the query and key tensors rotated using the Rotary Position Embedding. | |
| """ | |
| cos = cos.unsqueeze(unsqueeze_dim) | |
| sin = sin.unsqueeze(unsqueeze_dim) | |
| q_embed = (q * cos) + (rotate_half(q) * sin) | |
| k_embed = (k * cos) + (rotate_half(k) * sin) | |
| return q_embed, k_embed | |
| class LlamaMLP(nn.Module): | |
| def __init__(self, config): | |
| super().__init__() | |
| self.config = config | |
| self.hidden_size = config.hidden_size | |
| self.intermediate_size = config.intermediate_size | |
| self.gate_proj = nn.Linear(self.hidden_size, self.intermediate_size, bias=config.mlp_bias) | |
| self.up_proj = nn.Linear(self.hidden_size, self.intermediate_size, bias=config.mlp_bias) | |
| self.down_proj = nn.Linear(self.intermediate_size, self.hidden_size, bias=config.mlp_bias) | |
| self.act_fn = ACT2FN[config.hidden_act] | |
| def forward(self, x): | |
| if self.config.pretraining_tp > 1: | |
| slice = self.intermediate_size // self.config.pretraining_tp | |
| gate_proj_slices = self.gate_proj.weight.split(slice, dim=0) | |
| up_proj_slices = self.up_proj.weight.split(slice, dim=0) | |
| down_proj_slices = self.down_proj.weight.split(slice, dim=1) | |
| gate_proj = torch.cat( | |
| [F.linear(x, gate_proj_slices[i]) for i in range(self.config.pretraining_tp)], dim=-1 | |
| ) | |
| up_proj = torch.cat([F.linear(x, up_proj_slices[i]) for i in range(self.config.pretraining_tp)], dim=-1) | |
| intermediate_states = (self.act_fn(gate_proj) * up_proj).split(slice, dim=2) | |
| down_proj = [ | |
| F.linear(intermediate_states[i], down_proj_slices[i]) for i in range(self.config.pretraining_tp) | |
| ] | |
| down_proj = sum(down_proj) | |
| else: | |
| down_proj = self.down_proj(self.act_fn(self.gate_proj(x)) * self.up_proj(x)) | |
| return down_proj | |
| def repeat_kv(hidden_states: torch.Tensor, n_rep: int) -> torch.Tensor: | |
| """ | |
| This is the equivalent of torch.repeat_interleave(x, dim=1, repeats=n_rep). The hidden states go from (batch, | |
| num_key_value_heads, seqlen, head_dim) to (batch, num_attention_heads, seqlen, head_dim) | |
| """ | |
| batch, num_key_value_heads, slen, head_dim = hidden_states.shape | |
| if n_rep == 1: | |
| return hidden_states | |
| hidden_states = hidden_states[:, :, None, :, :].expand(batch, num_key_value_heads, n_rep, slen, head_dim) | |
| return hidden_states.reshape(batch, num_key_value_heads * n_rep, slen, head_dim) | |
| def calc_chunks_with_stride(cu_seqlen, chunk_size, kernel_stride): | |
| """ | |
| Compute the chunks that require Sparse attention, with stride support. | |
| Args: | |
| cu_seqlen (torch.Tensor): Cumulative sequence lengths for each sample. | |
| chunk_size (int): Chunk size used for Sparse attention. | |
| kernel_stride (int): Stride size when sliding over the sequence. | |
| Returns: | |
| filtered_indices (torch.Tensor): Indices used to directly index into the key/value tensors. | |
| cu_seqlens_compressed (torch.Tensor): Cumulative sequence lengths after compression. | |
| """ | |
| # 1. Compute the length of each sequence | |
| batch_sizes = cu_seqlen[1:] - cu_seqlen[:-1] | |
| # 2. Compute the start positions of chunks for each sequence (with stride) | |
| max_seq_len = torch.max(batch_sizes) | |
| max_num_chunks_per_seq = (max_seq_len - chunk_size) // kernel_stride + 1 | |
| chunk_start_offsets = torch.arange(0, max_num_chunks_per_seq * kernel_stride, kernel_stride, device=cu_seqlen.device) | |
| seq_starts = cu_seqlen[:-1] | |
| chunk_start_in_seq = seq_starts[:, None] + chunk_start_offsets[None, :] # [batch_size, max_num_chunks_per_seq] | |
| # 3. Filter out chunks that exceed sequence length or are smaller than the full chunk size | |
| chunk_end_in_seq = chunk_start_in_seq + chunk_size | |
| valid_chunk_mask = (chunk_end_in_seq <= (seq_starts[:, None] + batch_sizes[:, None])) | |
| # 4. Filter valid chunk start positions using the valid_chunk_mask | |
| valid_chunk_starts = chunk_start_in_seq[valid_chunk_mask] # [num_valid_chunks] | |
| del chunk_start_in_seq | |
| # 5. Generate filtered_indices | |
| chunk_indices = torch.arange( | |
| 0, chunk_size, device=cu_seqlen.device | |
| )[None, :] # [1, chunk_size] | |
| filtered_indices = valid_chunk_starts[:, None] + chunk_indices # [num_valid_chunks, chunk_size] | |
| filtered_indices = filtered_indices.view(-1) # Flatten to 1D indices | |
| # 6. Compute compressed cumulative sequence lengths | |
| num_filtered_chunks_per_batch = valid_chunk_mask.sum(dim=1) # Number of valid chunks per batch | |
| cu_seqlens_compressed = torch.zeros( | |
| len(cu_seqlen), dtype=torch.int32, device=cu_seqlen.device | |
| ) | |
| cu_seqlens_compressed[1:] = num_filtered_chunks_per_batch.cumsum(dim=0) | |
| del num_filtered_chunks_per_batch, chunk_start_offsets, seq_starts, chunk_end_in_seq, valid_chunk_mask, chunk_indices | |
| return filtered_indices, cu_seqlens_compressed | |
| class CompressK(torch.nn.Module): | |
| def __init__(self, head_num_k, head_dim, kernel_size, kernel_stride=16): | |
| """ | |
| Module for compressing key (K) representations. | |
| Args: | |
| head_num_k (int): Number of key attention heads. | |
| head_dim (int): Dimension of each attention head. | |
| kernel_size (int): Size of each chunk used for compression. | |
| kernel_stride (int, optional): Stride used when dividing input into chunks. Default is 16. | |
| """ | |
| super().__init__() | |
| self.kernel_size = kernel_size | |
| self.head_num_k = head_num_k | |
| self.head_dim = head_dim | |
| self.kernel_stride = kernel_stride | |
| def forward(self, k: torch.Tensor, cu_seqlens): | |
| """ | |
| Forward pass for compressing the key (K) tensor. | |
| Args: | |
| k (torch.Tensor): Input key tensor of shape (total_seq_len, num_heads, head_dim). | |
| cu_seqlens (torch.Tensor): Cumulative sequence lengths for each sample in the batch, typically used for handling variable-length sequences. | |
| Returns: | |
| compress_k (torch.Tensor): Compressed key tensor. | |
| cu_seqlens_compressed (torch.Tensor): Updated cumulative sequence lengths after compression. | |
| """ | |
| # Compute chunk-related metadata, with stride support | |
| filtered_k_indices, cu_seqlens_compressed = calc_chunks_with_stride( | |
| cu_seqlens, self.kernel_size, self.kernel_stride | |
| ) | |
| # Extract filtered key vectors | |
| filtered_k = k.index_select(0, filtered_k_indices.view(-1)) | |
| # split | |
| filtered_k = filtered_k.view(filtered_k.shape[0] // self.kernel_size, self.kernel_size, self.head_num_k, self.head_dim) # [l, block_size,h,d] | |
| compressed_k = filtered_k.mean(dim=1) | |
| return compressed_k, cu_seqlens_compressed | |
| class LlamaAttention(nn.Module): | |
| """Multi-headed attention from 'Attention Is All You Need' paper""" | |
| def __init__(self, config: LlamaConfig, layer_idx: Optional[int] = None): | |
| super().__init__() | |
| self.config = config | |
| self.layer_idx = layer_idx | |
| if layer_idx is None: | |
| logger.warning_once( | |
| f"Instantiating {self.__class__.__name__} without passing a `layer_idx` is not recommended and will " | |
| "lead to errors during the forward call if caching is used. Please make sure to provide a `layer_idx` " | |
| "when creating this class." | |
| ) | |
| self.attention_dropout = config.attention_dropout | |
| self.hidden_size = config.hidden_size | |
| self.num_heads = config.num_attention_heads | |
| self.head_dim = getattr(config, "head_dim", self.hidden_size // self.num_heads) | |
| self.num_key_value_heads = config.num_key_value_heads | |
| self.num_key_value_groups = self.num_heads // self.num_key_value_heads | |
| self.max_position_embeddings = config.max_position_embeddings | |
| self.rope_theta = config.rope_theta | |
| self.is_causal = True | |
| self.q_proj = nn.Linear(self.hidden_size, self.num_heads * self.head_dim, bias=config.attention_bias) | |
| self.k_proj = nn.Linear(self.hidden_size, self.num_key_value_heads * self.head_dim, bias=config.attention_bias) | |
| self.v_proj = nn.Linear(self.hidden_size, self.num_key_value_heads * self.head_dim, bias=config.attention_bias) | |
| self.o_proj = nn.Linear(self.num_heads * self.head_dim, self.hidden_size, bias=config.attention_bias) | |
| self.kernel_size = 32 | |
| self.kernel_stride = 16 | |
| self.init_blocks = 1 | |
| self.block_size = 64 | |
| self.window_size = 1024 | |
| self.local_blocks = self.window_size // self.block_size | |
| self.topk = 64 | |
| self.use_nope = False | |
| self.dense_len = 0 | |
| self.compress_k = CompressK(self.num_key_value_heads, self.head_dim, kernel_size=self.kernel_size, kernel_stride=self.kernel_stride) | |
| self.A = nn.Parameter(torch.zeros(self.num_key_value_heads)) | |
| self.delta = nn.Linear(self.num_key_value_heads * self.head_dim, self.num_key_value_heads, bias=config.attention_bias) | |
| print("Use InfLLMv2") | |
| # TODO (joao): remove in v4.46 (RoPE is computed in the model, not in the decoder layers) | |
| self.rotary_emb = LlamaRotaryEmbedding(config=self.config) | |
| # self.A = nn.Parameter(torch.zeros(self.num_key_value_heads)) | |
| # self.dt_proj = nn.Linear( | |
| # self.num_key_value_heads * self.head_dim, self.num_key_value_heads, bias=config.attention_bias | |
| # ) | |
| def forward( | |
| self, | |
| hidden_states: torch.Tensor, | |
| attention_mask: Optional[torch.Tensor] = None, | |
| position_ids: Optional[torch.LongTensor] = None, | |
| past_key_value: Optional[Cache] = None, | |
| output_attentions: bool = False, | |
| use_cache: bool = False, | |
| cache_position: Optional[torch.LongTensor] = None, | |
| position_embeddings: Optional[Tuple[torch.Tensor, torch.Tensor]] = None, # will become mandatory in v4.46 | |
| **kwargs, | |
| ) -> Tuple[torch.Tensor, Optional[torch.Tensor], Optional[Tuple[torch.Tensor]]]: | |
| bsz, q_len, _ = hidden_states.size() | |
| if self.config.pretraining_tp > 1: | |
| key_value_slicing = (self.num_key_value_heads * self.head_dim) // self.config.pretraining_tp | |
| query_slices = self.q_proj.weight.split( | |
| (self.num_heads * self.head_dim) // self.config.pretraining_tp, dim=0 | |
| ) | |
| key_slices = self.k_proj.weight.split(key_value_slicing, dim=0) | |
| value_slices = self.v_proj.weight.split(key_value_slicing, dim=0) | |
| query_states = [F.linear(hidden_states, query_slices[i]) for i in range(self.config.pretraining_tp)] | |
| query_states = torch.cat(query_states, dim=-1) | |
| key_states = [F.linear(hidden_states, key_slices[i]) for i in range(self.config.pretraining_tp)] | |
| key_states = torch.cat(key_states, dim=-1) | |
| value_states = [F.linear(hidden_states, value_slices[i]) for i in range(self.config.pretraining_tp)] | |
| value_states = torch.cat(value_states, dim=-1) | |
| else: | |
| query_states = self.q_proj(hidden_states) | |
| key_states = self.k_proj(hidden_states) | |
| value_states = self.v_proj(hidden_states) | |
| query_states = query_states.view(bsz, q_len, self.num_heads, self.head_dim).transpose(1, 2) | |
| key_states = key_states.view(bsz, q_len, self.num_key_value_heads, self.head_dim).transpose(1, 2) | |
| value_states = value_states.view(bsz, q_len, self.num_key_value_heads, self.head_dim).transpose(1, 2) | |
| if position_embeddings is None: | |
| logger.warning_once( | |
| "The attention layers in this model are transitioning from computing the RoPE embeddings internally " | |
| "through `position_ids` (2D tensor with the indexes of the tokens), to using externally computed " | |
| "`position_embeddings` (Tuple of tensors, containing cos and sin). In v4.46 `position_ids` will be " | |
| "removed and `position_embeddings` will be mandatory." | |
| ) | |
| cos, sin = self.rotary_emb(value_states, position_ids) | |
| else: | |
| cos, sin = position_embeddings | |
| query_states, key_states = apply_rotary_pos_emb(query_states, key_states, cos, sin) | |
| if past_key_value is not None: | |
| # sin and cos are specific to RoPE models; cache_position needed for the static cache | |
| cache_kwargs = {"sin": sin, "cos": cos, "cache_position": cache_position} | |
| key_states, value_states = past_key_value.update(key_states, value_states, self.layer_idx, cache_kwargs) | |
| key_states = repeat_kv(key_states, self.num_key_value_groups) | |
| value_states = repeat_kv(value_states, self.num_key_value_groups) | |
| attn_weights = torch.matmul(query_states, key_states.transpose(2, 3)) / math.sqrt(self.head_dim) | |
| if attention_mask is not None: # no matter the length, we just slice it | |
| causal_mask = attention_mask[:, :, :, : key_states.shape[-2]] | |
| attn_weights = attn_weights + causal_mask | |
| # upcast attention to fp32 | |
| attn_weights = nn.functional.softmax(attn_weights, dim=-1, dtype=torch.float32).to(query_states.dtype) | |
| attn_weights = nn.functional.dropout(attn_weights, p=self.attention_dropout, training=self.training) | |
| attn_output = torch.matmul(attn_weights, value_states) | |
| if attn_output.size() != (bsz, self.num_heads, q_len, self.head_dim): | |
| raise ValueError( | |
| f"`attn_output` should be of size {(bsz, self.num_heads, q_len, self.head_dim)}, but is" | |
| f" {attn_output.size()}" | |
| ) | |
| attn_output = attn_output.transpose(1, 2).contiguous() | |
| attn_output = attn_output.reshape(bsz, q_len, -1) | |
| if self.config.pretraining_tp > 1: | |
| attn_output = attn_output.split(self.hidden_size // self.config.pretraining_tp, dim=2) | |
| o_proj_slices = self.o_proj.weight.split(self.hidden_size // self.config.pretraining_tp, dim=1) | |
| attn_output = sum([F.linear(attn_output[i], o_proj_slices[i]) for i in range(self.config.pretraining_tp)]) | |
| else: | |
| attn_output = self.o_proj(attn_output) | |
| if not output_attentions: | |
| attn_weights = None | |
| return attn_output, attn_weights, past_key_value | |
| class LlamaFlashAttention2(LlamaAttention): | |
| """ | |
| Llama flash attention module. This module inherits from `LlamaAttention` as the weights of the module stays | |
| untouched. The only required change would be on the forward pass where it needs to correctly call the public API of | |
| flash attention and deal with padding tokens in case the input contains any of them. | |
| """ | |
| def __init__(self, *args, **kwargs): | |
| super().__init__(*args, **kwargs) | |
| # TODO: Should be removed once Flash Attention for RoCm is bumped to 2.1. | |
| # flash_attn<2.1 generates top-left aligned causal mask, while what is needed here is bottom-right alignement, that was made default for flash_attn>=2.1. This attribute is used to handle this difference. Reference: https://github.com/Dao-AILab/flash-attention/releases/tag/v2.1.0. | |
| # Beware that with flash_attn<2.1, using q_seqlen != k_seqlen (except for the case q_seqlen == 1) produces a wrong mask (top-left). | |
| self._flash_attn_uses_top_left_mask = not is_flash_attn_greater_or_equal_2_10() | |
| def forward( | |
| self, | |
| hidden_states: torch.Tensor, | |
| attention_mask: Optional[torch.LongTensor] = None, | |
| position_ids: Optional[torch.LongTensor] = None, | |
| past_key_value: Optional[Cache] = None, | |
| output_attentions: bool = False, | |
| use_cache: bool = False, | |
| cache_position: Optional[torch.LongTensor] = None, | |
| position_embeddings: Optional[Tuple[torch.Tensor, torch.Tensor]] = None, # will become mandatory in v4.46 | |
| ) -> Tuple[torch.Tensor, Optional[torch.Tensor], Optional[Tuple[torch.Tensor]]]: | |
| if isinstance(past_key_value, StaticCache): | |
| raise ValueError( | |
| "`static` cache implementation is not compatible with `attn_implementation==flash_attention_2` " | |
| "make sure to use `sdpa` in the mean time, and open an issue at https://github.com/huggingface/transformers" | |
| ) | |
| output_attentions = False | |
| bsz, q_len, _ = hidden_states.size() | |
| query_states = self.q_proj(hidden_states) | |
| key_states = self.k_proj(hidden_states) | |
| value_states = self.v_proj(hidden_states) | |
| # Flash attention requires the input to have the shape | |
| # batch_size x seq_length x head_dim x hidden_dim | |
| # therefore we just need to keep the original shape | |
| query_states = query_states.view(bsz, q_len, self.num_heads, self.head_dim).transpose(1, 2) | |
| key_states = key_states.view(bsz, q_len, self.num_key_value_heads, self.head_dim).transpose(1, 2) | |
| value_states = value_states.view(bsz, q_len, self.num_key_value_heads, self.head_dim).transpose(1, 2) | |
| if position_embeddings is None: | |
| logger.warning_once( | |
| "The attention layers in this model are transitioning from computing the RoPE embeddings internally " | |
| "through `position_ids` (2D tensor with the indexes of the tokens), to using externally computed " | |
| "`position_embeddings` (Tuple of tensors, containing cos and sin). In v4.46 `position_ids` will be " | |
| "removed and `position_embeddings` will be mandatory." | |
| ) | |
| cos, sin = self.rotary_emb(value_states, position_ids) | |
| else: | |
| cos, sin = position_embeddings | |
| query_states, key_states = apply_rotary_pos_emb(query_states, key_states, cos, sin) | |
| if past_key_value is not None: | |
| # sin and cos are specific to RoPE models; cache_position needed for the static cache | |
| cache_kwargs = {"sin": sin, "cos": cos, "cache_position": cache_position} | |
| key_states, value_states = past_key_value.update(key_states, value_states, self.layer_idx, cache_kwargs) | |
| # TODO: These transpose are quite inefficient but Flash Attention requires the layout [batch_size, sequence_length, num_heads, head_dim]. We would need to refactor the KV cache | |
| # to be able to avoid many of these transpose/reshape/view. | |
| query_states = query_states.transpose(1, 2) | |
| key_states = key_states.transpose(1, 2) | |
| value_states = value_states.transpose(1, 2) | |
| dropout_rate = self.attention_dropout if self.training else 0.0 | |
| # In PEFT, usually we cast the layer norms in float32 for training stability reasons | |
| # therefore the input hidden states gets silently casted in float32. Hence, we need | |
| # cast them back in the correct dtype just to be sure everything works as expected. | |
| # This might slowdown training & inference so it is recommended to not cast the LayerNorms | |
| # in fp32. (LlamaRMSNorm handles it correctly) | |
| input_dtype = query_states.dtype | |
| if input_dtype == torch.float32: | |
| if torch.is_autocast_enabled(): | |
| target_dtype = torch.get_autocast_gpu_dtype() | |
| # Handle the case where the model is quantized | |
| elif hasattr(self.config, "_pre_quantization_dtype"): | |
| target_dtype = self.config._pre_quantization_dtype | |
| else: | |
| target_dtype = self.q_proj.weight.dtype | |
| logger.warning_once( | |
| f"The input hidden states seems to be silently casted in float32, this might be related to" | |
| f" the fact you have upcasted embedding or layer norm layers in float32. We will cast back the input in" | |
| f" {target_dtype}." | |
| ) | |
| query_states = query_states.to(target_dtype) | |
| key_states = key_states.to(target_dtype) | |
| value_states = value_states.to(target_dtype) | |
| attn_output = _flash_attention_forward( | |
| query_states, | |
| key_states, | |
| value_states, | |
| attention_mask, | |
| q_len, | |
| position_ids=position_ids, | |
| dropout=dropout_rate, | |
| sliding_window=getattr(self, "sliding_window", None), | |
| use_top_left_mask=self._flash_attn_uses_top_left_mask, | |
| is_causal=self.is_causal, | |
| ) | |
| attn_output = attn_output.reshape(bsz, q_len, -1).contiguous() | |
| attn_output = self.o_proj(attn_output) | |
| if not output_attentions: | |
| attn_weights = None | |
| return attn_output, attn_weights, past_key_value | |
| try: | |
| from flash_attn import flash_attn_func, flash_attn_varlen_func | |
| from flash_attn.bert_padding import index_first_axis, pad_input, unpad_input # noqa | |
| from infllm_v2 import ( | |
| infllmv2_attn_stage1, | |
| infllmv2_attn_varlen_func, | |
| infllmv2_attn_with_kvcache, | |
| max_pooling_1d, | |
| max_pooling_1d_varlen | |
| ) | |
| except: | |
| pass | |
| def _get_unpad_data(attention_mask): | |
| seqlens_in_batch = attention_mask.sum(dim=-1, dtype=torch.int32) | |
| indices = torch.nonzero(attention_mask.flatten(), as_tuple=False).flatten() | |
| max_seqlen_in_batch = seqlens_in_batch.max().item() | |
| cu_seqlens = F.pad(torch.cumsum(seqlens_in_batch, dim=0, dtype=torch.torch.int32), (1, 0)) | |
| return ( | |
| indices, | |
| cu_seqlens, | |
| max_seqlen_in_batch, | |
| ) | |
| def _unpad_one_tensor(hidden_states, attention_mask): | |
| # Unpad the hidden states using the indices | |
| indices, cu_seqlens, max_seqlen_in_batch = _get_unpad_data(attention_mask) | |
| batch_size, seq_len = hidden_states.shape[:2] | |
| # Get the remaining dimensions | |
| remaining_dims = hidden_states.shape[2:] | |
| # Reshape to (batch_size * seq_len, *remaining_dims) | |
| reshaped_states = hidden_states.reshape(batch_size * seq_len, *remaining_dims) | |
| # Apply unpadding using indices | |
| unpadded_states = index_first_axis(reshaped_states, indices) | |
| return unpadded_states, indices, cu_seqlens, max_seqlen_in_batch | |
| def compressed_attention( | |
| q: torch.Tensor, | |
| k: torch.Tensor, | |
| v: torch.Tensor, | |
| cis: torch.Tensor, | |
| kernel_size: int, | |
| kernel_stride: int, | |
| block_size: int, | |
| topk: int, | |
| cu_seqlens_q: torch.Tensor, | |
| cu_seqlens_k: torch.Tensor, | |
| max_seqlen_q: int, | |
| max_seqlen_k: int, | |
| sm_scale: float = None, | |
| init_blocks: int = 1, | |
| local_blocks: int = 2, | |
| select_blocks: int = 16, | |
| cache_lens: torch.Tensor = None, | |
| cu_seqlens_k_ori: torch.Tensor = None, | |
| max_seqlen_in_batch_k_ori: int = None, | |
| ) -> Tuple[torch.Tensor, torch.Tensor]: | |
| """Attention between query and compressed key and value. Compute attention output and topk block idx used in topk_sparse_attention. | |
| Args: | |
| q (torch.Tensor): shape [total_q_len, num_q_heads, head_dim] | |
| k (torch.Tensor): shape [total_kv_len, num_kv_heads, head_dim] | |
| v (torch.Tensor): shape [total_kv_len, num_kv_heads, head_dim] | |
| kernel_size (int): kernel size in compress_key_value | |
| kernel_stride (int): stride of compress_key_value | |
| block_size (int): key value block size for topk sparse attention. | |
| topk (int): number of blocks for each query. | |
| cu_seqlens_q (torch.Tensor): shape [batch_size + 1], similar to cu_seqlens_q in flash_attn_func_varlen. | |
| cu_seqlens_k (torch.Tensor): shape [batch_size + 1], similar to cu_seqlens_k in flash_attn_func_varlen. | |
| max_seqlen_q (int): max q len of the batch. | |
| max_seqlen_k (int): max k len of the batch. | |
| sm_scale (float, optional): softmax scale. Defaults to None, means 1/sqrt(head_dim). | |
| init_blocks (int, optional): Number of init blocks for each query. Defaults to 1. | |
| local_blocks (int, optional): Number of local blocks for each query. Defaults to 2. | |
| cache_lens (torch.Tensor, optional): shape [batch_size], used to record the cache length of each query. Defaults to None. | |
| Returns: | |
| Tuple[torch.Tensor, torch.Tensor]: attention output and topk_idx used in topk_sparse_attention | |
| """ | |
| with torch.no_grad(): | |
| batch_size = cu_seqlens_q.shape[0] - 1 | |
| # Check if it's prefilling stage | |
| is_prefilling = cache_lens is None or (cache_lens == 0).all().item() | |
| # prefilling stage | |
| if is_prefilling: | |
| # Calculate q_idx for each query position in each batch | |
| cache_lens = torch.zeros(batch_size, dtype=torch.int32, device=q.device) | |
| q_idx = torch.cat([ | |
| (torch.arange(cu_seqlens_q[i + 1] - cu_seqlens_q[i], device=q.device) + | |
| max_seqlen_q - (cu_seqlens_q[i + 1] - cu_seqlens_q[i])) // block_size | |
| for i in range(batch_size) | |
| ], dim=0) # shape: [total_q_len] | |
| # decoding stage | |
| else: | |
| # Each batch has only one query (last position). Shape: [batch_size] = [total_q_len] in decoding | |
| q_idx = cache_lens // block_size | |
| # compute attention score | |
| score = infllmv2_attn_stage1( | |
| q.contiguous(), | |
| k.contiguous(), | |
| v.contiguous(), | |
| cu_seqlens_q=cu_seqlens_q, | |
| cu_seqlens_k=cu_seqlens_k, | |
| max_seqlen_q=max_seqlen_q, | |
| max_seqlen_k=max_seqlen_k, | |
| causal=is_prefilling) | |
| # Shape: [num_heads, total_q_len, num_blocks] | |
| score_cis = nosa_mean_pooling(cis.squeeze(-1), cu_seqlens_k_ori, max_seqlen_in_batch_k_ori) | |
| score = score[:, :q_idx.shape[0], :] | |
| score_cis = score_cis[:, :q_idx.shape[0], :] | |
| # c_score = cis.permute(2, 0, 1) # (H, B, N) | |
| # q_len = c_score.shape[-1] | |
| # c_score = F.avg_pool1d(c_score, kernel_size=32, stride=16) # (H, B, num_blocks) | |
| # c_score = c_score.unsqueeze(2).repeat(1, 1, q_len, 1) | |
| # c_score = c_score.flatten(1, 2) | |
| # Shape: [num_heads, total_q_len, num_blocks] | |
| block_score = max_pooling_1d_varlen( | |
| score.contiguous(), | |
| cu_seqlens_q, | |
| cu_seqlens_k, | |
| cache_lens, | |
| max_seqlen_q, | |
| max_seqlen_k, | |
| local_blocks=local_blocks, | |
| init_blocks=init_blocks, | |
| block_size=block_size, | |
| stride=kernel_stride) | |
| try: | |
| block_score_cis = max_pooling_1d_varlen( | |
| score_cis.contiguous(), | |
| cu_seqlens_q, | |
| cu_seqlens_k, | |
| cache_lens, | |
| max_seqlen_q, | |
| max_seqlen_k, | |
| local_blocks=local_blocks, | |
| init_blocks=init_blocks, | |
| block_size=block_size, | |
| stride=kernel_stride | |
| ) # shape: [num_heads, total_q_len, num_blocks] | |
| except: | |
| breakpoint() | |
| j_idx = torch.arange(block_score_cis.shape[-1], device=block_score_cis.device).unsqueeze(0) | |
| ninf_mask = j_idx > q_idx.unsqueeze(1) | |
| block_score_cis = block_score_cis.masked_fill(ninf_mask.unsqueeze(0), float('-inf')) | |
| # get topk | |
| qk_select = min(init_blocks + local_blocks + select_blocks, block_score.shape[-1]) | |
| topk_idx_qk = block_score.topk(qk_select, dim=-1).indices | |
| scatter_mask = torch.zeros_like(block_score_cis, dtype=torch.bool) | |
| scatter_mask.scatter_(2, topk_idx_qk, True) | |
| block_score_cis = block_score_cis.masked_fill(scatter_mask, float('inf')) | |
| # get topk | |
| topk = min(topk, block_score.shape[-1]) | |
| topk_idx = block_score_cis.topk(topk, dim=-1).indices.sort(-1).values | |
| topk_idx[topk_idx > q_idx[None, :, None]] = -1 | |
| topk_idx = topk_idx.to(torch.int32) | |
| return topk_idx | |
| class LlamaSdpaAttention(LlamaAttention): | |
| """ | |
| Llama attention module using torch.nn.functional.scaled_dot_product_attention. This module inherits from | |
| `LlamaAttention` as the weights of the module stays untouched. The only changes are on the forward pass to adapt to | |
| SDPA API. | |
| """ | |
| # Adapted from LlamaAttention.forward | |
| def forward( | |
| self, | |
| hidden_states: torch.Tensor, | |
| attention_mask: Optional[torch.Tensor] = None, | |
| position_ids: Optional[torch.LongTensor] = None, | |
| past_key_value: Optional[Cache] = None, | |
| output_attentions: bool = False, | |
| use_cache: bool = False, | |
| cache_position: Optional[torch.LongTensor] = None, | |
| position_embeddings: Optional[Tuple[torch.Tensor, torch.Tensor]] = None, # will become mandatory in v4.46 | |
| **kwargs, | |
| ) -> Tuple[torch.Tensor, Optional[torch.Tensor], Optional[Tuple[torch.Tensor]]]: | |
| if output_attentions: | |
| # TODO: Improve this warning with e.g. `model.config.attn_implementation = "manual"` once this is implemented. | |
| logger.warning_once( | |
| "LlamaModel is using LlamaSdpaAttention, but `torch.nn.functional.scaled_dot_product_attention` does not support `output_attentions=True`. Falling back to the manual attention implementation, " | |
| 'but specifying the manual implementation will be required from Transformers version v5.0.0 onwards. This warning can be removed using the argument `attn_implementation="eager"` when loading the model.' | |
| ) | |
| return super().forward( | |
| hidden_states=hidden_states, | |
| attention_mask=attention_mask, | |
| position_ids=position_ids, | |
| past_key_value=past_key_value, | |
| output_attentions=output_attentions, | |
| use_cache=use_cache, | |
| cache_position=cache_position, | |
| position_embeddings=position_embeddings, | |
| ) | |
| bsz, q_len, _ = hidden_states.size() | |
| query_states = self.q_proj(hidden_states) | |
| key_states = self.k_proj(hidden_states) | |
| value_states = self.v_proj(hidden_states) | |
| query_states = query_states.view(bsz, q_len, self.num_heads, self.head_dim).transpose(1, 2) | |
| key_states = key_states.view(bsz, q_len, self.num_key_value_heads, self.head_dim).transpose(1, 2) | |
| value_states = value_states.view(bsz, q_len, self.num_key_value_heads, self.head_dim).transpose(1, 2) | |
| if position_embeddings is None: | |
| logger.warning_once( | |
| "The attention layers in this model are transitioning from computing the RoPE embeddings internally " | |
| "through `position_ids` (2D tensor with the indexes of the tokens), to using externally computed " | |
| "`position_embeddings` (Tuple of tensors, containing cos and sin). In v4.46 `position_ids` will be " | |
| "removed and `position_embeddings` will be mandatory." | |
| ) | |
| cos, sin = self.rotary_emb(value_states, position_ids) | |
| else: | |
| cos, sin = position_embeddings | |
| query_states, key_states = apply_rotary_pos_emb(query_states, key_states, cos, sin) | |
| if past_key_value is not None: | |
| # sin and cos are specific to RoPE models; cache_position needed for the static cache | |
| cache_kwargs = {"sin": sin, "cos": cos, "cache_position": cache_position} | |
| key_states, value_states = past_key_value.update(key_states, value_states, self.layer_idx, cache_kwargs) | |
| dt_states = self.delta(value_states.transpose(1, 2).flatten(2, 3)) | |
| dt_states = self.A * F.softplus(dt_states) | |
| cis = dt_states.to(hidden_states.dtype).flatten(0, 1) | |
| # key_states = repeat_kv(key_states, self.num_key_value_groups) | |
| # value_states = repeat_kv(value_states, self.num_key_value_groups) | |
| # SDPA with memory-efficient backend is currently (torch==2.1.2) bugged with non-contiguous inputs with custom attn_mask, | |
| # Reference: https://github.com/pytorch/pytorch/issues/112577. | |
| if query_states.device.type == "cuda": | |
| query_states = query_states.contiguous() | |
| key_states = key_states.contiguous() | |
| value_states = value_states.contiguous() | |
| # query_states = query_states.unsqueeze(2).repeat(1, 1, 2, 1, 1).flatten(1, 2) | |
| attn_output = self._sparse_attention_forward( | |
| query_states.transpose(1, 2), key_states.transpose(1, 2), value_states.transpose(1, 2), cis, attention_mask, q_len, dropout=0.0, | |
| no_rope_param=None, # if past_key_value is not None else None, | |
| past_key_value=None) | |
| # aos = attn_output.shape | |
| # attn_output = attn_output.view(aos[0], aos[1], -1, 2, aos[3])[:, :, :, 0, :] | |
| attn_output = attn_output.reshape(bsz, q_len, -1) | |
| attn_output = self.o_proj(attn_output) | |
| return attn_output, None, past_key_value | |
| def _sparse_attention_forward( | |
| self, | |
| query_states, | |
| key_states, | |
| value_states, | |
| cis, | |
| attention_mask, | |
| query_length, | |
| dropout=0.0, | |
| softmax_scale=None, | |
| no_rope_param=None, | |
| past_key_value=None): | |
| """ | |
| Calls the forward method of Flash Attention - if the input hidden states contain at least one padding token | |
| first unpad the input, then computes the attention scores and pad the final attention scores. | |
| Args: | |
| query_states (`torch.Tensor`): | |
| Input query states to be passed to Flash Attention API | |
| key_states (`torch.Tensor`): | |
| Input key states to be passed to Flash Attention API | |
| value_states (`torch.Tensor`): | |
| Input value states to be passed to Flash Attention API | |
| attention_mask (`torch.Tensor`): | |
| The padding mask - corresponds to a tensor of size `(batch_size, seq_len)` where 0 stands for the | |
| position of padding tokens and 1 for the position of non-padding tokens. | |
| dropout (`int`, *optional*): | |
| Attention dropout | |
| softmax_scale (`float`, *optional*): | |
| The scaling of QK^T before applying softmax. Default to 1 / sqrt(head_dim) | |
| """ | |
| # Contains at least one padding token in the sequence | |
| if attention_mask is not None: | |
| batch_size = query_states.shape[0] | |
| # assert batch_size == 1, 'Only batch_size=1 is supported at the moment.' | |
| if past_key_value!=None: | |
| compressed_k, compressed_cu_seqlens = self.get_compress_k( | |
| key_states=key_states if self.use_nope ==False else no_rope_param['key_states_no_rope'], # This can be optimized a bit; | |
| attention_mask=attention_mask, | |
| past_key_value=past_key_value) | |
| query_states, key_states, value_states, indices_q, cu_seq_lens, max_seq_lens = self._upad_input( | |
| query_states, key_states, value_states, attention_mask, query_length | |
| ) | |
| cu_seqlens_q, cu_seqlens_k = cu_seq_lens | |
| max_seqlen_in_batch_q, max_seqlen_in_batch_k = max_seq_lens | |
| if no_rope_param != None: | |
| if max_seqlen_in_batch_q == 1: | |
| no_rope_param['query_states_no_rope'] = no_rope_param['query_states_no_rope'].squeeze(1) | |
| else: | |
| no_rope_param['query_states_no_rope'],_, _, _ = _unpad_one_tensor(no_rope_param['query_states_no_rope'],attention_mask=attention_mask) | |
| if past_key_value==None: | |
| # compress_k use varlen form | |
| compressed_k, compressed_cu_seqlens = self.compress_k(key_states,cu_seqlens_k) | |
| attn_output_unpad = self.sparse_forward( | |
| query_states, | |
| key_states, | |
| value_states, | |
| cis, | |
| cu_seqlens_q, | |
| cu_seqlens_k, | |
| max_seqlen_in_batch_q, | |
| max_seqlen_in_batch_k, | |
| no_rope_param=no_rope_param, | |
| compressed_k=compressed_k, | |
| compressed_cu_seqlens=compressed_cu_seqlens) | |
| attn_output = pad_input(attn_output_unpad, indices_q, batch_size, query_length) | |
| else: | |
| raise ValueError('Need attention mask') | |
| return attn_output | |
| def get_compress_k(self, key_states, attention_mask, past_key_value): | |
| """ | |
| Get compressed key states and corresponding cumulative sequence lengths. | |
| Args: | |
| key_states: Key states tensor | |
| cu_seqlens_k: Cumulative sequence lengths for keys | |
| past_key_value: Past key-value cache | |
| no_rope_param: Optional parameter containing key states without rope | |
| Returns: | |
| Tuple of (compressed_k, compressed_cu_seqlens) | |
| """ | |
| # Check if this is prefilling or initial compression condition | |
| is_prefilling = ( | |
| key_states.shape[1] >= self.dense_len and | |
| ( | |
| not past_key_value.layers[self.layer_idx].compress_k_cache | |
| ) | |
| ) | |
| if is_prefilling: | |
| unpadded_key_states, indices, cu_seqlens, max_seqlen_in_batch = _unpad_one_tensor(key_states,attention_mask=attention_mask) | |
| # Compress the keys | |
| compressed_k, compressed_cu_seqlens = self.compress_k(unpadded_key_states, cu_seqlens) | |
| past_key_value.update_compress_k( | |
| compressed_k, self.layer_idx, compressed_cu_seqlens) | |
| no_compress_k_list = [] | |
| # Compute and update no_compress_k | |
| for i in range(len(compressed_cu_seqlens)-1): | |
| no_compress_k_start = (compressed_cu_seqlens[i+1]- compressed_cu_seqlens[i]) * self.kernel_stride | |
| no_compress_k_list.append(unpadded_key_states[cu_seqlens[i]+no_compress_k_start:cu_seqlens[i+1]].clone()) | |
| past_key_value.update_no_compress_k( | |
| no_compress_k_list, self.layer_idx,kernel_stride=self.kernel_stride, | |
| kernel_size=self.kernel_size) | |
| else: | |
| # Decode case: incremental update | |
| batch_size = key_states.shape[0] # key_states.shape = [batch_size, seq, k_head_num, head_dim] | |
| key_states_split = list(torch.split( | |
| key_states[:,-1:].squeeze(1), #[batch_size, seq, k_head_num, head_dim]->[batch_size, 1, k_head_num, head_dim]-> [batch_size, k_head_num, head_dim] | |
| [1] * batch_size,dim=0, | |
| )) | |
| # Try to update no_compress_k buffer | |
| no_compress_k_list = past_key_value.update_no_compress_k( | |
| key_states_split, self.layer_idx, | |
| kernel_stride=self.kernel_stride, | |
| kernel_size=self.kernel_size) | |
| new_compressed_k_list = [] | |
| for no_compress_k in no_compress_k_list: | |
| if no_compress_k is not None: | |
| # We have enough tokens to compress | |
| new_compressed_k = no_compress_k.mean(dim=0, keepdim=True) # [1, n_heads_k, head_dim] | |
| new_compressed_k_list.append(new_compressed_k) | |
| else: | |
| new_compressed_k_list.append(None) | |
| compressed_k, compressed_cu_seqlens = past_key_value.update_compress_k(new_compressed_k_list, self.layer_idx,) | |
| return compressed_k, compressed_cu_seqlens | |
| def sparse_forward(self, | |
| query_layer, | |
| key_layer, | |
| value_layer, | |
| cis, | |
| cu_seqlens_q, | |
| cu_seqlens_k, | |
| max_seqlen_in_batch_q, | |
| max_seqlen_in_batch_k, | |
| no_rope_param=None, | |
| compressed_k=None, | |
| compressed_cu_seqlens=None): | |
| compressed_seqlens = compressed_cu_seqlens[1:] - compressed_cu_seqlens[:-1] | |
| cache_lens = None | |
| if max_seqlen_in_batch_q==1 and max_seqlen_in_batch_k>1: #decoding | |
| seq_lens_k = cu_seqlens_k[1:] - cu_seqlens_k[:-1] | |
| cache_lens = seq_lens_k-1 | |
| topk_idx = compressed_attention( | |
| query_layer if no_rope_param is None else no_rope_param['query_states_no_rope'], | |
| compressed_k, | |
| compressed_k.clone(), | |
| cis, | |
| self.kernel_size, | |
| self.kernel_stride, | |
| self.block_size, | |
| self.topk, | |
| cu_seqlens_q, | |
| compressed_cu_seqlens, | |
| max_seqlen_in_batch_q, | |
| compressed_seqlens.max().item(), | |
| None, | |
| init_blocks=self.init_blocks, | |
| local_blocks=self.local_blocks, | |
| cache_lens=cache_lens, | |
| cu_seqlens_k_ori=cu_seqlens_k, | |
| max_seqlen_in_batch_k_ori=max_seqlen_in_batch_k, | |
| ) | |
| cis = torch.exp(cis) | |
| scaled_v = value_layer * cis[:, :, None] | |
| # scaled_v = value_layer | |
| hdim = value_layer.shape[-1] | |
| topk_attn_output, lse, _ = infllmv2_attn_varlen_func( | |
| query_layer, | |
| key_layer, | |
| scaled_v, | |
| cu_seqlens_q, | |
| cu_seqlens_k, | |
| max_seqlen_in_batch_q, | |
| max_seqlen_in_batch_k, | |
| dropout_p=0, | |
| deterministic=False, | |
| softmax_scale=None, | |
| causal=True, | |
| return_attn_probs=True, | |
| topk_idx=topk_idx | |
| ) | |
| lse = lse.reshape(-1, query_layer.shape[1]) | |
| fake_v = cis[:, :, None].repeat(1, 1, hdim) | |
| topk_attn_output_fake, lse_fake, _ = infllmv2_attn_varlen_func( | |
| query_layer, | |
| key_layer, | |
| fake_v, | |
| cu_seqlens_q, | |
| cu_seqlens_k, | |
| max_seqlen_in_batch_q, | |
| max_seqlen_in_batch_k, | |
| dropout_p=0, | |
| deterministic=False, | |
| softmax_scale=None, | |
| causal=True, | |
| return_attn_probs=True, | |
| topk_idx=topk_idx | |
| ) | |
| # breakpoint() | |
| real_denominator = topk_attn_output_fake[:, :, :1] | |
| topk_attn_output = topk_attn_output / real_denominator | |
| return topk_attn_output | |
| def _upad_input(self, query_layer, key_layer, value_layer, attention_mask, query_length): | |
| indices_k, cu_seqlens_k, max_seqlen_in_batch_k = _get_unpad_data(attention_mask) | |
| batch_size, kv_seq_len, num_key_value_heads, head_dim = key_layer.shape | |
| key_layer = index_first_axis( | |
| key_layer.reshape(batch_size * kv_seq_len, num_key_value_heads, head_dim), indices_k | |
| ) | |
| value_layer = index_first_axis( | |
| value_layer.reshape(batch_size * kv_seq_len, num_key_value_heads, head_dim), indices_k | |
| ) | |
| if query_length == kv_seq_len: | |
| query_layer = index_first_axis( | |
| query_layer.reshape(batch_size * kv_seq_len, self.num_heads, head_dim), indices_k | |
| ) | |
| cu_seqlens_q = cu_seqlens_k | |
| max_seqlen_in_batch_q = max_seqlen_in_batch_k | |
| indices_q = indices_k | |
| elif query_length == 1: | |
| max_seqlen_in_batch_q = 1 | |
| cu_seqlens_q = torch.arange( | |
| batch_size + 1, dtype=torch.int32, device=query_layer.device | |
| ) # There is a memcpy here, that is very bad. | |
| indices_q = cu_seqlens_q[:-1] | |
| query_layer = query_layer.squeeze(1) | |
| else: | |
| # The -q_len: slice assumes left padding. | |
| attention_mask = attention_mask[:, -query_length:] | |
| query_layer, indices_q, cu_seqlens_q, max_seqlen_in_batch_q = unpad_input(query_layer, attention_mask) | |
| return ( | |
| query_layer, | |
| key_layer, | |
| value_layer, | |
| indices_q, | |
| (cu_seqlens_q, cu_seqlens_k), | |
| (max_seqlen_in_batch_q, max_seqlen_in_batch_k), | |
| ) | |
| LLAMA_ATTENTION_CLASSES = { | |
| "eager": LlamaAttention, | |
| "flash_attention_2": LlamaFlashAttention2, | |
| "sdpa": LlamaSdpaAttention, | |
| } | |
| class LlamaDecoderLayer(nn.Module): | |
| def __init__(self, config: LlamaConfig, layer_idx: int): | |
| super().__init__() | |
| self.hidden_size = config.hidden_size | |
| self.self_attn = LLAMA_ATTENTION_CLASSES[config._attn_implementation](config=config, layer_idx=layer_idx) | |
| self.mlp = LlamaMLP(config) | |
| self.input_layernorm = LlamaRMSNorm(config.hidden_size, eps=config.rms_norm_eps) | |
| self.post_attention_layernorm = LlamaRMSNorm(config.hidden_size, eps=config.rms_norm_eps) | |
| def forward( | |
| self, | |
| hidden_states: torch.Tensor, | |
| attention_mask: Optional[torch.Tensor] = None, | |
| position_ids: Optional[torch.LongTensor] = None, | |
| past_key_value: Optional[Cache] = None, | |
| output_attentions: Optional[bool] = False, | |
| use_cache: Optional[bool] = False, | |
| cache_position: Optional[torch.LongTensor] = None, | |
| position_embeddings: Optional[Tuple[torch.Tensor, torch.Tensor]] = None, # will become mandatory in v4.46 | |
| **kwargs, | |
| ) -> Tuple[torch.FloatTensor, Optional[Tuple[torch.FloatTensor, torch.FloatTensor]]]: | |
| """ | |
| Args: | |
| hidden_states (`torch.FloatTensor`): input to the layer of shape `(batch, seq_len, embed_dim)` | |
| attention_mask (`torch.FloatTensor`, *optional*): | |
| attention mask of size `(batch_size, sequence_length)` if flash attention is used or `(batch_size, 1, | |
| query_sequence_length, key_sequence_length)` if default attention is used. | |
| output_attentions (`bool`, *optional*): | |
| Whether or not to return the attentions tensors of all attention layers. See `attentions` under | |
| returned tensors for more detail. | |
| use_cache (`bool`, *optional*): | |
| If set to `True`, `past_key_values` key value states are returned and can be used to speed up decoding | |
| (see `past_key_values`). | |
| past_key_value (`Tuple(torch.FloatTensor)`, *optional*): cached past key and value projection states | |
| cache_position (`torch.LongTensor` of shape `(sequence_length)`, *optional*): | |
| Indices depicting the position of the input sequence tokens in the sequence | |
| position_embeddings (`Tuple[torch.FloatTensor, torch.FloatTensor]`, *optional*): | |
| Tuple containing the cosine and sine positional embeddings of shape `(batch_size, seq_len, head_dim)`, | |
| with `head_dim` being the embedding dimension of each attention head. | |
| kwargs (`dict`, *optional*): | |
| Arbitrary kwargs to be ignored, used for FSDP and other methods that injects code | |
| into the model | |
| """ | |
| residual = hidden_states | |
| hidden_states = self.input_layernorm(hidden_states) | |
| # Self Attention | |
| hidden_states, self_attn_weights, present_key_value = self.self_attn( | |
| hidden_states=hidden_states, | |
| attention_mask=attention_mask, | |
| position_ids=position_ids, | |
| past_key_value=past_key_value, | |
| output_attentions=output_attentions, | |
| use_cache=use_cache, | |
| cache_position=cache_position, | |
| position_embeddings=position_embeddings, | |
| **kwargs, | |
| ) | |
| hidden_states = residual + hidden_states | |
| # Fully Connected | |
| residual = hidden_states | |
| hidden_states = self.post_attention_layernorm(hidden_states) | |
| hidden_states = self.mlp(hidden_states) | |
| hidden_states = residual + hidden_states | |
| outputs = (hidden_states,) | |
| if output_attentions: | |
| outputs += (self_attn_weights,) | |
| if use_cache: | |
| outputs += (present_key_value,) | |
| return outputs | |
| LLAMA_START_DOCSTRING = r""" | |
| This model inherits from [`PreTrainedModel`]. Check the superclass documentation for the generic methods the | |
| library implements for all its model (such as downloading or saving, resizing the input embeddings, pruning heads | |
| etc.) | |
| This model is also a PyTorch [torch.nn.Module](https://pytorch.org/docs/stable/nn.html#torch.nn.Module) subclass. | |
| Use it as a regular PyTorch Module and refer to the PyTorch documentation for all matter related to general usage | |
| and behavior. | |
| Parameters: | |
| config ([`LlamaConfig`]): | |
| Model configuration class with all the parameters of the model. Initializing with a config file does not | |
| load the weights associated with the model, only the configuration. Check out the | |
| [`~PreTrainedModel.from_pretrained`] method to load the model weights. | |
| """ | |
| class LlamaPreTrainedModel(PreTrainedModel): | |
| config_class = LlamaConfig | |
| base_model_prefix = "model" | |
| supports_gradient_checkpointing = True | |
| _no_split_modules = ["LlamaDecoderLayer"] | |
| _skip_keys_device_placement = ["past_key_values"] | |
| _supports_flash_attn_2 = True | |
| _supports_sdpa = True | |
| _supports_cache_class = True | |
| _supports_quantized_cache = True | |
| _supports_static_cache = True | |
| def _init_weights(self, module): | |
| std = self.config.initializer_range | |
| if isinstance(module, nn.Linear): | |
| module.weight.data.normal_(mean=0.0, std=std) | |
| if module.bias is not None: | |
| module.bias.data.zero_() | |
| elif isinstance(module, nn.Embedding): | |
| module.weight.data.normal_(mean=0.0, std=std) | |
| if module.padding_idx is not None: | |
| module.weight.data[module.padding_idx].zero_() | |
| LLAMA_INPUTS_DOCSTRING = r""" | |
| Args: | |
| input_ids (`torch.LongTensor` of shape `(batch_size, sequence_length)`): | |
| Indices of input sequence tokens in the vocabulary. Padding will be ignored by default should you provide | |
| it. | |
| Indices can be obtained using [`AutoTokenizer`]. See [`PreTrainedTokenizer.encode`] and | |
| [`PreTrainedTokenizer.__call__`] for details. | |
| [What are input IDs?](../glossary#input-ids) | |
| attention_mask (`torch.Tensor` of shape `(batch_size, sequence_length)`, *optional*): | |
| Mask to avoid performing attention on padding token indices. Mask values selected in `[0, 1]`: | |
| - 1 for tokens that are **not masked**, | |
| - 0 for tokens that are **masked**. | |
| [What are attention masks?](../glossary#attention-mask) | |
| Indices can be obtained using [`AutoTokenizer`]. See [`PreTrainedTokenizer.encode`] and | |
| [`PreTrainedTokenizer.__call__`] for details. | |
| If `past_key_values` is used, optionally only the last `input_ids` have to be input (see | |
| `past_key_values`). | |
| If you want to change padding behavior, you should read [`modeling_opt._prepare_decoder_attention_mask`] | |
| and modify to your needs. See diagram 1 in [the paper](https://arxiv.org/abs/1910.13461) for more | |
| information on the default strategy. | |
| - 1 indicates the head is **not masked**, | |
| - 0 indicates the head is **masked**. | |
| position_ids (`torch.LongTensor` of shape `(batch_size, sequence_length)`, *optional*): | |
| Indices of positions of each input sequence tokens in the position embeddings. Selected in the range `[0, | |
| config.n_positions - 1]`. | |
| [What are position IDs?](../glossary#position-ids) | |
| past_key_values (`Cache` or `tuple(tuple(torch.FloatTensor))`, *optional*): | |
| Pre-computed hidden-states (key and values in the self-attention blocks and in the cross-attention | |
| blocks) that can be used to speed up sequential decoding. This typically consists in the `past_key_values` | |
| returned by the model at a previous stage of decoding, when `use_cache=True` or `config.use_cache=True`. | |
| Two formats are allowed: | |
| - a [`~cache_utils.Cache`] instance, see our | |
| [kv cache guide](https://huggingface.co/docs/transformers/en/kv_cache); | |
| - Tuple of `tuple(torch.FloatTensor)` of length `config.n_layers`, with each tuple having 2 tensors of | |
| shape `(batch_size, num_heads, sequence_length, embed_size_per_head)`). This is also known as the legacy | |
| cache format. | |
| The model will output the same cache format that is fed as input. If no `past_key_values` are passed, the | |
| legacy cache format will be returned. | |
| If `past_key_values` are used, the user can optionally input only the last `input_ids` (those that don't | |
| have their past key value states given to this model) of shape `(batch_size, 1)` instead of all `input_ids` | |
| of shape `(batch_size, sequence_length)`. | |
| inputs_embeds (`torch.FloatTensor` of shape `(batch_size, sequence_length, hidden_size)`, *optional*): | |
| Optionally, instead of passing `input_ids` you can choose to directly pass an embedded representation. This | |
| is useful if you want more control over how to convert `input_ids` indices into associated vectors than the | |
| model's internal embedding lookup matrix. | |
| use_cache (`bool`, *optional*): | |
| If set to `True`, `past_key_values` key value states are returned and can be used to speed up decoding (see | |
| `past_key_values`). | |
| output_attentions (`bool`, *optional*): | |
| Whether or not to return the attentions tensors of all attention layers. See `attentions` under returned | |
| tensors for more detail. | |
| output_hidden_states (`bool`, *optional*): | |
| Whether or not to return the hidden states of all layers. See `hidden_states` under returned tensors for | |
| more detail. | |
| return_dict (`bool`, *optional*): | |
| Whether or not to return a [`~utils.ModelOutput`] instead of a plain tuple. | |
| cache_position (`torch.LongTensor` of shape `(sequence_length)`, *optional*): | |
| Indices depicting the position of the input sequence tokens in the sequence. Contrarily to `position_ids`, | |
| this tensor is not affected by padding. It is used to update the cache in the correct position and to infer | |
| the complete sequence length. | |
| """ | |
| class LlamaModel(LlamaPreTrainedModel): | |
| """ | |
| Transformer decoder consisting of *config.num_hidden_layers* layers. Each layer is a [`LlamaDecoderLayer`] | |
| Args: | |
| config: LlamaConfig | |
| """ | |
| def __init__(self, config: LlamaConfig): | |
| super().__init__(config) | |
| self.padding_idx = config.pad_token_id | |
| self.vocab_size = config.vocab_size | |
| self.embed_tokens = nn.Embedding(config.vocab_size, config.hidden_size, self.padding_idx) | |
| self.layers = nn.ModuleList( | |
| [LlamaDecoderLayer(config, layer_idx) for layer_idx in range(config.num_hidden_layers)] | |
| ) | |
| self.norm = LlamaRMSNorm(config.hidden_size, eps=config.rms_norm_eps) | |
| self.rotary_emb = LlamaRotaryEmbedding(config=config) | |
| self.gradient_checkpointing = False | |
| # Initialize weights and apply final processing | |
| self.post_init() | |
| def get_input_embeddings(self): | |
| return self.embed_tokens | |
| def set_input_embeddings(self, value): | |
| self.embed_tokens = value | |
| def forward( | |
| self, | |
| input_ids: torch.LongTensor = None, | |
| attention_mask: Optional[torch.Tensor] = None, | |
| position_ids: Optional[torch.LongTensor] = None, | |
| past_key_values: Optional[Union[Cache, List[torch.FloatTensor]]] = None, | |
| inputs_embeds: Optional[torch.FloatTensor] = None, | |
| use_cache: Optional[bool] = None, | |
| output_attentions: Optional[bool] = None, | |
| output_hidden_states: Optional[bool] = None, | |
| return_dict: Optional[bool] = None, | |
| cache_position: Optional[torch.LongTensor] = None, | |
| ) -> Union[Tuple, BaseModelOutputWithPast]: | |
| output_attentions = output_attentions if output_attentions is not None else self.config.output_attentions | |
| output_hidden_states = ( | |
| output_hidden_states if output_hidden_states is not None else self.config.output_hidden_states | |
| ) | |
| use_cache = use_cache if use_cache is not None else self.config.use_cache | |
| return_dict = return_dict if return_dict is not None else self.config.use_return_dict | |
| if (input_ids is None) ^ (inputs_embeds is not None): | |
| raise ValueError( | |
| "You cannot specify both input_ids and inputs_embeds at the same time, and must specify either one" | |
| ) | |
| if self.gradient_checkpointing and self.training and use_cache: | |
| logger.warning_once( | |
| "`use_cache=True` is incompatible with gradient checkpointing. Setting `use_cache=False`." | |
| ) | |
| use_cache = False | |
| if inputs_embeds is None: | |
| inputs_embeds = self.embed_tokens(input_ids) | |
| # kept for BC (non `Cache` `past_key_values` inputs) | |
| return_legacy_cache = False | |
| if use_cache and not isinstance(past_key_values, Cache): | |
| return_legacy_cache = True | |
| if past_key_values is None: | |
| past_key_values = DynamicCache() | |
| else: | |
| past_key_values = DynamicCache.from_legacy_cache(past_key_values) | |
| logger.warning_once( | |
| "We detected that you are passing `past_key_values` as a tuple of tuples. This is deprecated and " | |
| "will be removed in v4.47. Please convert your cache or use an appropriate `Cache` class " | |
| "(https://huggingface.co/docs/transformers/kv_cache#legacy-cache-format)" | |
| ) | |
| if cache_position is None: | |
| past_seen_tokens = past_key_values.get_seq_length() if past_key_values is not None else 0 | |
| cache_position = torch.arange( | |
| past_seen_tokens, past_seen_tokens + inputs_embeds.shape[1], device=inputs_embeds.device | |
| ) | |
| if position_ids is None: | |
| position_ids = cache_position.unsqueeze(0) | |
| causal_mask = self._update_causal_mask( | |
| attention_mask, inputs_embeds, cache_position, past_key_values, output_attentions | |
| ) | |
| hidden_states = inputs_embeds | |
| # create position embeddings to be shared across the decoder layers | |
| position_embeddings = self.rotary_emb(hidden_states, position_ids) | |
| # decoder layers | |
| all_hidden_states = () if output_hidden_states else None | |
| all_self_attns = () if output_attentions else None | |
| next_decoder_cache = None | |
| for decoder_layer in self.layers: | |
| if output_hidden_states: | |
| all_hidden_states += (hidden_states,) | |
| if self.gradient_checkpointing and self.training: | |
| layer_outputs = self._gradient_checkpointing_func( | |
| decoder_layer.__call__, | |
| hidden_states, | |
| attention_mask, | |
| position_ids, | |
| past_key_values, | |
| output_attentions, | |
| use_cache, | |
| cache_position, | |
| position_embeddings, | |
| ) | |
| else: | |
| layer_outputs = decoder_layer( | |
| hidden_states, | |
| attention_mask=attention_mask, | |
| position_ids=position_ids, | |
| past_key_value=past_key_values, | |
| output_attentions=output_attentions, | |
| use_cache=use_cache, | |
| cache_position=cache_position, | |
| position_embeddings=position_embeddings, | |
| ) | |
| hidden_states = layer_outputs[0] | |
| if use_cache: | |
| next_decoder_cache = layer_outputs[2 if output_attentions else 1] | |
| if output_attentions: | |
| all_self_attns += (layer_outputs[1],) | |
| hidden_states = self.norm(hidden_states) | |
| # add hidden states from the last decoder layer | |
| if output_hidden_states: | |
| all_hidden_states += (hidden_states,) | |
| next_cache = next_decoder_cache if use_cache else None | |
| if return_legacy_cache: | |
| next_cache = next_cache.to_legacy_cache() | |
| if not return_dict: | |
| return tuple(v for v in [hidden_states, next_cache, all_hidden_states, all_self_attns] if v is not None) | |
| return BaseModelOutputWithPast( | |
| last_hidden_state=hidden_states, | |
| past_key_values=next_cache, | |
| hidden_states=all_hidden_states, | |
| attentions=all_self_attns, | |
| ) | |
| def _update_causal_mask( | |
| self, | |
| attention_mask: torch.Tensor, | |
| input_tensor: torch.Tensor, | |
| cache_position: torch.Tensor, | |
| past_key_values: Cache, | |
| output_attentions: bool, | |
| ): | |
| if self.config._attn_implementation == "flash_attention_2": | |
| if attention_mask is not None and 0.0 in attention_mask: | |
| return attention_mask | |
| return None | |
| # For SDPA, when possible, we will rely on its `is_causal` argument instead of its `attn_mask` argument, in | |
| # order to dispatch on Flash Attention 2. This feature is not compatible with static cache, as SDPA will fail | |
| # to infer the attention mask. | |
| past_seen_tokens = past_key_values.get_seq_length() if past_key_values is not None else 0 | |
| using_static_cache = isinstance(past_key_values, StaticCache) | |
| # When output attentions is True, sdpa implementation's forward method calls the eager implementation's forward | |
| if self.config._attn_implementation == "sdpa" and not using_static_cache and not output_attentions: | |
| if AttentionMaskConverter._ignore_causal_mask_sdpa( | |
| attention_mask, | |
| inputs_embeds=input_tensor, | |
| past_key_values_length=past_seen_tokens, | |
| is_training=self.training, | |
| ): | |
| return None | |
| dtype, device = input_tensor.dtype, input_tensor.device | |
| min_dtype = torch.finfo(dtype).min | |
| sequence_length = input_tensor.shape[1] | |
| if using_static_cache: | |
| target_length = past_key_values.get_max_length() | |
| else: | |
| target_length = ( | |
| attention_mask.shape[-1] | |
| if isinstance(attention_mask, torch.Tensor) | |
| else past_seen_tokens + sequence_length + 1 | |
| ) | |
| # In case the provided `attention` mask is 2D, we generate a causal mask here (4D). | |
| causal_mask = _prepare_4d_causal_attention_mask_with_cache_position( | |
| attention_mask, | |
| sequence_length=sequence_length, | |
| target_length=target_length, | |
| dtype=dtype, | |
| device=device, | |
| min_dtype=min_dtype, | |
| cache_position=cache_position, | |
| batch_size=input_tensor.shape[0], | |
| ) | |
| if ( | |
| self.config._attn_implementation == "sdpa" | |
| and attention_mask is not None | |
| and attention_mask.device.type == "cuda" | |
| and not output_attentions | |
| ): | |
| # Attend to all tokens in fully masked rows in the causal_mask, for example the relevant first rows when | |
| # using left padding. This is required by F.scaled_dot_product_attention memory-efficient attention path. | |
| # Details: https://github.com/pytorch/pytorch/issues/110213 | |
| causal_mask = AttentionMaskConverter._unmask_unattended(causal_mask, min_dtype) | |
| return causal_mask | |
| class SparseLlamaForCausalLM(LlamaPreTrainedModel, GenerationMixin): | |
| _tied_weights_keys = ["lm_head.weight"] | |
| def __init__(self, config): | |
| super().__init__(config) | |
| self.model = LlamaModel(config) | |
| self.vocab_size = config.vocab_size | |
| self.lm_head = nn.Linear(config.hidden_size, config.vocab_size, bias=False) | |
| # Initialize weights and apply final processing | |
| self.post_init() | |
| def get_input_embeddings(self): | |
| return self.model.embed_tokens | |
| def set_input_embeddings(self, value): | |
| self.model.embed_tokens = value | |
| def get_output_embeddings(self): | |
| return self.lm_head | |
| def set_output_embeddings(self, new_embeddings): | |
| self.lm_head = new_embeddings | |
| def set_decoder(self, decoder): | |
| self.model = decoder | |
| def get_decoder(self): | |
| return self.model | |
| def forward( | |
| self, | |
| input_ids: torch.LongTensor = None, | |
| attention_mask: Optional[torch.Tensor] = None, | |
| position_ids: Optional[torch.LongTensor] = None, | |
| past_key_values: Optional[Union[Cache, List[torch.FloatTensor]]] = None, | |
| inputs_embeds: Optional[torch.FloatTensor] = None, | |
| labels: Optional[torch.LongTensor] = None, | |
| use_cache: Optional[bool] = None, | |
| output_attentions: Optional[bool] = None, | |
| output_hidden_states: Optional[bool] = None, | |
| return_dict: Optional[bool] = None, | |
| cache_position: Optional[torch.LongTensor] = None, | |
| num_logits_to_keep: int = 0, | |
| ) -> Union[Tuple, CausalLMOutputWithPast]: | |
| r""" | |
| Args: | |
| labels (`torch.LongTensor` of shape `(batch_size, sequence_length)`, *optional*): | |
| Labels for computing the masked language modeling loss. Indices should either be in `[0, ..., | |
| config.vocab_size]` or -100 (see `input_ids` docstring). Tokens with indices set to `-100` are ignored | |
| (masked), the loss is only computed for the tokens with labels in `[0, ..., config.vocab_size]`. | |
| num_logits_to_keep (`int`, *optional*): | |
| Calculate logits for the last `num_logits_to_keep` tokens. If `0`, calculate logits for all | |
| `input_ids` (special case). Only last token logits are needed for generation, and calculating them only for that | |
| token can save memory, which becomes pretty significant for long sequences or large vocabulary size. | |
| Returns: | |
| Example: | |
| ```python | |
| >>> from transformers import AutoTokenizer, LlamaForCausalLM | |
| >>> model = LlamaForCausalLM.from_pretrained("meta-llama/Llama-2-7b-hf") | |
| >>> tokenizer = AutoTokenizer.from_pretrained("meta-llama/Llama-2-7b-hf") | |
| >>> 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." | |
| ```""" | |
| output_attentions = output_attentions if output_attentions is not None else self.config.output_attentions | |
| output_hidden_states = ( | |
| output_hidden_states if output_hidden_states is not None else self.config.output_hidden_states | |
| ) | |
| return_dict = return_dict if return_dict is not None else self.config.use_return_dict | |
| if attention_mask is None: | |
| attention_mask = torch.ones_like(input_ids) | |
| # decoder outputs consists of (dec_features, layer_state, dec_hidden, dec_attn) | |
| outputs = self.model( | |
| input_ids=input_ids, | |
| attention_mask=attention_mask, | |
| position_ids=position_ids, | |
| past_key_values=past_key_values, | |
| inputs_embeds=inputs_embeds, | |
| use_cache=use_cache, | |
| output_attentions=output_attentions, | |
| output_hidden_states=output_hidden_states, | |
| return_dict=return_dict, | |
| cache_position=cache_position, | |
| ) | |
| hidden_states = outputs[0] | |
| if self.config.pretraining_tp > 1: | |
| lm_head_slices = self.lm_head.weight.split(self.vocab_size // self.config.pretraining_tp, dim=0) | |
| logits = [F.linear(hidden_states, lm_head_slices[i]) for i in range(self.config.pretraining_tp)] | |
| logits = torch.cat(logits, dim=-1) | |
| else: | |
| if labels is None and not is_torchdynamo_compiling(): | |
| logger.warning_once( | |
| "Starting from v4.46, the `logits` model output will have the same type as the model (except at train time, where it will always be FP32)" | |
| ) | |
| # Only compute necessary logits, and do not upcast them to float if we are not computing the loss | |
| # TODO: remove the float() operation in v4.46 | |
| logits = self.lm_head(hidden_states[:, -num_logits_to_keep:, :]).float() | |
| loss = None | |
| if labels is not None: | |
| # Upcast to float if we need to compute the loss to avoid potential precision issues | |
| logits = logits.float() | |
| # Shift so that tokens < n predict n | |
| shift_logits = logits[..., :-1, :].contiguous() | |
| shift_labels = labels[..., 1:].contiguous() | |
| # Flatten the tokens | |
| loss_fct = CrossEntropyLoss() | |
| shift_logits = shift_logits.view(-1, self.config.vocab_size) | |
| shift_labels = shift_labels.view(-1) | |
| # Enable model parallelism | |
| shift_labels = shift_labels.to(shift_logits.device) | |
| loss = loss_fct(shift_logits, shift_labels) | |
| if not return_dict: | |
| output = (logits,) + outputs[1:] | |
| return (loss,) + output if loss is not None else output | |
| return CausalLMOutputWithPast( | |
| loss=loss, | |
| logits=logits, | |
| past_key_values=outputs.past_key_values, | |
| hidden_states=outputs.hidden_states, | |
| attentions=outputs.attentions, | |
| ) | |
| def prepare_inputs_for_generation( | |
| self, | |
| input_ids, | |
| past_key_values=None, | |
| attention_mask=None, | |
| inputs_embeds=None, | |
| cache_position=None, | |
| position_ids=None, | |
| use_cache=True, | |
| num_logits_to_keep=None, | |
| **kwargs, | |
| ): | |
| # If we have cache: let's slice `input_ids` through `cache_position`, to keep only the unprocessed tokens | |
| # Exception 1: when passing input_embeds, input_ids may be missing entries | |
| # Exception 2: some generation methods do special slicing of input_ids, so we don't need to do it here | |
| if past_key_values is not None: | |
| if inputs_embeds is not None: # Exception 1 | |
| input_ids = input_ids[:, -cache_position.shape[0] :] | |
| elif input_ids.shape[1] != cache_position.shape[0]: # Default case (the "else", a no op, is Exception 2) | |
| input_ids = input_ids[:, cache_position] | |
| if attention_mask is not None and position_ids is None: | |
| # create position_ids on the fly for batch generation | |
| position_ids = attention_mask.long().cumsum(-1) - 1 | |
| position_ids.masked_fill_(attention_mask == 0, 1) | |
| if past_key_values: | |
| position_ids = position_ids[:, -input_ids.shape[1] :] | |
| # This `clone` call is needed to avoid recapturing cuda graphs with `torch.compile`'s `mode="reduce-overhead`, as otherwise the input `position_ids` would have various stride during the decoding. Here, simply using `.contiguous()` is not sufficient as in the batch size = 1 case, `position_ids` is already contiguous but with varying stride which retriggers a capture. | |
| position_ids = position_ids.clone(memory_format=torch.contiguous_format) | |
| # if `inputs_embeds` are passed, we only want to use them in the 1st generation step | |
| if inputs_embeds is not None and cache_position[0] == 0: | |
| model_inputs = {"inputs_embeds": inputs_embeds, "input_ids": None} | |
| else: | |
| # The clone here is for the same reason as for `position_ids`. | |
| model_inputs = {"input_ids": input_ids.clone(memory_format=torch.contiguous_format), "inputs_embeds": None} | |
| if isinstance(past_key_values, StaticCache) and attention_mask.ndim == 2: | |
| if model_inputs["inputs_embeds"] is not None: | |
| batch_size, sequence_length, _ = model_inputs["inputs_embeds"].shape | |
| device = model_inputs["inputs_embeds"].device | |
| else: | |
| batch_size, sequence_length = model_inputs["input_ids"].shape | |
| device = model_inputs["input_ids"].device | |
| dtype = self.lm_head.weight.dtype | |
| min_dtype = torch.finfo(dtype).min | |
| attention_mask = _prepare_4d_causal_attention_mask_with_cache_position( | |
| attention_mask, | |
| sequence_length=sequence_length, | |
| target_length=past_key_values.get_max_length(), | |
| dtype=dtype, | |
| device=device, | |
| min_dtype=min_dtype, | |
| cache_position=cache_position, | |
| batch_size=batch_size, | |
| ) | |
| if num_logits_to_keep is not None: | |
| model_inputs["num_logits_to_keep"] = num_logits_to_keep | |
| model_inputs.update( | |
| { | |
| "position_ids": position_ids, | |
| "cache_position": cache_position, | |
| "past_key_values": past_key_values, | |
| "use_cache": use_cache, | |
| "attention_mask": attention_mask, | |
| } | |
| ) | |
| return model_inputs | |
| class LlamaForSequenceClassification(LlamaPreTrainedModel): | |
| def __init__(self, config): | |
| super().__init__(config) | |
| self.num_labels = config.num_labels | |
| self.model = LlamaModel(config) | |
| self.score = nn.Linear(config.hidden_size, self.num_labels, bias=False) | |
| # Initialize weights and apply final processing | |
| self.post_init() | |
| def get_input_embeddings(self): | |
| return self.model.embed_tokens | |
| def set_input_embeddings(self, value): | |
| self.model.embed_tokens = value | |
| def forward( | |
| self, | |
| input_ids: Optional[torch.LongTensor] = None, | |
| attention_mask: Optional[torch.Tensor] = None, | |
| position_ids: Optional[torch.LongTensor] = None, | |
| past_key_values: Optional[Union[Cache, List[torch.FloatTensor]]] = None, | |
| inputs_embeds: Optional[torch.FloatTensor] = None, | |
| labels: Optional[torch.LongTensor] = None, | |
| use_cache: Optional[bool] = None, | |
| output_attentions: Optional[bool] = None, | |
| output_hidden_states: Optional[bool] = None, | |
| return_dict: Optional[bool] = None, | |
| ) -> Union[Tuple, SequenceClassifierOutputWithPast]: | |
| r""" | |
| labels (`torch.LongTensor` of shape `(batch_size,)`, *optional*): | |
| Labels for computing the sequence classification/regression loss. Indices should be in `[0, ..., | |
| config.num_labels - 1]`. If `config.num_labels == 1` a regression loss is computed (Mean-Square loss), If | |
| `config.num_labels > 1` a classification loss is computed (Cross-Entropy). | |
| """ | |
| return_dict = return_dict if return_dict is not None else self.config.use_return_dict | |
| transformer_outputs = self.model( | |
| input_ids, | |
| attention_mask=attention_mask, | |
| position_ids=position_ids, | |
| past_key_values=past_key_values, | |
| inputs_embeds=inputs_embeds, | |
| use_cache=use_cache, | |
| output_attentions=output_attentions, | |
| output_hidden_states=output_hidden_states, | |
| return_dict=return_dict, | |
| ) | |
| hidden_states = transformer_outputs[0] | |
| logits = self.score(hidden_states) | |
| if input_ids is not None: | |
| batch_size = input_ids.shape[0] | |
| else: | |
| batch_size = inputs_embeds.shape[0] | |
| if self.config.pad_token_id is None and batch_size != 1: | |
| raise ValueError("Cannot handle batch sizes > 1 if no padding token is defined.") | |
| if self.config.pad_token_id is None: | |
| sequence_lengths = -1 | |
| else: | |
| if input_ids is not None: | |
| # if no pad token found, use modulo instead of reverse indexing for ONNX compatibility | |
| sequence_lengths = torch.eq(input_ids, self.config.pad_token_id).int().argmax(-1) - 1 | |
| sequence_lengths = sequence_lengths % input_ids.shape[-1] | |
| sequence_lengths = sequence_lengths.to(logits.device) | |
| else: | |
| sequence_lengths = -1 | |
| pooled_logits = logits[torch.arange(batch_size, device=logits.device), sequence_lengths] | |
| loss = None | |
| if labels is not None: | |
| labels = labels.to(logits.device) | |
| if self.config.problem_type is None: | |
| if self.num_labels == 1: | |
| self.config.problem_type = "regression" | |
| elif self.num_labels > 1 and (labels.dtype == torch.long or labels.dtype == torch.int): | |
| self.config.problem_type = "single_label_classification" | |
| else: | |
| self.config.problem_type = "multi_label_classification" | |
| if self.config.problem_type == "regression": | |
| loss_fct = MSELoss() | |
| if self.num_labels == 1: | |
| loss = loss_fct(pooled_logits.squeeze(), labels.squeeze()) | |
| else: | |
| loss = loss_fct(pooled_logits, labels) | |
| elif self.config.problem_type == "single_label_classification": | |
| loss_fct = CrossEntropyLoss() | |
| loss = loss_fct(pooled_logits.view(-1, self.num_labels), labels.view(-1)) | |
| elif self.config.problem_type == "multi_label_classification": | |
| loss_fct = BCEWithLogitsLoss() | |
| loss = loss_fct(pooled_logits, labels) | |
| if not return_dict: | |
| output = (pooled_logits,) + transformer_outputs[1:] | |
| return ((loss,) + output) if loss is not None else output | |
| return SequenceClassifierOutputWithPast( | |
| loss=loss, | |
| logits=pooled_logits, | |
| past_key_values=transformer_outputs.past_key_values, | |
| hidden_states=transformer_outputs.hidden_states, | |
| attentions=transformer_outputs.attentions, | |
| ) | |
| class LlamaForQuestionAnswering(LlamaPreTrainedModel): | |
| base_model_prefix = "transformer" | |
| # Copied from transformers.models.bloom.modeling_bloom.BloomForQuestionAnswering.__init__ with Bloom->Llama | |
| def __init__(self, config): | |
| super().__init__(config) | |
| self.transformer = LlamaModel(config) | |
| self.qa_outputs = nn.Linear(config.hidden_size, 2) | |
| # Initialize weights and apply final processing | |
| self.post_init() | |
| def get_input_embeddings(self): | |
| return self.transformer.embed_tokens | |
| def set_input_embeddings(self, value): | |
| self.transformer.embed_tokens = value | |
| def forward( | |
| self, | |
| input_ids: Optional[torch.LongTensor] = None, | |
| attention_mask: Optional[torch.FloatTensor] = None, | |
| position_ids: Optional[torch.LongTensor] = None, | |
| past_key_values: Optional[Union[Cache, List[torch.FloatTensor]]] = None, | |
| inputs_embeds: Optional[torch.FloatTensor] = None, | |
| start_positions: Optional[torch.LongTensor] = None, | |
| end_positions: Optional[torch.LongTensor] = None, | |
| output_attentions: Optional[bool] = None, | |
| output_hidden_states: Optional[bool] = None, | |
| return_dict: Optional[bool] = None, | |
| ) -> Union[Tuple, QuestionAnsweringModelOutput]: | |
| r""" | |
| start_positions (`torch.LongTensor` of shape `(batch_size,)`, *optional*): | |
| Labels for position (index) of the start of the labelled span for computing the token classification loss. | |
| Positions are clamped to the length of the sequence (`sequence_length`). Position outside of the sequence | |
| are not taken into account for computing the loss. | |
| end_positions (`torch.LongTensor` of shape `(batch_size,)`, *optional*): | |
| Labels for position (index) of the end of the labelled span for computing the token classification loss. | |
| Positions are clamped to the length of the sequence (`sequence_length`). Position outside of the sequence | |
| are not taken into account for computing the loss. | |
| """ | |
| return_dict = return_dict if return_dict is not None else self.config.use_return_dict | |
| outputs = self.transformer( | |
| input_ids, | |
| attention_mask=attention_mask, | |
| position_ids=position_ids, | |
| past_key_values=past_key_values, | |
| inputs_embeds=inputs_embeds, | |
| output_attentions=output_attentions, | |
| output_hidden_states=output_hidden_states, | |
| return_dict=return_dict, | |
| ) | |
| sequence_output = outputs[0] | |
| logits = self.qa_outputs(sequence_output) | |
| start_logits, end_logits = logits.split(1, dim=-1) | |
| start_logits = start_logits.squeeze(-1).contiguous() | |
| end_logits = end_logits.squeeze(-1).contiguous() | |
| total_loss = None | |
| if start_positions is not None and end_positions is not None: | |
| # If we are on multi-GPU, split add a dimension | |
| if len(start_positions.size()) > 1: | |
| start_positions = start_positions.squeeze(-1).to(start_logits.device) | |
| if len(end_positions.size()) > 1: | |
| end_positions = end_positions.squeeze(-1).to(end_logits.device) | |
| # sometimes the start/end positions are outside our model inputs, we ignore these terms | |
| ignored_index = start_logits.size(1) | |
| start_positions = start_positions.clamp(0, ignored_index) | |
| end_positions = end_positions.clamp(0, ignored_index) | |
| loss_fct = CrossEntropyLoss(ignore_index=ignored_index) | |
| start_loss = loss_fct(start_logits, start_positions) | |
| end_loss = loss_fct(end_logits, end_positions) | |
| total_loss = (start_loss + end_loss) / 2 | |
| if not return_dict: | |
| output = (start_logits, end_logits) + outputs[2:] | |
| return ((total_loss,) + output) if total_loss is not None else output | |
| return QuestionAnsweringModelOutput( | |
| loss=total_loss, | |
| start_logits=start_logits, | |
| end_logits=end_logits, | |
| hidden_states=outputs.hidden_states, | |
| attentions=outputs.attentions, | |
| ) | |
| class LlamaForTokenClassification(LlamaPreTrainedModel): | |
| def __init__(self, config): | |
| super().__init__(config) | |
| self.num_labels = config.num_labels | |
| self.model = LlamaModel(config) | |
| if getattr(config, "classifier_dropout", None) is not None: | |
| classifier_dropout = config.classifier_dropout | |
| elif getattr(config, "hidden_dropout", None) is not None: | |
| classifier_dropout = config.hidden_dropout | |
| else: | |
| classifier_dropout = 0.1 | |
| self.dropout = nn.Dropout(classifier_dropout) | |
| self.score = nn.Linear(config.hidden_size, config.num_labels) | |
| # Initialize weights and apply final processing | |
| self.post_init() | |
| def get_input_embeddings(self): | |
| return self.model.embed_tokens | |
| def set_input_embeddings(self, value): | |
| self.model.embed_tokens = value | |
| def forward( | |
| self, | |
| input_ids: Optional[torch.LongTensor] = None, | |
| attention_mask: Optional[torch.Tensor] = None, | |
| position_ids: Optional[torch.LongTensor] = None, | |
| past_key_values: Optional[List[torch.FloatTensor]] = None, | |
| inputs_embeds: Optional[torch.FloatTensor] = None, | |
| labels: Optional[torch.LongTensor] = None, | |
| use_cache: Optional[bool] = None, | |
| output_attentions: Optional[bool] = None, | |
| output_hidden_states: Optional[bool] = None, | |
| return_dict: Optional[bool] = None, | |
| ) -> Union[Tuple, TokenClassifierOutput]: | |
| r""" | |
| labels (`torch.LongTensor` of shape `(batch_size,)`, *optional*): | |
| Labels for computing the sequence classification/regression loss. Indices should be in `[0, ..., | |
| config.num_labels - 1]`. If `config.num_labels == 1` a regression loss is computed (Mean-Square loss), If | |
| `config.num_labels > 1` a classification loss is computed (Cross-Entropy). | |
| """ | |
| return_dict = return_dict if return_dict is not None else self.config.use_return_dict | |
| outputs = self.model( | |
| input_ids, | |
| attention_mask=attention_mask, | |
| position_ids=position_ids, | |
| past_key_values=past_key_values, | |
| inputs_embeds=inputs_embeds, | |
| use_cache=use_cache, | |
| output_attentions=output_attentions, | |
| output_hidden_states=output_hidden_states, | |
| return_dict=return_dict, | |
| ) | |
| sequence_output = outputs[0] | |
| sequence_output = self.dropout(sequence_output) | |
| logits = self.score(sequence_output) | |
| loss = None | |
| if labels is not None: | |
| loss_fct = CrossEntropyLoss() | |
| loss = loss_fct(logits.view(-1, self.num_labels), labels.view(-1)) | |
| if not return_dict: | |
| output = (logits,) + outputs[2:] | |
| return ((loss,) + output) if loss is not None else output | |
| return TokenClassifierOutput( | |
| loss=loss, | |
| logits=logits, | |
| hidden_states=outputs.hidden_states, | |
| attentions=outputs.attentions, | |
| ) | |