Hugging Face's logo

Transformers documentation

Mamba

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 2023-12-01 y se contribuyó a Hugging Face Transformers el 2024-03-05.

Mamba

Mamba es un modelo de espacio de estados estructurado selectivo (SSMs) diseñado para sortear la ineficiencia computacional de Transformers al manejar secuencias largas. Es una arquitectura completamente libre de atención, compuesta por una combinación de bloques H3 y MLP con puerta (bloque Mamba). El “razonamiento basado en contenido” de Mamba le permite centrarse en partes específicas de una entrada según el token actual. Mamba también utiliza un nuevo algoritmo paralelo consciente del hardware para compensar la falta de operaciones convolucionales. Como resultado, Mamba tiene una inferencia rápida y puede escalar a secuencias muy largas.

Puedes encontrar todos los puntos de control originales de Mamba bajo la organización State Space Models.

Este modelo fue aportado por Molbap y AntonV. 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="state-spaces/mamba-130m-hf",
    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 torchao.quantization import Int4WeightOnlyConfig

from transformers import AutoModelForCausalLM, AutoTokenizer, TorchAoConfig


quantization_config = Int4WeightOnlyConfig(group_size=128)
quantization_config = TorchAoConfig(quant_type=quant_config)
tokenizer = AutoTokenizer.from_pretrained("state-spaces/mamba-2.8b-hf")
model = AutoModelForCausalLM.from_pretrained("state-spaces/mamba-2.8b-hf", 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

  • La implementación actual utiliza los kernels de CUDA originales. La implementación equivalente de FlashAttention se aloja en los repositorios mamba-ssm y causal_conv1d. ¡Asegúrate de instalarlos si tu hardware lo soporta!

  • Las pilas de Mamba apilan capas mixer que son equivalentes a capas Attention. Puedes encontrar la lógica principal de Mamba en la clase MambaMixer.

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

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

model_id = "state-spaces/mamba-130m-hf"
dataset = load_dataset("Abirate/english_quotes", split="train")
training_args = SFTConfig(dataset_text_field="quote")
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()

  • Use padding izquierdo para la generación por lotes. Consulte Lado de relleno.

MambaConfig

clase transformers.MambaConfig

< >

( 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 = Nonevocab_size: int = 50280hidden_size: int = 768state_size: int = 16num_hidden_layers: int = 32layer_norm_epsilon: float = 1e-05pad_token_id: int | None = 0bos_token_id: int | None = 0eos_token_id: int | list[int] | None = 0expand: int = 2conv_kernel: int = 4use_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_scale: float = 1.0time_step_min: float = 0.001time_step_max: float = 0.1time_step_init_scheme: str = 'random'time_step_floor: float = 0.0001rescale_prenorm_residual: bool = Falseuse_cache: bool = Trueuse_mambapy: bool = Falseuse_associative_scan: bool = Truetie_word_embeddings: bool = True )

Parámetros

  • vocab_size (int, opcional, valor predeterminado 50280) — 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 768) — Dimensión de las representaciones ocultas.
  • state_size (int, opcional, valor predeterminado 16) — Tamaño del estado del SSM (dimensión del estado latente) en las capas Mamba.
  • num_hidden_layers (int, opcional, valor predeterminado 32) — 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 0) — 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 0) — 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.
  • 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_scale (float, opcional, valor predeterminado 1.0) — Escala aplicada al delta del paso de tiempo antes de la discretización.
  • 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_init_scheme (str, opcional, valor predeterminado random) — Esquema de inicialización para el delta del paso de tiempo. Puede ser "random" o "uniform".
  • 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.
  • 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.
  • use_mambapy (bool, opcional, valor predeterminado False) — Determina la estrategia de respaldo durante el entrenamiento si la implementación oficial de Mamba basada en CUDA no está disponible. Si True, se utiliza la implementación mamba.py. Si False, se utiliza la implementación ingenua y más lenta. Considere cambiar a la versión ingenua si la memoria es limitada.
  • use_associative_scan (bool, opcional, valor predeterminado True) — Indica si se debe utilizar torch._higher_order_ops.associative_scan de PyTorch para el escaneo paralelo en lugar de la implementación secuencial simple. El escaneo asociativo solo está activo durante el trazado de torch.compile y requiere torch >= 2.9.0. Ambas rutas se prueban para producir resultados numéricamente idénticos (ver test_associative_scan_matches_sequential). Establezca False para volver al bucle secuencial.
  • tie_word_embeddings (bool, opcional, valor predeterminado True) — 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 MambaModel. Se utiliza para instanciar un modelo Mamba 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/mamba-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 MambaConfig, MambaModel

>>> # Initializing a Mamba configuration
>>> configuration = MambaConfig()

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

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

MambaModel

clase transformers.MambaModel

< >

( config: MambaConfig )

Parámetros

  • config (MambaConfig) — 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 Mamba 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.LongTensor] = None**kwargs ) → MambaOutput 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.LongTensor 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

MambaOutput o tuple(torch.Tensor)

Un MambaOutput 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 (MambaConfig) y las entradas.

El método forward de MambaModel 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.

MambaLMHeadModel

clase transformers.MambaForCausalLM

< >

( config: MambaConfig )

Parámetros

  • config (MambaConfig) — 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 MAMBA con una cabeza de modelado de lenguaje en la parte superior (capa lineal con pesos 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] = Noneattention_mask: 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 = Nonelogits_to_keep: typing.Union[int, torch.Tensor] = 0**kwargs ) → MambaCausalLMOutput 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?

  • attention_mask (torch.LongTensor 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?

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

MambaCausalLMOutput o tuple(torch.Tensor)

Un MambaCausalLMOutput 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 (MambaConfig) y las entradas.

El método forward de MambaForCausalLM 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

←MADLAD-400 Mamba2→