Transformers documentation
Moshi
Este modelo se publicó en HF papers el 17 de septiembre de 2024 y se contribuyó a Hugging Face Transformers el 16 de octubre de 2024.
Moshi
Resumen
El modelo Moshi fue propuesto en Moshi: a speech-text foundation model for real-time dialogue por Alexandre Défossez, Laurent Mazaré, Manu Orsini, Amélie Royer, Patrick Pérez, Hervé Jégou, Edouard Grave y Neil Zeghidour.
Moshi es un modelo de base de voz y texto que plantea el diálogo hablado como una generación de voz a voz. A partir de un modelo de lenguaje de texto como base, Moshi genera voz como tokens desde el cuantizador residual de un códec de audio neuronal, mientras modela por separado su propia voz y la del usuario en flujos paralelos. Esto permite eliminar los turnos de hablante explícitos y modelar dinámicas conversacionales arbitrarias. Moshi también predice tokens de texto alineados en el tiempo como prefijo a los tokens de audio. Este método de “Inner Monologue” mejora significativamente la calidad lingüística de la voz generada y proporciona reconocimiento de voz en streaming y texto a voz. Como resultado, Moshi es el primer modelo de lenguaje grande hablado full-duplex en tiempo real, con una latencia teórica de 160 ms y de 200 ms en la práctica.

El resumen del artículo es el siguiente:
Presentamos Moshi, un modelo de base de voz-texto y un marco de diálogo hablado de dúplex completo. Los sistemas actuales para el diálogo hablado se basan en pipelines de componentes independientes, a saber: detección de actividad de voz, reconocimiento de voz, diálogo textual y síntesis de voz a partir de texto. Dichos marcos no pueden emular la experiencia de una conversación real. En primer lugar, su complejidad induce una latencia de varios segundos entre interacciones. En segundo lugar, dado que el texto es la modalidad intermedia para el diálogo, la información no lingüística que modifica el significado, como la emoción o los sonidos no vocales, se pierde en la interacción. Por último, se basan en una segmentación en turnos de hablante, que no tiene en cuenta la voz superpuesta, las interrupciones y las interjecciones. Moshi resuelve estos problemas independientes de forma conjunta al plantear el diálogo hablado como una generación de voz a voz. Partiendo de un modelo de lenguaje de texto como base, Moshi genera voz como tokens desde el cuantizador residual de un códec de audio neuronal, mientras modela por separado su propia voz y la del usuario en flujos paralelos. Esto permite eliminar los turnos de hablante explícitos y modelar dinámicas conversacionales arbitrarias. Además, extendemos la generación jerárquica de tokens semánticos a acústicos del trabajo anterior para predecir primero tokens de texto alineados en el tiempo como prefijo a los tokens de audio. No solo este método de “Inner Monologue” mejora significativamente la calidad lingüística de la voz generada, sino que también ilustramos cómo puede proporcionar reconocimiento de voz en streaming y síntesis de voz a partir de texto. Nuestro modelo resultante es el primer modelo de lenguaje grande hablado de dúplex completo en tiempo real, con una latencia teórica de 160 ms, 200 ms en la práctica, y está disponible en github.com/kyutai-labs/moshi.
Moshi gestiona 3 flujos de información:
- El audio del usuario
- El audio de Moshi
- Salida de texto de Moshi
De manera similar a ~MusicgenModel, el audio se representa mediante libros de códigos de audio, que pueden interpretarse como tokens. La principal diferencia entre los tokens de texto y los libros de códigos de audio es que estos últimos introducen una dimensión adicional de información.
Los tokens de texto suelen tener dimensión (batch_size, sequence_length), pero los tokens de audio tienen dimensión (batch_size, num_codebooks, sequence_length).
Moshi está compuesto por 3 componentes:
1. El decodificador principal (Helium en el artículo)
Corresponde a MoshiForCausalLM. Es estrictamente un LLM de texto clásico, que utiliza una arquitectura similar a la de ~GemmaForCausalLM. En otras palabras, toma tokens de texto, los incrusta, los pasa a través del decodificador y una cabeza de lenguaje, para obtener logits de texto.
2. El decodificador de profundidad
Por sí solo, también es un LLM clásico, pero esta vez, en lugar de generar a lo largo de la dimensión temporal, genera a lo largo de la dimensión del codebook.
También significa que su longitud de contexto es num_codebooks, por lo que no puede generar más de num_codebooks.
Tenga en cuenta que cada marca de tiempo, es decir, cada libro de códigos, obtiene su propio conjunto de Capas Lineales y Embeddings.
3. MimiModel
Es el codificador de audio de Kyutai, que se ha integrado recientemente en transformers y se utiliza para “tokenizar” el audio. Tiene el mismo uso que ~EncodecModel en ~MusicgenModel.
Consejos
Los puntos de control originales se pueden convertir usando el script de conversión src/transformers/models/moshi/convert_moshi_transformers.py
Cómo usar el modelo
Esta implementación tiene dos objetivos principales:
- probar rápidamente la generación del modelo simplificando la API original
- simplificar el entrenamiento. Próximamente se publicará una guía de entrenamiento, ¡pero se aceptan contribuciones de los usuarios!
Está diseñado para un uso intermedio. Recomendamos encarecidamente utilizar la implementación original para inferir el modelo en streaming en tiempo real.
1. Generación del modelo
Moshi es un modelo auto-regresivo de streaming con dos flujos de audio. Dicho de otra manera, un flujo de audio corresponde a lo que el modelo dijo/dirá y el otro flujo de audio corresponde a lo que el usuario dijo/dirá.
MoshiForConditionalGeneration.generate() necesita, por lo tanto, 3 entradas:
input_ids- correspondiente al historial de tokens del textomoshi_input_valuesomoshi_audio_codes, correspondientes al historial de audio del modelouser_input_valuesouser_audio_codes- correspondientes al historial de audio del usuario
Estas tres entradas deben estar sincronizadas. Es decir, sus longitudes deben corresponder al mismo número de tokens.
Puedes usar dinámicamente las 3 entradas según lo que quieras probar:
- Simplemente compruebe la respuesta del modelo a un prompt de usuario: en ese caso,
input_idspuede rellenarse con tokens de relleno yuser_input_valuespuede ser un tensor de ceros con la misma forma que el prompt de usuario. - Pruebe un comportamiento más complejo: en ese caso, debe tener cuidado con cómo se sincronizan los tokens de entrada con los audios.
El modelo original sincroniza el texto con el audio mediante el relleno del texto entre cada enunciación de token.
Para seguir el ejemplo de la siguiente imagen,
"Hello, I'm Moshi"podría transformarse en"Hello,<pad><unk>I'm Moshi".

MoshiForConditionalGeneration.generate() luego alimenta de forma autoregresiva su propio flujo de audio, pero como no tiene acceso al flujo de entrada del usuario al usar transformers, asumirá que el usuario está produciendo audio en blanco.
import math
import torch
from datasets import Audio, load_dataset
from transformers import AutoFeatureExtractor, AutoTokenizer
librispeech_dummy = load_dataset("hf-internal-testing/librispeech_asr_dummy", "clean", split="validation")
feature_extractor = AutoFeatureExtractor.from_pretrained("kyutai/moshiko-pytorch-bf16")
tokenizer = AutoTokenizer.from_pretrained("kyutai/moshiko-pytorch-bf16")
dtype = torch.bfloat16
# prepare user input audio
librispeech_dummy = librispeech_dummy.cast_column("audio", Audio(sampling_rate=feature_extractor.sampling_rate))
audio_sample = librispeech_dummy[-1]["audio"]["array"]
user_input_values = feature_extractor(raw_audio=audio_sample, sampling_rate=feature_extractor.sampling_rate, return_tensors="pt").to(device=device, dtype=dtype)
# prepare moshi input values - we suppose moshi didn't say anything while the user spoke
moshi_input_values = torch.zeros_like(user_input_values.input_values)
# prepare moshi input ids - we suppose moshi didn't say anything while the user spoke
num_tokens = math.ceil(moshi_input_values.shape[-1] * waveform_to_token_ratio)
input_ids = torch.ones((1, num_tokens), device=device, dtype=torch.int64) * tokenizer.encode("<pad>")[0]
# generate 25 new tokens (around 2s of audio)
output = model.generate(input_ids=input_ids, user_input_values=user_input_values.input_values, moshi_input_values=moshi_input_values, max_new_tokens=25)
text_tokens = output.sequences
audio_waveforms = output.audio_sequences2. Entrenamiento del modelo
La mayor parte del trabajo debe realizarse durante la creación/preprocesamiento de los datos, debido a la necesidad de alinear/sincronizar los flujos.
Una vez que esté listo, simplemente puede pasar text_labels y audio_labels a MoshiForConditionalGeneration.forward(), junto con las entradas habituales, para obtener la pérdida del modelo.
Pronto se publicará una guía de entrenamiento, ¡pero se aceptan contribuciones de los usuarios!
Cómo el modelo procesa las entradas / genera
Los flujos de entrada se incrustan y combinan en
inputs_embeds.inputs_embedsse pasa a través del decodificador principal, que lo procesa como lo haría un LLM normal.El decodificador principal genera
text logits, pero también sulast hidden state, que en el artículo se denominatemporal context.El decodificador de profundidad cambia la dimensión sobre la que se realiza la propagación / generación (codebooks en lugar de tiempo). Utiliza el token generado a partir de
text logitsy eltemporal contextpara generar codebooks de audio de forma auto-regresiva.
Este modelo fue aportado por Yoach Lacombe (ylacombe).
El código original se puede encontrar aquí.
MoshiConfig
clase transformers.MoshiConfig
< source >( 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 = 32000hidden_size: int = 4096num_hidden_layers: int = 32num_attention_heads: int = 32num_key_value_heads: int | None = Noneaudio_vocab_size: int | None = Nonemax_position_embeddings: int = 3000rope_parameters: transformers.modeling_rope_utils.RopeParameters | dict | None = Nonehidden_act: str = 'silu'head_dim: int | None = Noneinitializer_range: float = 0.02use_cache: bool = Truesliding_window: int = 3000attention_dropout: float | int = 0.0ffn_dim: int = 22528rms_norm_eps: float = 1e-08num_codebooks: int = 8tie_word_embeddings: bool = Falsepad_token_id: int | None = Nonebos_token_id: int | None = Noneeos_token_id: int | list[int] | None = Noneaudio_encoder_config: dict | transformers.configuration_utils.PreTrainedConfig | None = Nonedepth_decoder_config: dict | transformers.configuration_utils.PreTrainedConfig | None = None )
Parámetros
- vocab_size (
int, opcional, valor predeterminado32000) — Tamaño del vocabulario del modelo. Define el número de tokens diferentes que pueden representarse medianteinput_ids. - hidden_size (
int, opcional, valor predeterminado4096) — Dimensión de las representaciones ocultas. - num_hidden_layers (
int, opcional, valor predeterminado32) — Número de capas ocultas en el decodificador del Transformer. - num_attention_heads (
int, opcional, valor predeterminado32) — Número de cabezas de atención para cada capa de atención en el decodificador Transformer. - num_key_value_heads (
int, opcional) — Este es el número de cabezas de key_value que se deben utilizar para implementar Grouped Query Attention. Sinum_key_value_heads=num_attention_heads, el modelo utilizará Multi Head Attention (MHA); sinum_key_value_heads=1, el modelo utilizará Multi Query Attention (MQA); en caso contrario, se utilizará GQA. Al convertir un checkpoint multi-head en un checkpoint GQA, cada cabeza de key y value del grupo debe construirse mediante el promedio (meanpooling) de todas las cabezas originales dentro de ese grupo. Para más detalles, consulta este artículo. Si no se especifica, el valor predeterminado seránum_attention_heads. - audio_vocab_size (
int, opcional) — Tamaño del vocabulario de la parte de audio del modelo. Define el número de tokens diferentes que pueden representarse mediante losaudio_codespasados al llamar a los modelos Moshi. - max_position_embeddings (
int, opcional, valor predeterminado3000) — La longitud máxima de secuencia con la que podría usarse este modelo. - rope_parameters (
Union[~modeling_rope_utils.RopeParameters, dict], opcional) — Diccionario que contiene los parámetros de configuración para las incrustaciones RoPE. El diccionario debe contener un valor pararope_thetay, opcionalmente, parámetros utilizados para el escalado en caso de que desee usar RoPE conmax_position_embeddingsmás largos. - hidden_act (
str, opcional, valor predeterminadosilu) — La función de activación no lineal (función o cadena) en el decodificador. Por ejemplo,"gelu","relu","silu", etc. - head_dim (
int, opcional) — La dimensión de la cabeza de atención. Si es None, se establecerá en hidden_size // num_attention_heads - initializer_range (
float, opcional, valor predeterminado0.02) — La desviación estándar del truncated_normal_initializer para inicializar todas las matrices de pesos. - use_cache (
bool, opcional, valor predeterminadoTrue) — Indica si el modelo debe devolver las últimas claves/valores de atención (no utilizado por todos los modelos). Solo es relevante siconfig.is_decoder=Trueo cuando el modelo es un modelo generativo solo de decodificador. - sliding_window (
int, opcional, valor predeterminado3000) — Tamaño de la ventana de atención deslizante. Si esNone, no se aplica ninguna ventana deslizante. - attention_dropout (
Union[float, int], opcional, valor predeterminado0.0) — La proporción de dropout para las probabilidades de atención. - ffn_dim (
int, opcional, valor predeterminado 22528) — Dimensionalidad de la capa “intermedia” (a menudo denominada feed-forward) en el bloque principal del decodificador. Debe ser un número par. - rms_norm_eps (
float, opcional, valor predeterminado1e-08) — La epsilon utilizada por las capas de normalización rms. - num_codebooks (
int, opcional, valor predeterminado8) — El número de libros de códigos paralelos utilizados por el modelo. - tie_word_embeddings (
bool, opcional, valor predeterminadoFalse) — Si se deben vincular las matrices de pesos de embeddings según el mapeotied_weights_keysdel modelo. - pad_token_id (
int, opcional) — Id del token utilizado para el relleno en el vocabulario. - bos_token_id (
int, opcional) — Id del token utilizado para el inicio de la secuencia en el vocabulario. - eos_token_id (
Union[int, list[int]], opcional) — Id del token utilizado para el fin de secuencia en el vocabulario. - audio_encoder_config (
PreTrainedConfig | dict, opcional) — Configuración del codificador de audio. - depth_decoder_config (
PreTrainedConfig | dict, opcional) — Configuración del decodificador de profundidad.
Esta es la clase de configuración para almacenar la configuración de un MoshiModel. Se utiliza para instanciar un modelo Moshi 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 kmhf/hf-moshika
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 (
... MoshiConfig,
... MoshiForConditionalGeneration,
... )
>>> configuration = MoshiConfig()
>>> # Initializing a MoshiForConditionalGeneration (with random weights) from the kmhf/hf-moshika style configuration
>>> model = MoshiForConditionalGeneration(configuration)
>>> # Accessing the model configuration
>>> configuration = model.config
>>> # Saving the model, including its configuration
>>> model.save_pretrained("kmhf/hf-moshika")
>>> # loading model and config from pretrained folder
>>> moshi_config = MoshiConfig.from_pretrained("kmhf/hf-moshika")
>>> model = MoshiForConditionalGeneration.from_pretrained("kmhf/hf-moshika", config=moshi_config)from_audio_encoder_config
< source >( audio_encoder_config: PreTrainedConfig**kwargs ) → MoshiConfig
Devuelve
Una instancia de un objeto de configuración
Instanciar un MoshiConfig (o una clase derivada) a partir de una configuración de codificador de audio.
MoshiDepthConfig
clase transformers.MoshiDepthConfig
< source >( 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 = 32000hidden_size: int = 1024input_size: int = 4096num_hidden_layers: int = 6num_attention_heads: int = 16num_key_value_heads: int | None = Noneaudio_vocab_size: int = 2048max_position_embeddings: int = 9hidden_act: str = 'silu'head_dim: int | None = Noneinitializer_range: float = 0.02use_cache: bool = Truesliding_window: int = 8attention_dropout: float | int = 0.0ffn_dim: int = 5632rms_norm_eps: float = 1e-08num_codebooks: int = 8tie_word_embeddings: bool = Falsepad_token_id: int | None = Nonebos_token_id: int | None = Noneeos_token_id: int | list[int] | None = None )
Parámetros
- vocab_size (
int, opcional, valor predeterminado32000) — Tamaño del vocabulario del modelo. Define el número de tokens diferentes que pueden representarse medianteinput_ids. - hidden_size (
int, opcional, valor predeterminado1024) — Dimensión de las representaciones ocultas. - input_size (
int, opcional, valor predeterminado 4096) — Dimensionalidad de los estados ocultos de entrada. Se utiliza para conectar el decodificador principal con el decodificador de profundidad. - num_hidden_layers (
int, opcional, valor predeterminado6) — Número de capas ocultas en el decodificador Transformer. - num_attention_heads (
int, opcional, valor predeterminado16) — Número de cabezas de atención para cada capa de atención en el decodificador Transformer. - num_key_value_heads (
int, opcional) — Este es el número de cabezas de key_value que se deben utilizar para implementar Grouped Query Attention. Sinum_key_value_heads=num_attention_heads, el modelo utilizará Multi Head Attention (MHA); sinum_key_value_heads=1, el modelo utilizará Multi Query Attention (MQA); en caso contrario, se utilizará GQA. Al convertir un checkpoint multi-head en un checkpoint GQA, cada cabeza de key y value del grupo debe construirse mediante el promedio (meanpooling) de todas las cabezas originales dentro de ese grupo. Para más detalles, consulta este artículo. Si no se especifica, el valor predeterminado seránum_attention_heads. - audio_vocab_size (
int, opcional, valor predeterminado 2048) — Tamaño del vocabulario de la parte de audio del modelo. Define el número de tokens diferentes que pueden representarse mediante losaudio_codespasados al llamar a los modelos Moshi. - max_position_embeddings (
int, opcional, valor predeterminado9) — La longitud máxima de secuencia con la que se podría utilizar este modelo. - hidden_act (
str, opcional, valor predeterminadosilu) — La función de activación no lineal (función o cadena) en el decodificador. Por ejemplo,"gelu","relu","silu", etc. - head_dim (
int, opcional) — La dimensión de la cabeza de atención. Si es None, se establecerá en hidden_size // num_attention_heads - initializer_range (
float, opcional, valor predeterminado0.02) — La desviación estándar del truncated_normal_initializer para inicializar todas las matrices de pesos. - use_cache (
bool, opcional, valor predeterminadoTrue) — Indica si el modelo debe devolver las últimas claves/valores de atención (no utilizado por todos los modelos). Solo es relevante siconfig.is_decoder=Trueo cuando el modelo es un modelo generativo solo de decodificador. - sliding_window (
int, opcional, valor predeterminado8) — Tamaño de la ventana de atención deslizante. Si esNone, no se aplica ninguna ventana deslizante. - attention_dropout (
Union[float, int], opcional, valor predeterminado0.0) — La proporción de dropout para las probabilidades de atención. - ffn_dim (
int, opcional, valor predeterminado 5632) — Dimensionalidad de la capa “intermedia” (a menudo denominada feed-forward) en el bloque del decodificador de profundidad. Debe ser par. - rms_norm_eps (
float, opcional, valor predeterminado1e-08) — La epsilon utilizada por las capas de normalización rms. - num_codebooks (
int, opcional, valor predeterminado8) — El número de libros de códigos paralelos utilizados por el modelo. - tie_word_embeddings (
bool, opcional, valor predeterminadoFalse) — Si se deben vincular las matrices de pesos de embeddings según el mapeotied_weights_keysdel modelo. - pad_token_id (
int, opcional) — Id del token utilizado para el relleno en el vocabulario. - bos_token_id (
int, opcional) — Id del token utilizado para el inicio de la secuencia en el vocabulario. - eos_token_id (
Union[int, list[int]], opcional) — Id del token utilizado para el fin de secuencia en el vocabulario.
Esta es la clase de configuración para almacenar la configuración de un MoshiModel. Se utiliza para instanciar un modelo Moshi 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 kmhf/hf-moshika
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 (
... MoshiDepthConfig,
... MoshiDepthDecoder,
... )
>>> configuration = MoshiDepthConfig()
>>> # Initializing a MoshiDepthDecoder (with random weights) from the kmhf/hf-moshika style configuration
>>> model = MoshiDepthDecoder(configuration)
>>> # Accessing the model configuration
>>> configuration = model.configMoshiModel
clase transformers.MoshiModel
< source >( config: MoshiConfig )
Parámetros
- config (MoshiConfig) — 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 Moshi 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
< source >( input_ids: typing.Optional[torch.LongTensor] = Noneattention_mask: typing.Optional[torch.Tensor] = Noneposition_ids: typing.Optional[torch.LongTensor] = Nonepast_key_values: transformers.cache_utils.Cache | None = Noneinputs_embeds: typing.Optional[torch.Tensor] = Noneuse_cache: bool | None = None**kwargs: *<class 'transformers.utils.generic.TransformersKwargs'> ) → BaseModelOutputWithPast or tuple(torch.Tensor)
Parámetros
- input_ids (
torch.LongTensorde 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.
- attention_mask (
torch.Tensorde 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.
- position_ids (
torch.LongTensorde forma(batch_size, sequence_length), opcional) — Índices de las posiciones de los tokens de cada secuencia de entrada en los embeddings de posición. Seleccionados en el rango[0, config.n_positions - 1]. - past_key_values (
~cache_utils.Cache, opcional) — Estados ocultos precalculados (claves y valores en los bloques de autoatención y en los bloques de atención cruzada) que se pueden usar para acelerar la decodificación secuencial. Esto generalmente consiste en lapast_key_valuesdevuelta por el modelo en una etapa anterior de la decodificación, cuandouse_cache=Trueoconfig.use_cache=True.Solo se permite una instancia de Cache como entrada, consulte nuestra guía de caché kv. Si no se pasan
past_key_values, DynamicCache se inicializará de forma predeterminada.El modelo generará el mismo formato de caché que se proporciona como entrada.
Si se utilizan
past_key_values, se espera que el usuario introduzca únicamente losinput_idsno procesados (aquellos que no tienen sus estados de clave y valor pasados proporcionados a este modelo) con forma(batch_size, unprocessed_length)en lugar de todos losinput_idscon forma(batch_size, sequence_length). - inputs_embeds (
torch.Tensorde forma(batch_size, sequence_length, hidden_size), opcional) — Opcionalmente, en lugar de pasarinput_ids, puedes elegir pasar directamente una representación incrustada. Esto es útil si deseas tener más control sobre cómo convertir los índices deinput_idsen los vectores asociados que en la matriz de búsqueda de incrustaciones interna del modelo. - use_cache (
bool, opcional) — Si se establece enTrue, se devuelven los estados de clave-valor depast_key_valuesy pueden usarse para acelerar la decodificación (verpast_key_values).
Devuelve
BaseModelOutputWithPast o tuple(torch.Tensor)
Un BaseModelOutputWithPast 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 (MoshiConfig) y las entradas.
El método forward de MoshiModel reemplaza 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
Moduledespué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.Tensorde forma(batch_size, sequence_length, hidden_size)) — Secuencia de estados ocultos en la salida de la última capa del modelo.Si se utiliza
past_key_values, solo se genera el último hidden-state de las secuencias con forma(batch_size, 1, hidden_size).past_key_values (
Cache, opcional, se devuelve cuando se pasause_cache=Trueo cuandoconfig.use_cache=True) — Es una instancia de Cache. Para más detalles, consulta nuestra guía de caché kv.Contiene estados ocultos precalculados (claves y valores en los bloques de autoatención y, opcionalmente, si
config.is_encoder_decoder=True, en los bloques de atención cruzada) que pueden utilizarse (véase la entradapast_key_values) para acelerar la decodificación secuencial.hidden_states (
tuple(torch.Tensor), opcional, devuelto cuando se pasaoutput_hidden_states=Trueo cuandoconfig.output_hidden_states=True) — Tupla detorch.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.
attentions (
tuple(torch.Tensor), opcional, se devuelve cuando se pasaoutput_attentions=Trueo cuandoconfig.output_attentions=True) — Tupla detorch.Tensor(una por cada capa) de forma(batch_size, num_heads, sequence_length, sequence_length).Pesos de atención tras el softmax de atención, utilizados para calcular la media ponderada en las cabezas de autoatención.
MoshiForCausalLM
clase transformers.MoshiForCausalLM
< source >( config: MoshiConfig )
Parámetros
- config (MoshiConfig) — 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 decodificador de Moshi con una cabeza de modelado de lenguaje de texto en la parte superior. Solo se puede usar para texto.
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
< source >( input_ids: typing.Optional[torch.LongTensor] = Noneattention_mask: typing.Optional[torch.Tensor] = Noneposition_ids: typing.Optional[torch.LongTensor] = Nonepast_key_values: transformers.cache_utils.Cache | None = Noneinputs_embeds: typing.Optional[torch.Tensor] = Noneuse_cache: bool | None = Nonelabels: typing.Optional[torch.LongTensor] = Nonelogits_to_keep: typing.Union[int, torch.Tensor] = 0**kwargs: *<class 'transformers.utils.generic.TransformersKwargs'> ) → MoshiCausalLMOutputWithPast or tuple(torch.Tensor)
Parámetros
- input_ids (
torch.LongTensorde 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.
- attention_mask (
torch.Tensorde 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.
- position_ids (
torch.LongTensorde forma(batch_size, sequence_length), opcional) — Índices de las posiciones de los tokens de cada secuencia de entrada en los embeddings de posición. Seleccionados en el rango[0, config.n_positions - 1]. - past_key_values (
~cache_utils.Cache, opcional) — Estados ocultos precalculados (claves y valores en los bloques de autoatención y en los bloques de atención cruzada) que se pueden usar para acelerar la decodificación secuencial. Esto generalmente consiste en lapast_key_valuesdevuelta por el modelo en una etapa anterior de la decodificación, cuandouse_cache=Trueoconfig.use_cache=True.Solo se permite una instancia de Cache como entrada, consulte nuestra guía de caché kv. Si no se pasan
past_key_values, DynamicCache se inicializará de forma predeterminada.El modelo generará el mismo formato de caché que se proporciona como entrada.
Si se utilizan
past_key_values, se espera que el usuario introduzca únicamente losinput_idsno procesados (aquellos que no tienen sus estados de clave y valor pasados proporcionados a este modelo) con forma(batch_size, unprocessed_length)en lugar de todos losinput_idscon forma(batch_size, sequence_length). - inputs_embeds (
torch.Tensorde forma(batch_size, sequence_length, hidden_size), opcional) — Opcionalmente, en lugar de pasarinput_ids, puedes elegir pasar directamente una representación incrustada. Esto es útil si deseas tener más control sobre cómo convertir los índices deinput_idsen los vectores asociados que en la matriz de búsqueda de incrustaciones interna del modelo. - use_cache (
bool, opcional) — Si se establece enTrue, se devuelven los estados de clave-valor depast_key_valuesy pueden usarse para acelerar la decodificación (verpast_key_values). - labels (
torch.LongTensorde forma(batch_size, sequence_length), opcional) — Etiquetas para calcular la pérdida de modelado de lenguaje enmascarado. Los índices deben estar en[0, ..., config.vocab_size]o ser -100 (ver la docstring deinput_ids). Los tokens con índices establecidos en-100se ignoran (enmascarados); la pérdida solo se calcula para los tokens con etiquetas en[0, ..., config.vocab_size]. - logits_to_keep (
Union[int, torch.Tensor], opcional, valor predeterminado0) — Si es unint, calcula los logits para los últimoslogits_to_keeptokens. Si es0, calcula los logits para todos losinput_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 untorch.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
MoshiCausalLMOutputWithPast o tuple(torch.Tensor)
Un MoshiCausalLMOutputWithPast 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 (MoshiConfig) y las entradas.
El método forward de MoshiForCausalLM 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
Moduledespué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.Tensorde forma(1,), opcional, se devuelve cuando se proporcionalabels) — Pérdida de modelado de lenguaje (para la predicción del siguiente token).logits (
torch.Tensorde 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).last_hidden_state (
torch.Tensorde forma(batch_size, sequence_length, hidden_size), opcional) — Secuencia de estados ocultos en la salida de la última capa del modelo.past_key_values (
Cache, opcional, se devuelve cuando se pasause_cache=Trueo cuandoconfig.use_cache=True) — Es una instancia de Cache. Para más detalles, consulta nuestra guía de caché kv.Contiene estados ocultos precalculados (claves y valores en los bloques de autoatención) que pueden utilizarse (véase la entrada
past_key_values) para acelerar la decodificación secuencial.hidden_states (
tuple[torch.Tensor, ...], opcional, se devuelve cuando se pasaoutput_hidden_states=Trueo cuandoconfig.output_hidden_states=True) — Tupla detorch.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.
attentions (
tuple[torch.Tensor, ...], opcional, se devuelve cuando se pasaoutput_attentions=Trueo cuandoconfig.output_attentions=True) — Tupla detorch.Tensor(una por cada capa) de forma(batch_size, num_heads, sequence_length, sequence_length).Pesos de atención tras el softmax de atención, utilizados para calcular la media ponderada en las cabezas de autoatención.
Ejemplo:
>>> from transformers import AutoTokenizer, MoshiForCausalLM
>>> model = MoshiForCausalLM.from_pretrained("kmhf/hf-moshika")
>>> tokenizer = AutoTokenizer.from_pretrained("kmhf/hf-moshika")
>>> prompt = "What is your favorite condiment?"
>>> 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]
"What is your favorite condiment?"MoshiForConditionalGeneration
clase transformers.MoshiForConditionalGeneration
< source >( config: MoshiConfig )
Parámetros
- config (MoshiConfig) — 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 Moshi original con un codificador de audio, un decodificador de profundidad Moshi y un decodificador Moshi, para la conversión de voz a voz.
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
< source >( input_ids: typing.Optional[torch.LongTensor] = Noneattention_mask: typing.Optional[torch.BoolTensor] = Noneuser_input_values: typing.Optional[torch.Tensor] = Noneuser_audio_codes: typing.Optional[torch.Tensor] = Nonemoshi_input_values: typing.Optional[torch.Tensor] = Nonemoshi_audio_codes: typing.Optional[torch.Tensor] = Nonepast_key_values: transformers.cache_utils.Cache | None = Noneinputs_embeds: typing.Optional[torch.Tensor] = Nonetext_labels: typing.Optional[torch.LongTensor] = Noneaudio_labels: typing.Optional[torch.LongTensor] = Noneuse_cache: bool | None = None**kwargs ) → MoshiConditionalGenerationOutputWithPast or tuple(torch.Tensor)
Parámetros
- input_ids (
torch.LongTensorde 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.
- attention_mask (
torch.BoolTensorde 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.
- user_input_values (
torch.Tensorde forma `(batch_size, 1, audio_sequence_length), opcional) — Las formas de onda de audio utilizadas como prompt de audio del usuario para la generación. - user_audio_codes (
torch.Tensorof shape(batch_size, num_codebooks, sequence_length), *optional*) -- The audio codes used as audio user prompt for the generation. Has priority overuser_input_valuesand represents the audio "tokens" ofuser_input_values` once passed through the audio encoder. - moshi_input_values (
torch.Tensorde forma `(batch_size, 1, audio_sequence_length), opcional) — Las formas de onda de audio utilizadas como prompt de audio Moshi para la generación. - moshi_audio_codes (
torch.Tensorof shape(batch_size, num_codebooks, sequence_length), *optional*) -- The audio codes used as audio Moshi prompt for the generation. Has priority overmoshi_input_valuesand represents the audio "tokens" ofmoshi_input_values` once passed through the audio encoder. - past_key_values (
~cache_utils.Cache, opcional) — Estados ocultos precalculados (claves y valores en los bloques de autoatención y en los bloques de atención cruzada) que se pueden usar para acelerar la decodificación secuencial. Esto generalmente consiste en lapast_key_valuesdevuelta por el modelo en una etapa anterior de la decodificación, cuandouse_cache=Trueoconfig.use_cache=True.Solo se permite una instancia de Cache como entrada, consulte nuestra guía de caché kv. Si no se pasan
past_key_values, DynamicCache se inicializará de forma predeterminada.El modelo generará el mismo formato de caché que se proporciona como entrada.
Si se utilizan
past_key_values, se espera que el usuario introduzca únicamente losinput_idsno procesados (aquellos que no tienen sus estados de clave y valor pasados proporcionados a este modelo) con forma(batch_size, unprocessed_length)en lugar de todos losinput_idscon forma(batch_size, sequence_length). - inputs_embeds (
torch.Tensorde forma(batch_size, sequence_length, hidden_size), opcional) — Opcionalmente, en lugar de pasarinput_idspuede elegir pasar directamente una representación incrustada. Sipast_key_valuesse usa, opcionalmente solo la últimainputs_embedsdebe ser entrada (verpast_key_values). Esto es útil si desea tener más control sobre cómo convertirinput_idsíndices en vectores asociados que la matriz de búsqueda de incrustaciones interna del modelo.Si
input_idsyinputs_embedsno están configurados,inputs_embedstoma el valor deinputs_embeds. - text_labels (
torch.LongTensorde forma(batch_size, sequence_length), opcional) — Etiquetas para el modelado de lenguaje de texto. Tenga en cuenta que las etiquetas se desplazan dentro del modelo, es decir, puede establecerlabels = input_idsLos índices se seleccionan en[-100, 0, ..., config.vocab_size]Todas las etiquetas establecidas en-100se ignoran (se enmascaran), la pérdida solo se calcula para las etiquetas en[0, ..., config.vocab_size] - audio_labels (
torch.LongTensorde forma(batch_size, num_codebooks, sequence_length), opcional) — Etiquetas para el modelado de lenguaje. Tenga en cuenta que las etiquetas se desplazan dentro del modelo, es decir, puede establecerlabels = input_idsLos índices se seleccionan en[-100, 0, ..., config.vocab_size]Todas las etiquetas establecidas en-100se ignoran (se enmascaran), la pérdida solo se calcula para las etiquetas en[0, ..., config.audio_vocab_size] - use_cache (
bool, opcional) — Si se establece enTrue, se devuelven los estados de clave-valor depast_key_valuesy pueden usarse para acelerar la decodificación (verpast_key_values).
Devuelve
MoshiConditionalGenerationOutputWithPast o tuple(torch.Tensor)
Un MoshiConditionalGenerationOutputWithPast 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 (MoshiConfig) y las entradas.
El método forward de MoshiForConditionalGeneration 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
Moduledespué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.Tensorde forma(1,), opcional, se devuelve cuando se proporcionatext_labels) — Pérdida de modelado de lenguaje de texto (para la predicción del siguiente token).logits (
torch.Tensorde forma(batch_size, sequence_length, config.vocab_size)) — Puntuaciones de predicción de la cabeza de modelado de lenguaje de texto (puntuaciones para cada token del vocabulario antes de SoftMax).last_hidden_state (
torch.Tensorde forma(batch_size, sequence_length, hidden_size), opcional) — Secuencia de estados ocultos en la salida de la última capa del modelo.past_key_values (
Cache, opcional, se devuelve cuando se pasause_cache=Trueo cuandoconfig.use_cache=True) — Es una instancia de Cache. Para más detalles, consulta nuestra guía de caché kv.Contiene estados ocultos precalculados (claves y valores en los bloques de autoatención) que pueden utilizarse (véase la entrada
past_key_values) para acelerar la decodificación secuencial.hidden_states (
tuple[torch.Tensor, ...], opcional, se devuelve cuando se pasaoutput_hidden_states=Trueo cuandoconfig.output_hidden_states=True) — Tupla detorch.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.
attentions (
tuple[torch.Tensor, ...], opcional, se devuelve cuando se pasaoutput_attentions=Trueo cuandoconfig.output_attentions=True) — Tupla detorch.Tensor(una por cada capa) de forma(batch_size, num_heads, sequence_length, sequence_length).Pesos de atención tras el softmax de atención, utilizados para calcular la media ponderada en las cabezas de autoatención.
depth_loss (
torch.Tensorde forma(1,), opcional, devuelto cuando se proporcionaaudio_labels) — Pérdida de modelado de lenguaje de audio (para la predicción del siguiente token).audio_logits (
torch.Tensorde forma(batch_size, sequence_length, config.vocab_size)) — Puntuaciones de predicción de las cabezas de modelado de lenguaje de audio.depth_past_key_values (
Cache, opcional, se devuelve cuando se pasause_cache=Trueo cuandoconfig.use_cache=True) — Valores clave pasados del decodificador de profundidad.depth_hidden_states (
tuple(torch.Tensor), opcional, se devuelve cuando se pasaoutput_hidden_states=Trueo cuandoconfig.output_hidden_states=True) — Estados ocultos del decodificador de profundidaddepth_attentions (
tuple(torch.Tensor), opcional, se devuelve cuando se pasaoutput_attentions=Trueo cuandoconfig.output_attentions=True) — Pesos de las Atenciones del decodificador de profundidad después del softmax de atención, utilizados para calcular la media ponderada en las cabezas de autoatención.
Ejemplos:
>>> from transformers import MoshiForConditionalGeneration
>>> import torch
>>> model = MoshiForConditionalGeneration.from_pretrained("kmhf/hf-moshika")
>>> inputs = moshi.get_unconditional_inputs()
>>> logits = model(**inputs, ).logits
>>> logits.shape # (bsz, seq_len, text_vocab_size)
torch.Size([1, 1, 32000])generate
< source >( input_ids: typing.Optional[torch.LongTensor] = Noneuser_input_values: typing.Optional[torch.Tensor] = Noneuser_audio_codes: typing.Optional[torch.Tensor] = Nonemoshi_input_values: typing.Optional[torch.Tensor] = Nonemoshi_audio_codes: typing.Optional[torch.Tensor] = Noneinputs_embeds: typing.Optional[torch.Tensor] = Nonereturn_audio_waveforms: bool | None = Truereturn_audio_codes: bool | None = Noneconcat_unconditional_inputs: bool | None = True**kwargs )
Parámetros
- input_ids (
torch.Tensorde forma `(batch_size, sequence_length), opcional) — La secuencia utilizada como texto de indicación para la generación. - user_input_values (
torch.Tensorde forma `(batch_size, 1, audio_sequence_length), opcional) — Las formas de onda de audio utilizadas como prompt de audio del usuario para la generación. - user_audio_codes (
torch.Tensorof shape(batch_size, num_codebooks, sequence_length), *optional*) -- The audio codes used as audio user prompt for the generation. Has priority overuser_input_valuesand represents the audio "tokens" ofuser_input_values` once passed through the audio encoder. - moshi_input_values (
torch.Tensorde forma `(batch_size, 1, audio_sequence_length), opcional) — Las formas de onda de audio utilizadas como prompt de audio Moshi para la generación. - moshi_audio_codes (
torch.Tensorof shape(batch_size, num_codebooks, sequence_length), *optional*) -- The audio codes used as audio Moshi prompt for the generation. Has priority overmoshi_input_valuesand represents the audio "tokens" ofmoshi_input_values` once passed through the audio encoder. - inputs_embeds (
torch.Tensorde forma(batch_size, sequence_length, hidden_size), opcional) — Opcionalmente, en lugar de pasarinput_idsy las entradas de audio, puedes elegir pasar directamente una representación incrustada. Esto es útil si deseas tener más control sobre cómo convertir las entradas en los vectores asociados que en la matriz de búsqueda de incrustaciones interna del modelo. - return_audio_waveforms (
bool, opcional, valor predeterminadoTrue) — Si esFalse, no se generarán las formas de onda de audio. - return_audio_codes (
bool, opcional) — Si esTrue, también devuelve los códigos de audio generados, es decir, los “tokens” de audio intermedios que se transforman enaudio_sequencesuna vez que pasan por el decodificador de audio. - concat_unconditional_inputs (
bool, opcional, valor predeterminadoTrue) — Si esFalse, no se concatenarán los tokens iniciales de audio y texto. - kwargs (
dict[str, Any], opcional) — Diccionario restante de argumentos por palabra clave que se pasan al métodogenerate. Consulte losgeneratedocstrings originales para obtener más información sobre cómo usarlos. Tenga en cuenta que las palabras clave con el prefijo depth_ se usarán como entrada para el métodogeneratedel decodificador de profundidad. De lo contrario, este último utilizará su configuración de generación predeterminada.
Genera secuencias de ids de tokens de texto y ids de tokens de audio.
get_unconditional_inputs
< source >( num_samples = 1 )
Parámetros
- num_samples (int, opcional) — Número de muestras de audio que se generarán de forma incondicional.
- max_new_tokens (int, opcional) — Número de tokens que se generarán para cada muestra. Más tokens significa muestras de audio más largas, a costa de una inferencia más larga (ya que se deben generar más tokens de audio por muestra).
Función auxiliar para obtener entradas nulas para la generación incondicional, lo que permite usar el modelo sin el extractor de características ni el tokenizador.
Ejemplo:
>>> from transformers import MoshiForConditionalGeneration
>>> model = MoshiForConditionalGeneration.from_pretrained("kmhf/hf-moshika")
>>> # get the unconditional (or 'null') inputs for the model
>>> unconditional_inputs = model.get_unconditional_inputs(num_samples=1)
>>> audio_samples = model.generate(**unconditional_inputs, max_new_tokens=256)