Hugging Face's logo

Transformers documentation

Mamba 2

You are viewing main version, which requires installation from source. If you'd like regular pip install, checkout the latest stable version (v5.22.1).
Hugging Face's logo
Join the Hugging Face community

and get access to the augmented documentation experience

to get started

Este modelo se publicó en HF papers el 31 de mayo de 2024 y se contribuyó a Hugging Face Transformers el 6 de agosto de 2024.

Mamba 2

Mamba 2 se basa en el marco de dualidad de espacios de estado (SSD), que conecta los modelos de espacio de estado estructurados (SSM) con las variantes de atención. Utiliza un algoritmo SSD más eficiente, de 2 a 8 veces más rápido que Mamba, y modifica la arquitectura para habilitar la paralelización de tensores y una estructura de cabeceras de atención de valores agrupados (GVA).

Puedes encontrar todos los checkpoints originales de Mamba 2 bajo la organización State Space Models, pero los ejemplos mostrados a continuación utilizan mistralai/Mamba-Codestral-7B-v0.1 porque una implementación de Hugging Face aún no es compatible con los checkpoints originales.

Otras arquitecturas basadas en Mamba 2 incluyen Bamba, FalconH1 y Zamba2.

Este modelo fue aportado por ArthurZ. Haz clic en los modelos Mamba en la barra lateral derecha para ver más ejemplos de cómo aplicar Mamba a diferentes tareas de lenguaje.

El siguiente ejemplo demuestra cómo generar texto con Pipeline, AutoModel y desde la línea de comandos.

Pipeline
AutoModel
from transformers import pipeline


pipeline = pipeline(
    task="text-generation",
    model="mistralai/Mamba-Codestral-7B-v0.1",
    device=0
)
pipeline("Plants create energy through a process known as")

La cuantización reduce la carga de memoria de los modelos grandes al representar los pesos con una precisión inferior. Consulte el resumen de Cuantización para conocer más backends de cuantización disponibles.

El ejemplo siguiente utiliza torchao para cuantizar únicamente los pesos a enteros de 4 bits.

from transformers import AutoModelForCausalLM, AutoTokenizer, TorchAoConfig


quantization_config = TorchAoConfig("int4_weight_only", group_size=128)
tokenizer = AutoTokenizer.from_pretrained("mistralai/Mamba-Codestral-7B-v0.1")
model = AutoModelForCausalLM.from_pretrained("mistralai/Mamba-Codestral-7B-v0.1", quantization_config=quantization_config, device_map="auto")
input_ids = tokenizer("Plants create energy through a process known as", return_tensors="pt").to(model.device)

output = model.generate(**input_ids)
print(tokenizer.decode(output[0], skip_special_tokens=True))

Notas

  • Codestral Mamba tiene groups=8, que son similares al número de cabezas kv en un modelo basado en atención.

  • Codestral Mamba tiene dos recorridos de propagación hacia adelante distintos, torch_forward o cuda_kernels_forward, y se espera que sus resultados sean ligeramente diferentes.

    • torch_forward sin compilación es de 3 a 4 veces más rápido que cuda_kernels_forward.
    • cuda_kernels_forward utiliza los kernels de CUDA originales si están disponibles en su entorno. Es más lento durante la prellenado porque requiere una “ejecución de calentamiento” debido a la mayor sobrecarga de CPU (consulte estos comentarios para más detalles).

  • Este modelo no tiene embeddings posicionales, pero sí cuenta con una attention_mask y una lógica específica para enmascarar los estados ocultos en dos lugares en el caso de generación por lotes (vea este comentario para más detalles). Esto (y la adición de los kernels de Mamba 2 reimplementados) da como resultado una ligera discrepancia entre la generación por lotes y la generación con caché.

  • El algoritmo SSM depende en gran medida de contracciones de tensores, que tienen equivalentes en matmul, pero el orden de las operaciones es ligeramente diferente. Esto hace que la diferencia sea mayor en precisiones más pequeñas.

  • El relleno solo se prueba con relleno a la izquierda. El relleno a la derecha actualiza la caché con las posiciones de relleno y produce resultados poco fiables. Establezca tokenizer.padding_side="left" para la generación por lotes. Consulte Lado del relleno.

  • El siguiente ejemplo demuestra cómo realizar el ajuste fino de Mamba 2 con PEFT.

from datasets import load_dataset
from peft import LoraConfig
from trl import SFTConfig, SFTTrainer


model_id = "mistralai/Mamba-Codestral-7B-v0.1"
dataset = load_dataset("Abirate/english_quotes", split="train")
training_args = SFTConfig(dataset_text_field="quote", gradient_checkpointing=True, per_device_train_batch_size=4)
lora_config =  LoraConfig(target_modules=["x_proj", "embeddings", "in_proj", "out_proj"])
trainer = SFTTrainer(
    model=model_id,
    args=training_args,
    train_dataset=dataset,
    peft_config=lora_config,
)
trainer.train()

Mamba2Config

clase transformers.Mamba2Config

< >

( transformers_version: str | None = Nonearchitectures: list[str] | None = Noneoutput_hidden_states: bool | None = Falsereturn_dict: bool | None = Truedtype: str | torch.dtype | None = Nonechunk_size_feed_forward: int = 0is_encoder_decoder: bool = Falseid2label: dict[int, str] | dict[str, str] | None = Nonelabel2id: dict[str, int] | dict[str, str] | None = Noneproblem_type: Literal['regression', 'single_label_classification', 'multi_label_classification'] | None = Nonenum_heads: int = 128head_dim: int = 64vocab_size: int = 32768hidden_size: int = 4096state_size: int = 128num_hidden_layers: int = 64layer_norm_epsilon: float = 1e-05pad_token_id: int | None = 1bos_token_id: int | None = 0eos_token_id: int | list[int] | None = 2expand: int = 2conv_kernel: int = 4n_groups: int = 8use_bias: bool = Falseuse_conv_bias: bool = Truehidden_act: str = 'silu'initializer_range: float = 0.1residual_in_fp32: bool = Truetime_step_rank: str | int = 'auto'time_step_min: float = 0.001time_step_max: float = 0.1time_step_floor: float = 0.0001time_step_limit: list[float] | tuple[float, ...] = (0.0, inf)rescale_prenorm_residual: bool = Falseuse_cache: bool = Truechunk_size: int = 256tie_word_embeddings: bool = False )

Parámetros

  • num_heads (int, opcional, valor predeterminado 128) — Número de cabezas de atención para cada capa de atención en el decodificador del Transformer.
  • head_dim (int, opcional, valor predeterminado 64) — La dimensión de la cabeza de atención. Si es None, se establecerá en hidden_size // num_attention_heads
  • vocab_size (int, opcional, valor predeterminado 32768) — Tamaño del vocabulario del modelo. Define el número de tokens diferentes que pueden representarse mediante input_ids.
  • hidden_size (int, opcional, valor predeterminado 4096) — Dimensión de las representaciones ocultas.
  • state_size (int, opcional, valor predeterminado 128) — Tamaño del estado del SSM (dimensión del estado latente) en las capas Mamba.
  • num_hidden_layers (int, opcional, valor predeterminado 64) — Número de capas ocultas en el decodificador del Transformer.
  • layer_norm_epsilon (float, opcional, valor predeterminado 1e-05) — El epsilon a utilizar en las capas de normalización de capa.
  • pad_token_id (int, opcional, valor predeterminado 1) — Id del token utilizado para el relleno en el vocabulario.
  • bos_token_id (int, opcional, valor predeterminado 0) — Id del token utilizado para el inicio de la secuencia en el vocabulario.
  • eos_token_id (Union[int, list[int]], opcional, valor predeterminado 2) — Identificador de token utilizado para el fin de secuencia en el vocabulario.
  • expand (int, opcional, valor predeterminado 2) — Factor de expansión utilizado para determinar el tamaño intermedio.
  • conv_kernel (int, opcional, valor predeterminado 4) — El tamaño del kernel de convolución.
  • n_groups (int, opcional, valor predeterminado 8) — Número de grupos para las matrices de evolución de mamba 2.
  • use_bias (bool, opcional, valor predeterminado False) — Si se usa o no sesgo en [“in_proj”, “out_proj”] del bloque mixer
  • use_conv_bias (bool, opcional, valor predeterminado True) — Indica si se debe usar sesgo en la capa de convolución del bloque mezclador.
  • hidden_act (str, opcional, valor predeterminado silu) — La función de activación no lineal (función o cadena) en el decodificador. Por ejemplo, "gelu", "relu", "silu", etc.
  • initializer_range (float, opcional, valor predeterminado 0.1) — La desviación estándar del truncated_normal_initializer para inicializar todas las matrices de pesos.
  • residual_in_fp32 (bool, opcional, valor predeterminado True) — Indica si los residuales deben estar en float32. Si se establece en False, los residuales mantendrán el mismo dtype que el resto del modelo
  • time_step_rank (Union[str, int], opcional, valor predeterminado auto) — Rango de la proyección delta (paso de tiempo). Puede ser "auto" para configurarlo automáticamente.
  • time_step_min (float, opcional, valor predeterminado 0.001) — time_step mínimo utilizado para acotar dt_proj.bias.
  • time_step_max (float, opcional, valor predeterminado 0.1) — time_step máximo utilizado para acotar dt_proj.bias.
  • time_step_floor (float, opcional, valor predeterminado 0.0001) — Valor mínimo permitido para el delta del paso de tiempo discreto tras la activación softplus.
  • time_step_limit (Union[list[float], tuple[float, ...]], opcional, valor predeterminado (0.0, inf)) — Rango aceptado de valores de paso de tiempo para el recorte.
  • rescale_prenorm_residual (bool, opcional, valor predeterminado False) — Si se deben o no reescalar los pesos de out_proj durante la inicialización.
  • use_cache (bool, opcional, valor predeterminado True) — Indica si el modelo debe devolver las últimas claves/valores de atención (no utilizado por todos los modelos). Solo es relevante si config.is_decoder=True o cuando el modelo es un modelo generativo solo de decodificador.
  • chunk_size (int, opcional, valor predeterminado 256) — Tamaño de los fragmentos que componen la secuencia.
  • tie_word_embeddings (bool, opcional, valor predeterminado False) — Si se deben vincular las matrices de pesos de embeddings según el mapeo tied_weights_keys del modelo.

Esta es la clase de configuración para almacenar la configuración de un Mamba2Model. Se utiliza para instanciar un modelo Mamba2 según los argumentos especificados, definiendo la arquitectura del modelo. Instanciar una configuración con los valores predeterminados producirá una configuración similar a la de state-spaces/mamba2-2.8b

Los objetos de configuración heredan de PreTrainedConfig y se pueden usar para controlar las salidas del modelo. Lea la documentación de PreTrainedConfig para obtener más información.

Ejemplo:

>>> from transformers import Mamba2Config, Mamba2Model

>>> # Initializing a Mamba2 configuration
>>> configuration = Mamba2Config()

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

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

Mamba2Model

clase transformers.Mamba2Model

< >

( config: Mamba2Config )

Parámetros

  • config (Mamba2Config) — Clase de configuración del modelo con todos los parámetros del modelo. Inicializar con un archivo de configuración no carga los pesos asociados con el modelo, solo la configuración. Consulte el método from_pretrained() para cargar los pesos del modelo.

El modelo Mamba2 básico que genera estados ocultos sin ningún cabezal específico en la parte superior.

Este modelo hereda de PreTrainedModel. Consulta la documentación de la clase superior para los métodos genéricos que la biblioteca implementa para todos sus modelos (como la descarga o el guardado, el redimensionamiento de las incrustaciones de entrada, la poda de cabezas, etc.).

Este modelo también es una subclase de torch.nn.Module de PyTorch. Úsalo como un módulo de PyTorch regular y consulta la documentación de PyTorch para todo lo relacionado con el uso y el comportamiento generales.

forward

< >

( input_ids: typing.Optional[torch.LongTensor] = Noneinputs_embeds: typing.Optional[torch.LongTensor] = Nonecache_params: transformers.cache_utils.Cache | None = Noneuse_cache: bool | None = Noneoutput_hidden_states: bool | None = Nonereturn_dict: bool | None = Noneattention_mask: typing.Optional[torch.Tensor] = None**kwargs ) → Mamba2Output or tuple(torch.Tensor)

Parámetros

  • input_ids (torch.LongTensor de forma (batch_size, sequence_length), opcional) — Índices de los tokens de la secuencia de entrada en el vocabulario. El relleno se ignorará de forma predeterminada.

    Los índices se pueden obtener usando AutoTokenizer. Consulte PreTrainedTokenizer.encode() y PreTrainedTokenizer.call() para más detalles.

    ¿Qué son los IDs de entrada?

  • inputs_embeds (torch.LongTensor de forma (batch_size, sequence_length, hidden_size), opcional) — Opcionalmente, en lugar de pasar input_ids, puedes elegir pasar directamente una representación incrustada. Esto es útil si deseas tener más control sobre cómo convertir los índices de input_ids en los vectores asociados que en la matriz de búsqueda de incrustaciones interna del modelo.
  • cache_params (Cache, opcional) — Si se pasa, el modelo utiliza el estado anterior en todos los bloques (lo que dará la salida para los input_ids proporcionados como si el modelo añadiera state_input_ids + input_ids como contexto).
  • use_cache (bool, opcional) — Si se establece en True, se devuelve cache_params y se puede usar para generar rápidamente los siguientes logits.
  • output_hidden_states (bool, opcional) — Indica si se deben devolver los estados ocultos de todas las capas. Consulte hidden_states en los tensores devueltos para obtener más detalles.
  • return_dict (bool, opcional) — Indica si se debe devolver un ModelOutput en lugar de una tupla simple.
  • attention_mask (torch.Tensor de forma (batch_size, sequence_length), opcional) — Máscara para evitar realizar atención en los índices de tokens de relleno. Valores de máscara seleccionados en [0, 1]:
    • 1 para los tokens que no están enmascarados,
    • 0 para los tokens que están enmascarados.

    ¿Qué son las máscaras de atención?

Devuelve

Mamba2Output o tuple(torch.Tensor)

Un Mamba2Output o una tupla de torch.Tensor (si se pasa return_dict=False o cuando config.return_dict=False) que comprende varios elementos según la configuración (Mamba2Config) y las entradas.

El método forward de Mamba2Model sobrescribe el método especial __call__.

Aunque la receta para la pasada hacia adelante debe definirse dentro de esta función, se debe llamar a la instancia de Module después en lugar de a esta, ya que la primera se encarga de ejecutar los pasos de pre y postprocesamiento, mientras que la segunda los ignora silenciosamente.

  • last_hidden_state (torch.Tensor de forma (batch_size, sequence_length, hidden_size), opcional) — Secuencia de estados ocultos en la salida de la última capa del modelo.

  • cache_params (~cache_utils.Cache, opcional) — El estado del modelo en el último paso de tiempo. Puede usarse en un método forward con los siguientes input_ids para evitar proporcionar los input_ids anteriores.

    Incluye tanto las matrices de estado del modelo de espacio de estados después del barrido selectivo como los estados de la convolución

  • hidden_states (tuple[torch.Tensor], opcional, se devuelve cuando se pasa output_hidden_states=True o cuando config.output_hidden_states=True) — Tupla de torch.Tensor (una para la salida de las incrustaciones, si el modelo tiene una capa de incrustaciones, + una para la salida de cada capa) de forma (batch_size, sequence_length, hidden_size).

    Estados ocultos del modelo en la salida de cada capa más las salidas opcionales de la incrustación inicial.

Mamba2LMHeadModel

clase transformers.Mamba2ForCausalLM

< >

( config: Mamba2Config )

Parámetros

  • config (Mamba2Config) — Clase de configuración del modelo con todos los parámetros del modelo. Inicializar con un archivo de configuración no carga los pesos asociados con el modelo, solo la configuración. Consulte el método from_pretrained() para cargar los pesos del modelo.

El transformer del modelo MAMBA2 con una cabeza de modelado de lenguaje en la parte superior (capa lineal con pesos no vinculados a las incrustaciones de entrada).

Este modelo hereda de PreTrainedModel. Consulta la documentación de la clase superior para los métodos genéricos que la biblioteca implementa para todos sus modelos (como la descarga o el guardado, el redimensionamiento de las incrustaciones de entrada, la poda de cabezas, etc.).

Este modelo también es una subclase de torch.nn.Module de PyTorch. Úsalo como un módulo de PyTorch regular y consulta la documentación de PyTorch para todo lo relacionado con el uso y el comportamiento generales.

forward

< >

( input_ids: typing.Optional[torch.LongTensor] = Noneinputs_embeds: typing.Optional[torch.Tensor] = Nonecache_params: transformers.cache_utils.Cache | None = Nonelabels: typing.Optional[torch.LongTensor] = Noneoutput_hidden_states: bool | None = Nonereturn_dict: bool | None = Noneuse_cache: bool | None = Noneattention_mask: typing.Optional[torch.Tensor] = Nonelogits_to_keep: typing.Union[int, torch.Tensor] = 0**kwargs ) → Mamba2CausalLMOutput or tuple(torch.Tensor)

Parámetros

  • input_ids (torch.LongTensor de forma (batch_size, sequence_length), opcional) — Índices de los tokens de la secuencia de entrada en el vocabulario. El relleno se ignorará de forma predeterminada.

    Los índices se pueden obtener usando AutoTokenizer. Consulte PreTrainedTokenizer.encode() y PreTrainedTokenizer.call() para más detalles.

    ¿Qué son los IDs de entrada?

  • inputs_embeds (torch.Tensor de forma (batch_size, sequence_length, hidden_size), opcional) — Opcionalmente, en lugar de pasar input_ids, puedes elegir pasar directamente una representación incrustada. Esto es útil si deseas tener más control sobre cómo convertir los índices de input_ids en los vectores asociados que en la matriz de búsqueda de incrustaciones interna del modelo.
  • cache_params (Cache, opcional) — Si se pasa, el modelo utiliza el estado anterior en todos los bloques (lo que dará la salida para los input_ids proporcionados como si el modelo añadiera state_input_ids + input_ids como contexto).
  • labels (torch.LongTensor de forma (batch_size, sequence_length), opcional) — Etiquetas para el modelado de lenguaje. Tenga en cuenta que las etiquetas se desplazan dentro del modelo, es decir, puede establecer labels = input_ids Los índices se seleccionan en [-100, 0, ..., config.vocab_size] Todas las etiquetas establecidas en -100 se ignoran (se enmascaran), la pérdida solo se calcula para las etiquetas en [0, ..., config.vocab_size]
  • output_hidden_states (bool, opcional) — Indica si se deben devolver los estados ocultos de todas las capas. Consulte hidden_states en los tensores devueltos para obtener más detalles.
  • return_dict (bool, opcional) — Indica si se debe devolver un ModelOutput en lugar de una tupla simple.
  • use_cache (bool, opcional) — Si se establece en True, se devuelve cache_params y se puede usar para generar rápidamente los siguientes logits.
  • attention_mask (torch.Tensor de forma (batch_size, sequence_length), opcional) — Máscara para evitar realizar atención en los índices de tokens de relleno. Valores de máscara seleccionados en [0, 1]:
    • 1 para los tokens que no están enmascarados,
    • 0 para los tokens que están enmascarados.

    ¿Qué son las máscaras de atención?

  • logits_to_keep (Union[int, torch.Tensor], opcional, valor predeterminado 0) — Si es un int, calcula los logits para los últimos logits_to_keep tokens. Si es 0, calcula los logits para todos los input_ids (caso especial). Solo se necesitan los logits del último token para la generación, y calcularlos solo para ese token puede ahorrar memoria, lo cual se vuelve bastante significativo para secuencias largas o un tamaño de vocabulario grande. Si es un torch.Tensor, debe ser de 1D y corresponder a los índices a conservar en la dimensión de longitud de secuencia. Esto es útil al usar el formato de tensor empaquetado (una sola dimensión para el lote y la longitud de secuencia).

Devuelve

Mamba2CausalLMOutput o tuple(torch.Tensor)

Un Mamba2CausalLMOutput o una tupla de torch.Tensor (si se pasa return_dict=False o cuando config.return_dict=False) que comprende varios elementos según la configuración (Mamba2Config) y las entradas.

El método forward de Mamba2ForCausalLM sobrescribe el método especial __call__.

Aunque la receta para la pasada hacia adelante debe definirse dentro de esta función, se debe llamar a la instancia de Module después en lugar de a esta, ya que la primera se encarga de ejecutar los pasos de pre y postprocesamiento, mientras que la segunda los ignora silenciosamente.

  • loss (torch.Tensor de forma (1,), opcional, se devuelve cuando se proporciona labels) — Pérdida de modelado de lenguaje (para la predicción del siguiente token).

  • logits (torch.Tensor de forma (batch_size, sequence_length, config.vocab_size)) — Puntuaciones de predicción de la cabeza de modelado de lenguaje (puntuaciones para cada token del vocabulario antes de SoftMax).

  • cache_params (~cache_utils.Cache, opcional) — El estado del modelo en el último paso de tiempo. Puede usarse en un método forward con los siguientes input_ids para evitar proporcionar los input_ids anteriores.

    Incluye tanto las matrices de estado del modelo de espacio de estados después del barrido selectivo como los estados de la convolución

  • hidden_states (tuple[torch.Tensor], opcional, se devuelve cuando se pasa output_hidden_states=True o cuando config.output_hidden_states=True) — Tupla de torch.Tensor (una para la salida de las incrustaciones, si el modelo tiene una capa de incrustaciones, + una para la salida de cada capa) de forma (batch_size, sequence_length, hidden_size).

    Estados ocultos del modelo en la salida de cada capa más las salidas opcionales de la incrustación inicial.

Ejemplo:

Update on GitHub

←Mamba MarianMT→