# Moshi

## 개요

Moshi 모델은 Alexandre Défossez, Laurent Mazaré, Manu Orsini, Amélie Royer, Patrick Pérez, Hervé Jégou, Edouard Grave, Neil Zeghidour가 [Moshi: a speech-text foundation model for real-time dialogue](https://huggingface.co/papers/2410.00037)에서 제안했습니다.

Moshi는 구어 대화를 음성-음성 생성으로 정의하는 음성-텍스트 파운데이션 모델입니다. 텍스트 언어 모델 백본을 기반으로, Moshi는 신경 오디오 코덱의 잔차 퀀타이저(residual quantizer)에서 토큰으로 음성을 생성하는 동시에, 자신의 음성과 사용자의 음성을 병렬 스트림으로 독립적으로 모델링합니다. 이를 통해 명시적인 화자 턴(speaker turn)을 제거하고, 임의의 대화 동역학을 모델링할 수 있습니다. Moshi는 오디오 토큰의 접두사로 시간 정렬된 텍스트 토큰도 예측합니다. 이러한 “Inner Monologue” 방식은 생성된 음성의 언어적 품질을 크게 향상시키고, 스트리밍 음성 인식 및 텍스트-음성 합성을 제공합니다. 그 결과, Moshi는 이론적 지연 시간 160ms, 실제 200ms의 실시간 풀 듀플렉스 구어 대규모 언어 모델이 되었습니다.

해당 논문의 초록은 다음과 같습니다:

*Moshi라는 음성-텍스트 파운데이션 모델과 풀 듀플렉스 음성 대화 프레임워크를 소개합니다. 현재 음성 대화 시스템은 음성 활동 감지, 음성 인식, 텍스트 대화, 텍스트-음성 합성이라는 독립적인 구성 요소의 파이프라인에 의존합니다. 이러한 프레임워크는 실제 대화의 경험을 재현할 수 없습니다. 첫째, 이러한 복잡성으로 인해 상호작용 사이에 수 초의 지연이 발생합니다. 둘째, 텍스트가 대화의 중간 매개체이므로 의미를 수정하는 비언어적 정보(감정이나 비음성 소리 등)가 상호작용 과정에서 손실됩니다. 마지막으로, 이러한 시스템은 화자 턴 분할에 의존하는데, 이는 겹치는 음성, 끊어 말하기, 끼어들기를 고려하지 않습니다. Moshi는 음성 대화를 음성-음성 생성 문제로 재정의함으로써 이러한 독립적인 문제들을 모두 해결합니다. 텍스트 언어 모델 백본을 기반으로 Moshi는 신경 오디오 코덱의 잔차 퀀타이저에서 토큰으로 음성을 생성하는 동시에, 자신의 음성과 사용자의 음성을 병렬 스트림으로 별도로 모델링합니다. 이를 통해 명시적인 화자 턴을 제거하고 임의의 대화 동역학을 모델링할 수 있습니다. 또한 이전 연구의 위계적 의미-음향 토큰 생성을 확장하여, 오디오 토큰의 접두사로 시간 정렬된 텍스트 토큰을 먼저 예측하도록 했습니다. 이 'Inner Monologue' 방법은 생성된 음성의 언어적 품질을 크게 향상시킬 뿐만 아니라, 스트리밍 음성 인식과 텍스트-음성 합성을 제공할 수 있음을 보여줍니다. 그 결과로 나온 모델은 이론적 지연 160ms, 실제 지연 200ms를 가진 최초의 실시간 풀 듀플렉스 음성 대규모 언어 모델이며, github.com/kyutai-labs/moshi에서 사용할 수 있습니다.*

Moshi는 3개의 정보 스트림을 다룹니다:

1. 사용자의 오디오
2. Moshi의 오디오
3. Moshi의 텍스트 출력

[~MusicgenModel](/docs/transformers/main/ko/model_doc/musicgen#transformers.MusicgenModel)와 마찬가지로, 오디오는 오디오 코드북으로 표현되며 이는 토큰처럼 해석할 수 있습니다. 텍스트 토큰과 오디오 코드북의 주요 차이점은 오디오 코드북이 정보의 추가 차원을 도입한다는 것입니다. 텍스트 토큰은 일반적으로 `(batch_size, sequence_length)` 차원을 가지지만, 오디오 토큰은 `(batch_size, num_codebooks, sequence_length)` 차원을 가집니다.

Moshi는 3개의 구성 요소로 이루어져 있습니다:

**1. 메인 디코더(논문에서는 Helium)**

이것은 [MoshiForCausalLM](/docs/transformers/main/ko/model_doc/moshi#transformers.MoshiForCausalLM)에 해당합니다. [~GemmaForCausalLM](/docs/transformers/main/ko/model_doc/gemma#transformers.GemmaForCausalLM)과 유사한 아키텍처를 사용하는 순수한 텍스트 LLM입니다. 즉, 텍스트 토큰을 입력받아 임베딩을 수행한 후, 디코더와 언어 헤드를 거쳐 텍스트 로짓을 산출합니다.

**2. 깊이 디코더**

그 자체로도 고전적인 LLM이지만, 이번에는 시간 차원이 아닌 코드북 차원 위에서 생성합니다.

즉, 컨텍스트 길이가 `num_codebooks`이므로 `num_codebooks`보다 많은 토큰을 생성할 수 없습니다.

각 타임스탬프, 즉 각 코드북은 자체적인 Linear 레이어와 임베딩 세트를 가집니다.

**3. [MimiModel](/docs/transformers/main/ko/model_doc/mimi#transformers.MimiModel)**

Kyutai의 오디오 인코더로, 최근 transformers에 통합되어 오디오를 "토큰화"하는 데 사용됩니다. 이는 [~EncodecModel](/docs/transformers/main/ko/model_doc/encodec#transformers.EncodecModel)이 [~MusicgenModel](/docs/transformers/main/ko/model_doc/musicgen#transformers.MusicgenModel)에서 수행하는 역할과 동일합니다.

## 팁

원본 체크포인트는 변환 스크립트 `src/transformers/models/moshi/convert_moshi_transformers.py`를 사용하여 변환할 수 있습니다.

### 모델 사용 방법

이 구현에는 두 가지 주요 목적이 있습니다:

1. 기존 API를 단순화하여 모델 생성을 빠르게 테스트
2. 트레이닝을 단순화합니다. 트레이닝 가이드는 곧 제공될 예정이며, 사용자 기여를 환영합니다!

중급 수준의 사용에 적합하도록 설계되었습니다. 실시간 스트리밍으로 모델을 추론하려면 원래 [구현](https://github.com/kyutai-labs/moshi)을 사용하는 것을 강력히 권장합니다.

**1. 모델 생성**

Moshi는 두 개의 오디오 스트림을 가진 스트리밍 오토레그레시브 모델입니다. 다르게 말하면, 하나의 오디오 스트림은 모델이 말했거나 말할 내용을, 다른 오디오 스트림은 사용자가 말했거나 말할 내용을 나타냅니다.

따라서 [MoshiForConditionalGeneration.generate()](/docs/transformers/main/ko/model_doc/moshi#transformers.MoshiForConditionalGeneration.generate)에는 3개의 입력이 필요합니다:

1. `input_ids` - 텍스트 토큰 히스토리에 해당
2. `moshi_input_values` 또는 `moshi_audio_codes` - 모델 오디오 히스토리에 해당
3. `user_input_values` 또는 `user_audio_codes` - 사용자 오디오 히스토리에 해당

이 세 가지 입력은 동기화되어야 합니다. 즉, 길이가 동일한 수의 토큰에 대응해야 합니다.

테스트하려는 내용에 따라 3개의 입력을 동적으로 사용할 수 있습니다:

1. 사용자 프롬프트에 대한 모델 응답만 확인하는 경우, `input_ids`에는 pad 토큰을 채우고 `user_input_values`에는 사용자 프롬프트와 동일한 shape를 가진 zero tensor를 사용할 수 있습니다.
2. Test more complex behaviour - 이 경우, 입력 토큰이 오디오와 어떻게 동기화되는지 주의 깊게 살펴봐야 합니다.

원본 모델은 각 토큰 발음 사이에 텍스트를 패딩(padding)하여 텍스트와 오디오를 동기화합니다.

다음 이미지의 예를 따르려면, `"Hello, I'm Moshi"`는 `"Hello,<pad><unk>I'm Moshi"`로 변환될 수 있습니다.

[MoshiForConditionalGeneration.generate()](/docs/transformers/main/ko/model_doc/moshi#transformers.MoshiForConditionalGeneration.generate)는 자기 자신의 오디오 스트림을 자기 회귀적으로 입력하지만, `transformers`를 사용하는 동안에는 사용자 입력 스트림에 접근할 수 없으므로 **사용자가 빈 오디오를 생성한다고 가정**합니다.

```python
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_sequences
```

**2. 모델 학습**

스트림을 정렬/동기화해야 하므로 대부분의 작업은 데이터 생성/전처리 단계에서 수행해야 합니다.

완료되면, `text_labels`와 `audio_labels`를 일반적인 입력과 함께 [MoshiForConditionalGeneration.forward()](/docs/transformers/main/ko/model_doc/moshi#transformers.MoshiForConditionalGeneration.forward)에 전달하기만 하면 모델 손실을 얻을 수 있습니다.

학습 가이드는 곧 제공될 예정이며, 사용자 기여를 환영합니다!

### 모델은 입력을 전달하거나 생성하는 방식

1. 입력 스트림이 임베딩되어 `inputs_embeds`에 결합됩니다.

2. `inputs_embeds`는 메인 디코더를 통과하며, 이는 일반적인 LLM과 동일한 방식으로 처리됩니다.

3. 메인 디코더는 `text logits`를 출력하지만, 논문에서 `temporal context`라고 불리는 `last hidden state`도 함께 출력합니다.

3. Depth decoder는 전달/생성(코드북 대신 시간)하는 차원을 전환합니다. `text logits`에서 생성된 토큰과 `temporal context`를 사용하여 오디오 코드북을 오토레그레시브하게 생성합니다.

이 모델은 [Yoach Lacombe (ylacombe)](https://huggingface.co/ylacombe)님이 기여했습니다.

원본 코드는 [여기](https://github.com/kyutai-labs/moshi)에서 찾을 수 있습니다.

## MoshiConfig[[transformers.MoshiConfig]]

#### transformers.MoshiConfig[[transformers.MoshiConfig]]

```python
transformers.MoshiConfig(transformers_version: str | None = None, architectures: list[str] | None = None, output_hidden_states: bool | None = False, return_dict: bool | None = True, dtype: str | torch.dtype | None = None, chunk_size_feed_forward: int = 0, is_encoder_decoder: bool = False, id2label: dict[int, str] | dict[str, str] | None = None, label2id: dict[str, int] | dict[str, str] | None = None, problem_type: Literal['regression', 'single_label_classification', 'multi_label_classification'] | None = None, vocab_size: int = 32000, hidden_size: int = 4096, num_hidden_layers: int = 32, num_attention_heads: int = 32, num_key_value_heads: int | None = None, audio_vocab_size: int | None = None, max_position_embeddings: int = 3000, rope_parameters: transformers.modeling_rope_utils.RopeParameters | dict | None = None, hidden_act: str = 'silu', head_dim: int | None = None, initializer_range: float = 0.02, use_cache: bool = True, sliding_window: int = 3000, attention_dropout: float | int = 0.0, ffn_dim: int = 22528, rms_norm_eps: float = 1e-08, num_codebooks: int = 8, tie_word_embeddings: bool = False, pad_token_id: int | None = None, bos_token_id: int | None = None, eos_token_id: int | list[int] | None = None, audio_encoder_config: dict | transformers.configuration_utils.PreTrainedConfig | None = None, depth_decoder_config: dict | transformers.configuration_utils.PreTrainedConfig | None = None)
```

[소스](https://github.com/huggingface/transformers/blob/main/src/transformers/models/moshi/configuration_moshi.py#L93)

**매개변수:**

vocab_size (`int`, *선택 사항*, 기본값 `32000`) : 모델의 어휘 크기입니다. `input_ids`로 표현할 수 있는 서로 다른 토큰의 수를 정의합니다.

hidden_size (`int`, *선택 사항*, 기본값 `4096`) : 숨겨진 표현의 차원.

num_hidden_layers (`int`, *선택 사항*, 기본값 `32`) : Transformer decoder의 숨겨진 레이어 수.

num_attention_heads (`int`, *선택 사항*, 기본값 `32`) : Transformer decoder의 각 attention layer에 사용할 attention head 수입니다.

num_key_value_heads (`int`, *선택 사항*) : Grouped Query Attention 구현에 사용할 key_value 헤드 수입니다. `num_key_value_heads=num_attention_heads`인 경우 모델은 Multi Head Attention(MHA)을, `num_key_value_heads=1`인 경우 Multi Query Attention(MQA)을, 그 외에는 GQA를 사용합니다. 멀티 헤드 체크포인트를 GQA 체크포인트로 변환할 때, 각 그룹의 key 및 value 헤드는 해당 그룹 내 모든 원래 헤드를 meanpooling하여 구성해야 합니다. 자세한 내용은 [이 논문](https://huggingface.co/papers/2305.13245)을 참고하세요. 지정되지 않으면 기본값으로 `num_attention_heads`가 사용됩니다.

audio_vocab_size (`int`, *선택 사항*) : 모델의 오디오 부분 어휘 크기. Moshi 모델을 호출할 때 전달되는 `audio_codes`로 표현할 수 있는 서로 다른 토큰의 수를 정의합니다.

max_position_embeddings (`int`, *선택 사항*, 기본값 `3000`) : 이 모델이 사용될 수 있는 최대 시퀀스 길이입니다.

rope_parameters (`Union[~modeling_rope_utils.RopeParameters, dict]`, *선택*) : RoPE 임베딩의 구성 매개변수를 포함하는 사전입니다. 사전에는 `rope_theta` 값이 포함되어야 하며, 더 긴 `max_position_embeddings`로 RoPE를 사용하려는 경우 스케일링에 사용되는 매개변수도 선택적으로 포함할 수 있습니다.

hidden_act (`str`, *선택 사항*, 기본값 `silu`) : 디코더에서 사용되는 비선형 활성화 함수(함수 또는 문자열). 예를 들어, `"gelu"`, `"relu"`, `"silu"` 등이 있습니다.

head_dim (`int`, *선택 사항*) : 어텐션 헤드 차원입니다. None인 경우, 기본값은 hidden_size // num_attention_heads입니다.

initializer_range (`float`, *선택 사항*, 기본값 `0.02`) : 모든 가중치 행렬을 초기화하는 truncated_normal_initializer의 표준 편차입니다.

use_cache (`bool`, *선택 사항*, 기본값 `True`) : 모델이 마지막 key/values attention을 반환할지 여부입니다(모든 모델에서 사용되지 않음). `config.is_decoder=True`인 경우 또는 모델이 decoder-only 생성 모델인 경우에만 관련이 있습니다.

sliding_window (`int`, *선택 사항*, 기본값 `3000`) : Sliding window attention의 윈도우 크기입니다. `None`인 경우 sliding window가 적용되지 않습니다.

attention_dropout (`Union[float, int]`, *선택 사항*, 기본값 `0.0`) : attention 확률에 적용할 dropout 비율입니다.

ffn_dim (`int`, *선택 사항*, 기본값 22528) : 메인 디코더 블록의 "중간"(일반적으로 feed-forward라고도 함) 레이어의 차원. 짝수여야 합니다.

rms_norm_eps (`float`, *선택 사항*, 기본값 `1e-08`) : rms 정규화 레이어에서 사용되는 epsilon 값입니다.

num_codebooks (`int`, *선택 사항*, 기본값 `8`) : 모델이 사용하는 병렬 코드북의 수입니다.

tie_word_embeddings (`bool`, *선택 사항*, 기본값 `False`) : 모델의 `tied_weights_keys` 매핑에 따라 가중치 임베딩을 묶을지 여부.

pad_token_id (`int`, *선택 사항*) : 어휘에서 패딩에 사용되는 토큰 ID입니다.

bos_token_id (`int`, *선택 사항*) : 어휘에서 스트림 시작에 사용되는 토큰 ID입니다.

eos_token_id (`Union[int, list[int]]`, *선택*) : 어휘에서 스트림 종료에 사용되는 토큰 ID입니다.

audio_encoder_config (`PreTrainedConfig | dict`, *선택 사항*) : 오디오 인코더의 설정입니다.

depth_decoder_config (`PreTrainedConfig | dict`, *선택 사항*) : 깊이 디코더에 대한 설정입니다.

이것은 MoshiModel의 구성을 저장하기 위한 구성 클래스입니다. 지정된 인자에 따라 Moshi 모델을 인스턴스화하여 모델 아키텍처를 정의하는 데 사용됩니다. 기본값으로 구성을 인스턴스화하면 [kmhf/hf-moshika](https://huggingface.co/kmhf/hf-moshika)와 유사한 구성이 생성됩니다.

Configuration 객체는 [PreTrainedConfig](/docs/transformers/main/ko/main_classes/configuration#transformers.PreTrainedConfig)를 상속하며, 모델 출력을 제어하는 데 사용할 수 있습니다. 자세한 내용은 [PreTrainedConfig](/docs/transformers/main/ko/main_classes/configuration#transformers.PreTrainedConfig)의 문서를 참고하세요.

예:

```python
>>> 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[[transformers.MoshiConfig.from_audio_encoder_config]]

```python
from_audio_encoder_config(audio_encoder_config: PreTrainedConfig, **kwargs)
```

[소스](https://github.com/huggingface/transformers/blob/main/src/transformers/models/moshi/configuration_moshi.py#L199)

**반환값:** [MoshiConfig](/docs/transformers/main/ko/model_doc/moshi#transformers.MoshiConfig)

설정 객체의 인스턴스

오디오 인코더 구성에서 [MoshiConfig](/docs/transformers/main/ko/model_doc/moshi#transformers.MoshiConfig)(또는 파생 클래스)를 인스턴스화합니다.

## MoshiDepthConfig[[transformers.MoshiDepthConfig]]

#### transformers.MoshiDepthConfig[[transformers.MoshiDepthConfig]]

```python
transformers.MoshiDepthConfig(transformers_version: str | None = None, architectures: list[str] | None = None, output_hidden_states: bool | None = False, return_dict: bool | None = True, dtype: str | torch.dtype | None = None, chunk_size_feed_forward: int = 0, is_encoder_decoder: bool = False, id2label: dict[int, str] | dict[str, str] | None = None, label2id: dict[str, int] | dict[str, str] | None = None, problem_type: Literal['regression', 'single_label_classification', 'multi_label_classification'] | None = None, vocab_size: int = 32000, hidden_size: int = 1024, input_size: int = 4096, num_hidden_layers: int = 6, num_attention_heads: int = 16, num_key_value_heads: int | None = None, audio_vocab_size: int = 2048, max_position_embeddings: int = 9, hidden_act: str = 'silu', head_dim: int | None = None, initializer_range: float = 0.02, use_cache: bool = True, sliding_window: int = 8, attention_dropout: float | int = 0.0, ffn_dim: int = 5632, rms_norm_eps: float = 1e-08, num_codebooks: int = 8, tie_word_embeddings: bool = False, pad_token_id: int | None = None, bos_token_id: int | None = None, eos_token_id: int | list[int] | None = None)
```

[소스](https://github.com/huggingface/transformers/blob/main/src/transformers/models/moshi/configuration_moshi.py#L26)

**매개변수:**

vocab_size (`int`, *선택 사항*, 기본값 `32000`) : 모델의 어휘 크기입니다. `input_ids`로 표현할 수 있는 서로 다른 토큰의 수를 정의합니다.

hidden_size (`int`, *선택 사항*, 기본값 `1024`) : 숨겨진 표현의 차원.

input_size (`int`, *선택 사항*, 기본값 4096) : 입력 hidden states의 차원입니다. 메인 decoder와 depth decoder를 연결하는 데 사용됩니다.

num_hidden_layers (`int`, *선택 사항*, 기본값 `6`) : Transformer 디코더의 숨겨진 레이어 수.

num_attention_heads (`int`, *선택 사항*, 기본값 `16`) : Transformer decoder의 각 attention layer에 사용할 attention head의 수입니다.

num_key_value_heads (`int`, *선택 사항*) : Grouped Query Attention 구현에 사용할 key_value 헤드 수입니다. `num_key_value_heads=num_attention_heads`인 경우 모델은 Multi Head Attention(MHA)을, `num_key_value_heads=1`인 경우 Multi Query Attention(MQA)을, 그 외에는 GQA를 사용합니다. 멀티 헤드 체크포인트를 GQA 체크포인트로 변환할 때, 각 그룹의 key 및 value 헤드는 해당 그룹 내 모든 원래 헤드를 meanpooling하여 구성해야 합니다. 자세한 내용은 [이 논문](https://huggingface.co/papers/2305.13245)을 참고하세요. 지정되지 않으면 기본값으로 `num_attention_heads`가 사용됩니다.

audio_vocab_size (`int`, *선택 사항*, 기본값 2048) : 모델의 오디오 부분 어휘 크기. Moshi 모델을 호출할 때 전달하는 `audio_codes`로 표현할 수 있는 서로 다른 토큰의 수를 정의합니다.

max_position_embeddings (`int`, *선택 사항*, 기본값 `9`) : 이 모델이 사용될 수 있는 최대 시퀀스 길이입니다.

hidden_act (`str`, *선택 사항*, 기본값 `silu`) : 디코더에서 사용되는 비선형 활성화 함수(함수 또는 문자열). 예를 들어, `"gelu"`, `"relu"`, `"silu"` 등이 있습니다.

head_dim (`int`, *선택 사항*) : 어텐션 헤드 차원입니다. None인 경우, 기본값은 hidden_size // num_attention_heads입니다.

initializer_range (`float`, *선택 사항*, 기본값 `0.02`) : 모든 가중치 행렬을 초기화하는 truncated_normal_initializer의 표준 편차입니다.

use_cache (`bool`, *선택 사항*, 기본값 `True`) : 모델이 마지막 key/values attention을 반환할지 여부입니다(모든 모델에서 사용되지 않음). `config.is_decoder=True`인 경우 또는 모델이 decoder-only 생성 모델인 경우에만 관련이 있습니다.

sliding_window (`int`, *선택 사항*, 기본값 `8`) : Sliding window attention의 윈도우 크기입니다. `None`인 경우 sliding window가 적용되지 않습니다.

attention_dropout (`Union[float, int]`, *선택 사항*, 기본값 `0.0`) : attention 확률에 적용할 dropout 비율입니다.

ffn_dim (`int`, *선택 사항*, 기본값 5632) : depth decoder 블록의 "intermediate"(일반적으로 feed-forward라고도 함) 레이어의 차원. 짝수여야 합니다.

rms_norm_eps (`float`, *선택 사항*, 기본값 `1e-08`) : rms 정규화 레이어에서 사용되는 epsilon 값입니다.

num_codebooks (`int`, *선택 사항*, 기본값 `8`) : 모델이 사용하는 병렬 코드북의 수입니다.

tie_word_embeddings (`bool`, *선택 사항*, 기본값 `False`) : 모델의 `tied_weights_keys` 매핑에 따라 가중치 임베딩을 묶을지 여부.

pad_token_id (`int`, *선택 사항*) : 어휘에서 패딩에 사용되는 토큰 ID입니다.

bos_token_id (`int`, *선택 사항*) : 어휘에서 스트림 시작에 사용되는 토큰 ID입니다.

eos_token_id (`Union[int, list[int]]`, *선택*) : 어휘에서 스트림 종료에 사용되는 토큰 ID입니다.

이것은 MoshiModel의 구성을 저장하기 위한 구성 클래스입니다. 지정된 인자에 따라 Moshi 모델을 인스턴스화하여 모델 아키텍처를 정의하는 데 사용됩니다. 기본값으로 구성을 인스턴스화하면 [kmhf/hf-moshika](https://huggingface.co/kmhf/hf-moshika)와 유사한 구성이 생성됩니다.

Configuration 객체는 [PreTrainedConfig](/docs/transformers/main/ko/main_classes/configuration#transformers.PreTrainedConfig)를 상속하며, 모델 출력을 제어하는 데 사용할 수 있습니다. 자세한 내용은 [PreTrainedConfig](/docs/transformers/main/ko/main_classes/configuration#transformers.PreTrainedConfig)의 문서를 참고하세요.

예:

```python
>>> 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.config
```

## MoshiModel[[transformers.MoshiModel]]

#### transformers.MoshiModel[[transformers.MoshiModel]]

```python
transformers.MoshiModel(config: MoshiConfig)
```

[소스](https://github.com/huggingface/transformers/blob/main/src/transformers/models/moshi/modeling_moshi.py#L735)

**매개변수:**

config ([MoshiConfig](/docs/transformers/main/ko/model_doc/moshi#transformers.MoshiConfig)) : 모델의 모든 매개변수를 포함하는 모델 구성 클래스입니다. 구성 파일로 초기화하면 모델에 연결된 가중치가 로드되지 않고 구성만 로드됩니다. 모델 가중치를 로드하려면 [from_pretrained()](/docs/transformers/main/ko/main_classes/model#transformers.PreTrainedModel.from_pretrained) 메서드를 확인하세요.

특정 헤드가 위에 없는 상태에서 원시 hidden-states를 출력하는 기본 Moshi Model입니다.

이 모델은 [PreTrainedModel](/docs/transformers/main/ko/main_classes/model#transformers.PreTrainedModel)에서 상속됩니다. 라이브러리가 모든 모델에 대해 구현하는 일반적 메서드(다운로드 또는 저장, 입력 임베딩 크기 조정, 헤드 프루닝 등)에 대해서는 상위 클래스 문서를 확인하세요.

이 모델은 또한 PyTorch [torch.nn.Module](https://pytorch.org/docs/stable/nn.html#torch.nn.Module)의 하위 클래스입니다. 일반적인 PyTorch Module처럼 사용하며, 일반적인 사용법과 동작에 관한 모든 사항은 PyTorch 문서를 참조하세요.

#### forward[[transformers.MoshiModel.forward]]

```python
forward(input_ids: typing.Optional[torch.LongTensor] = None, attention_mask: typing.Optional[torch.Tensor] = None, position_ids: typing.Optional[torch.LongTensor] = None, past_key_values: transformers.cache_utils.Cache | None = None, inputs_embeds: typing.Optional[torch.Tensor] = None, use_cache: bool | None = None, **kwargs: *<class 'transformers.utils.generic.TransformersKwargs'>)
```

[소스](https://github.com/huggingface/transformers/blob/main/src/transformers/models/moshi/modeling_moshi.py#L754)

**매개변수:**

input_ids (`torch.LongTensor`, shape `(batch_size, sequence_length)`, *선택 사항*) : 어휘(input sequence tokens)의 인덱스입니다. 기본적으로 패딩은 무시됩니다. [AutoTokenizer](/docs/transformers/main/ko/model_doc/auto#transformers.AutoTokenizer)를 사용하여 인덱스를 얻을 수 있습니다. 자세한 내용은 [PreTrainedTokenizer.encode()](/docs/transformers/main/ko/internal/tokenization_utils#transformers.PreTrainedTokenizerBase.encode) 및 [PreTrainedTokenizer.__call__()](/docs/transformers/main/ko/internal/tokenization_utils#transformers.PreTrainedTokenizerBase.__call__)를 참조하세요. [입력 ID란 무엇인가요?](../glossary#input-ids)

attention_mask (`torch.Tensor`, shape `(batch_size, sequence_length)`, *선택 사항*) : 패딩 토큰 인덱스에 대한 attention을 수행하지 않도록 방지하는 마스크입니다. `[0, 1]`에서 선택된 마스크 값: - **마스크되지 않은** 토큰은 1, - **마스크된** 토큰은 0. [attention 마스크란?](../glossary#attention-mask)

position_ids (`torch.LongTensor`, shape `(batch_size, sequence_length)`, *선택 사항*) : 각 입력 시퀀스의 토큰 위치 인덱스입니다. `[0, config.n_positions - 1]` 범위에서 선택됩니다. [위치 ID란 무엇인가요?](../glossary#position-ids)

past_key_values (`~cache_utils.Cache`, *선택*) : 순차적 디코딩을 가속화할 수 있는 사전 계산된 hidden-states(셀프 어텐션 블록과 크로스 어텐션 블록의 key 및 value)입니다. 일반적으로 `use_cache=True` 또는 `config.use_cache=True`일 때 모델이 디코딩의 이전 단계에서 반환한 `past_key_values`로 구성됩니다. 입력으로 [Cache](/docs/transformers/main/ko/internal/generation_utils#transformers.Cache) 인스턴스만 허용되며, [kv cache 가이드](https://huggingface.co/docs/transformers/en/kv_cache)를 참조하세요. `past_key_values`가 전달되지 않으면 기본적으로 [DynamicCache](/docs/transformers/main/ko/internal/generation_utils#transformers.DynamicCache)가 초기화됩니다. 모델은 입력으로 제공된 것과 동일한 캐시 형식을 출력합니다. `past_key_values`를 사용하는 경우, 이 모델에 과거 key value 상태가 제공되지 않은 `input_ids`(처리되지 않은 항목)만 `(batch_size, unprocessed_length)` 형식으로 입력해야 하며, `(batch_size, sequence_length)` 형식의 모든 `input_ids`를 입력하지 않습니다.

inputs_embeds (`torch.Tensor`, shape `(batch_size, sequence_length, hidden_size)`, *선택 사항*) : `input_ids`를 전달하는 대신 임베디드 표현을 직접 전달할 수 있습니다. 이는 모델의 내부 임베딩 조회 행렬보다 `input_ids` 인덱스를 관련 벡터로 변환하는 방식에 대해 더 많은 제어가 필요한 경우 유용합니다.

use_cache (`bool`, *선택 사항*) : `True`로 설정하면 `past_key_values` 키 값 상태가 반환되며, 디코딩 속도를 높이는 데 사용할 수 있습니다(`past_key_values` 참조).

**반환값:** [BaseModelOutputWithPast](/docs/transformers/main/ko/main_classes/output#transformers.modeling_outputs.BaseModelOutputWithPast) 또는 `tuple(torch.Tensor)`

구성([MoshiConfig](/docs/transformers/main/ko/model_doc/moshi#transformers.MoshiConfig))과 입력에 따라 다양한 요소를 포함하는 [BaseModelOutputWithPast](/docs/transformers/main/ko/main_classes/output#transformers.modeling_outputs.BaseModelOutputWithPast) 또는 `torch.Tensor`의 튜플(`return_dict=False`가 전달되거나 `config.return_dict=False`인 경우).

[MoshiModel](/docs/transformers/main/ko/model_doc/moshi#transformers.MoshiModel)의 forward 메서드는 `__call__` 특수 메서드를 오버라이드합니다.

`Module` 인스턴스는 전처리 및 후처리 단계를 실행하는 것을 처리하지만, 이 함수는 해당 단계를 조용히 무시하므로, 순전파(forward pass) 레시피를 이 함수 내에서 정의해야 하더라도 이후에는 이 함수 대신 `Module` 인스턴스를 호출해야 합니다.

- **last_hidden_state** (`torch.Tensor`, shape `(batch_size, sequence_length, hidden_size)`) -- 모델의 마지막 레이어 출력에서 생성된 hidden-state 시퀀스입니다.

  `past_key_values`가 사용되면, `(batch_size, 1, hidden_size)` 형태의 시퀀스의 마지막 hidden-state만 출력됩니다.
- **past_key_values** (`Cache`, *선택 사항*, `use_cache=True`가 전달되었거나 `config.use_cache=True`인 경우 반환됨) -- [Cache](/docs/transformers/main/ko/internal/generation_utils#transformers.Cache) 인스턴스입니다. 자세한 내용은 [kv cache 가이드](https://huggingface.co/docs/transformers/en/kv_cache)를 참조하세요.

  순차적 디코딩을 가속화하는 데 사용할 수 있는 사전 계산된 hidden-states(셀프 어텐션 블록의 key와 value, 그리고 `config.is_encoder_decoder=True`인 경우 크로스 어텐션 블록의 key와 value)를 포함합니다(입력 `past_key_values` 참조).
- **hidden_states** (`tuple(torch.Tensor)`, *선택 사항*, `output_hidden_states=True`가 전달되었거나 `config.output_hidden_states=True`인 경우 반환됨) -- `torch.Tensor`의 튜플(모델에 임베딩 레이어가 있는 경우 임베딩 출력 1개 + 각 레이어의 출력 1개)로, 형태는 `(batch_size, sequence_length, hidden_size)`입니다.

  각 레이어의 출력에서 모델의 Hidden-states와 선택적 초기 임베딩 출력을 포함합니다.
- **attentions** (`tuple(torch.Tensor)`, *선택 사항*, `output_attentions=True`가 전달되었거나 `config.output_attentions=True`인 경우 반환됨) -- 각 레이어마다 하나씩 포함된 `torch.Tensor`의 튜플로, 모양은 `(batch_size, num_heads, sequence_length, sequence_length)`입니다.

  self-attention 헤드에서 가중 평균을 계산하는 데 사용되는 attention softmax 이후의 attention 가중치입니다.

## MoshiForCausalLM[[transformers.MoshiForCausalLM]]

#### transformers.MoshiForCausalLM[[transformers.MoshiForCausalLM]]

```python
transformers.MoshiForCausalLM(config: MoshiConfig)
```

[소스](https://github.com/huggingface/transformers/blob/main/src/transformers/models/moshi/modeling_moshi.py#L807)

**매개변수:**

config ([MoshiConfig](/docs/transformers/main/ko/model_doc/moshi#transformers.MoshiConfig)) : 모델의 모든 매개변수를 포함하는 모델 구성 클래스입니다. 구성 파일로 초기화하면 모델에 연결된 가중치가 로드되지 않고 구성만 로드됩니다. 모델 가중치를 로드하려면 [from_pretrained()](/docs/transformers/main/ko/main_classes/model#transformers.PreTrainedModel.from_pretrained) 메서드를 확인하세요.

텍스트 언어 모델링 헤드가 위에 있는 Moshi 디코더 모델입니다. 텍스트에만 사용할 수 있습니다.

이 모델은 [PreTrainedModel](/docs/transformers/main/ko/main_classes/model#transformers.PreTrainedModel)에서 상속됩니다. 라이브러리가 모든 모델에 대해 구현하는 일반적 메서드(다운로드 또는 저장, 입력 임베딩 크기 조정, 헤드 프루닝 등)에 대해서는 상위 클래스 문서를 확인하세요.

이 모델은 또한 PyTorch [torch.nn.Module](https://pytorch.org/docs/stable/nn.html#torch.nn.Module)의 하위 클래스입니다. 일반적인 PyTorch Module처럼 사용하며, 일반적인 사용법과 동작에 관한 모든 사항은 PyTorch 문서를 참조하세요.

#### forward[[transformers.MoshiForCausalLM.forward]]

```python
forward(input_ids: typing.Optional[torch.LongTensor] = None, attention_mask: typing.Optional[torch.Tensor] = None, position_ids: typing.Optional[torch.LongTensor] = None, past_key_values: transformers.cache_utils.Cache | None = None, inputs_embeds: typing.Optional[torch.Tensor] = None, use_cache: bool | None = None, labels: typing.Optional[torch.LongTensor] = None, logits_to_keep: typing.Union[int, torch.Tensor] = 0, **kwargs: *<class 'transformers.utils.generic.TransformersKwargs'>)
```

[소스](https://github.com/huggingface/transformers/blob/main/src/transformers/models/moshi/modeling_moshi.py#L820)

**매개변수:**

input_ids (`torch.LongTensor`, shape `(batch_size, sequence_length)`, *선택 사항*) : 어휘(input sequence tokens)의 인덱스입니다. 기본적으로 패딩은 무시됩니다. [AutoTokenizer](/docs/transformers/main/ko/model_doc/auto#transformers.AutoTokenizer)를 사용하여 인덱스를 얻을 수 있습니다. 자세한 내용은 [PreTrainedTokenizer.encode()](/docs/transformers/main/ko/internal/tokenization_utils#transformers.PreTrainedTokenizerBase.encode) 및 [PreTrainedTokenizer.__call__()](/docs/transformers/main/ko/internal/tokenization_utils#transformers.PreTrainedTokenizerBase.__call__)를 참조하세요. [입력 ID란 무엇인가요?](../glossary#input-ids)

attention_mask (`torch.Tensor`, shape `(batch_size, sequence_length)`, *선택 사항*) : 패딩 토큰 인덱스에 대한 attention을 수행하지 않도록 방지하는 마스크입니다. `[0, 1]`에서 선택된 마스크 값: - **마스크되지 않은** 토큰은 1, - **마스크된** 토큰은 0. [attention 마스크란?](../glossary#attention-mask)

position_ids (`torch.LongTensor`, shape `(batch_size, sequence_length)`, *선택 사항*) : 각 입력 시퀀스의 토큰 위치 인덱스입니다. `[0, config.n_positions - 1]` 범위에서 선택됩니다. [위치 ID란 무엇인가요?](../glossary#position-ids)

past_key_values (`~cache_utils.Cache`, *선택*) : 순차적 디코딩을 가속화할 수 있는 사전 계산된 hidden-states(셀프 어텐션 블록과 크로스 어텐션 블록의 key 및 value)입니다. 일반적으로 `use_cache=True` 또는 `config.use_cache=True`일 때 모델이 디코딩의 이전 단계에서 반환한 `past_key_values`로 구성됩니다. 입력으로 [Cache](/docs/transformers/main/ko/internal/generation_utils#transformers.Cache) 인스턴스만 허용되며, [kv cache 가이드](https://huggingface.co/docs/transformers/en/kv_cache)를 참조하세요. `past_key_values`가 전달되지 않으면 기본적으로 [DynamicCache](/docs/transformers/main/ko/internal/generation_utils#transformers.DynamicCache)가 초기화됩니다. 모델은 입력으로 제공된 것과 동일한 캐시 형식을 출력합니다. `past_key_values`를 사용하는 경우, 이 모델에 과거 key value 상태가 제공되지 않은 `input_ids`(처리되지 않은 항목)만 `(batch_size, unprocessed_length)` 형식으로 입력해야 하며, `(batch_size, sequence_length)` 형식의 모든 `input_ids`를 입력하지 않습니다.

inputs_embeds (`torch.Tensor`, shape `(batch_size, sequence_length, hidden_size)`, *선택 사항*) : `input_ids`를 전달하는 대신 임베디드 표현을 직접 전달할 수 있습니다. 이는 모델의 내부 임베딩 조회 행렬보다 `input_ids` 인덱스를 관련 벡터로 변환하는 방식에 대해 더 많은 제어가 필요한 경우 유용합니다.

use_cache (`bool`, *선택 사항*) : `True`로 설정하면 `past_key_values` 키 값 상태가 반환되며, 디코딩 속도를 높이는 데 사용할 수 있습니다(`past_key_values` 참조).

labels (`torch.LongTensor`, shape `(batch_size, sequence_length)`, *선택 사항*) : masked language modeling loss를 계산하기 위한 라벨. 인덱스는 `[0, ..., config.vocab_size]` 범위 내이거나 -100이어야 합니다(`input_ids` docstring 참조). 인덱스가 `-100`으로 설정된 토큰은 무시(마스크)되며, loss는 `[0, ..., config.vocab_size]` 범위의 라벨을 가진 토큰에 대해서만 계산됩니다.

logits_to_keep (`Union[int, torch.Tensor]`, *선택 사항*, 기본값 `0`) : `int`인 경우, 마지막 `logits_to_keep` 토큰에 대한 logits를 계산합니다. `0`인 경우, 모든 `input_ids`에 대한 logits를 계산합니다(특수한 경우). 생성에는 마지막 토큰의 logits만 필요하며, 해당 토큰에 대해서만 계산하면 메모리를 절약할 수 있습니다. 이는 긴 시퀀스나 큰 어휘 크기의 경우 상당한 이점을 제공합니다. `torch.Tensor`인 경우, 시퀀스 길이 차원에서 유지할 인덱스에 해당하는 1차원 텐서여야 합니다. 이는 packed tensor 형식(배치와 시퀀스 길이를 단일 차원으로 사용하는 경우)을 사용할 때 유용합니다.

**반환값:** `MoshiCausalLMOutputWithPast` 또는 `tuple(torch.Tensor)`

구성([MoshiConfig](/docs/transformers/main/ko/model_doc/moshi#transformers.MoshiConfig))과 입력에 따라 다양한 요소를 포함하는 `MoshiCausalLMOutputWithPast` 또는 `torch.Tensor`의 튜플(`return_dict=False`가 전달되거나 `config.return_dict=False`인 경우).

[MoshiForCausalLM](/docs/transformers/main/ko/model_doc/moshi#transformers.MoshiForCausalLM)의 forward 메서드는 `__call__` 특수 메서드를 오버라이드합니다.

`Module` 인스턴스는 전처리 및 후처리 단계를 실행하는 것을 처리하지만, 이 함수는 해당 단계를 조용히 무시하므로, 순전파(forward pass) 레시피를 이 함수 내에서 정의해야 하더라도 이후에는 이 함수 대신 `Module` 인스턴스를 호출해야 합니다.

- **loss** (`torch.Tensor`, shape `(1,)`, *선택 사항*, `labels`가 제공될 때 반환됨) -- 언어 모델링 손실(다음 토큰 예측용).
- **logits** (`torch.Tensor`, shape `(batch_size, sequence_length, config.vocab_size)`) -- 언어 모델링 헤드에서 생성된 예측 점수(SoftMax 적용 전 각 어휘 토큰에 대한 점수).
- **last_hidden_state** (`torch.Tensor`, shape `(batch_size, sequence_length, hidden_size)`, *선택 사항*) -- 모델의 마지막 레이어 출력에서 생성된 hidden-state 시퀀스입니다.
- **past_key_values** (`Cache`, *선택 사항*, `use_cache=True`가 전달되었거나 `config.use_cache=True`인 경우 반환됨) -- [Cache](/docs/transformers/main/ko/internal/generation_utils#transformers.Cache) 인스턴스입니다. 자세한 내용은 [kv cache 가이드](https://huggingface.co/docs/transformers/en/kv_cache)를 참조하세요.

  순차적 디코딩을 가속화하는 데 사용할 수 있는 사전 계산된 hidden-states(셀프 어텐션 블록의 key와 value)를 포함합니다(입력 `past_key_values` 참조).
- **hidden_states** (`tuple[torch.Tensor, ...]`, *선택*, `output_hidden_states=True`가 전달되거나 `config.output_hidden_states=True`인 경우 반환) -- shape가 `(batch_size, sequence_length, hidden_size)`인 `torch.Tensor`의 튜플 (모델에 임베딩 레이어가 있는 경우 임베딩 출력 1개 + 각 레이어의 출력 1개).

  각 레이어의 출력에서 모델의 Hidden-states와 선택적 초기 임베딩 출력을 포함합니다.
- **attentions** (`tuple[torch.Tensor, ...]`, *선택*, `output_attentions=True`가 전달되었거나 `config.output_attentions=True`인 경우 반환) -- 각 레이어마다 하나씩 포함된 `torch.Tensor` 튜플로, shape는 `(batch_size, num_heads, sequence_length, sequence_length)`입니다.

  self-attention 헤드에서 가중 평균을 계산하는 데 사용되는 attention softmax 이후의 attention 가중치입니다.

예:

```python
>>> 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[[transformers.MoshiForConditionalGeneration]]

#### transformers.MoshiForConditionalGeneration[[transformers.MoshiForConditionalGeneration]]

```python
transformers.MoshiForConditionalGeneration(config: MoshiConfig)
```

[소스](https://github.com/huggingface/transformers/blob/main/src/transformers/models/moshi/modeling_moshi.py#L884)

**매개변수:**

config ([MoshiConfig](/docs/transformers/main/ko/model_doc/moshi#transformers.MoshiConfig)) : 모델의 모든 매개변수를 포함하는 모델 구성 클래스입니다. 구성 파일로 초기화하면 모델에 연결된 가중치가 로드되지 않고 구성만 로드됩니다. 모델 가중치를 로드하려면 [from_pretrained()](/docs/transformers/main/ko/main_classes/model#transformers.PreTrainedModel.from_pretrained) 메서드를 확인하세요.

음성 인코더, Moshi depth decoder, Moshi decoder를 갖춘 원래 Moshi 모델로, 음성-음성 변환(speech-to-speech)에 사용됩니다.

이 모델은 [PreTrainedModel](/docs/transformers/main/ko/main_classes/model#transformers.PreTrainedModel)에서 상속됩니다. 라이브러리가 모든 모델에 대해 구현하는 일반적 메서드(다운로드 또는 저장, 입력 임베딩 크기 조정, 헤드 프루닝 등)에 대해서는 상위 클래스 문서를 확인하세요.

이 모델은 또한 PyTorch [torch.nn.Module](https://pytorch.org/docs/stable/nn.html#torch.nn.Module)의 하위 클래스입니다. 일반적인 PyTorch Module처럼 사용하며, 일반적인 사용법과 동작에 관한 모든 사항은 PyTorch 문서를 참조하세요.

#### forward[[transformers.MoshiForConditionalGeneration.forward]]

```python
forward(input_ids: typing.Optional[torch.LongTensor] = None, attention_mask: typing.Optional[torch.BoolTensor] = None, user_input_values: typing.Optional[torch.Tensor] = None, user_audio_codes: typing.Optional[torch.Tensor] = None, moshi_input_values: typing.Optional[torch.Tensor] = None, moshi_audio_codes: typing.Optional[torch.Tensor] = None, past_key_values: transformers.cache_utils.Cache | None = None, inputs_embeds: typing.Optional[torch.Tensor] = None, text_labels: typing.Optional[torch.LongTensor] = None, audio_labels: typing.Optional[torch.LongTensor] = None, use_cache: bool | None = None, **kwargs)
```

[소스](https://github.com/huggingface/transformers/blob/main/src/transformers/models/moshi/modeling_moshi.py#L911)

**매개변수:**

input_ids (`torch.LongTensor`, shape `(batch_size, sequence_length)`, *선택 사항*) : 어휘(input sequence tokens)의 인덱스입니다. 기본적으로 패딩은 무시됩니다. [AutoTokenizer](/docs/transformers/main/ko/model_doc/auto#transformers.AutoTokenizer)를 사용하여 인덱스를 얻을 수 있습니다. 자세한 내용은 [PreTrainedTokenizer.encode()](/docs/transformers/main/ko/internal/tokenization_utils#transformers.PreTrainedTokenizerBase.encode) 및 [PreTrainedTokenizer.__call__()](/docs/transformers/main/ko/internal/tokenization_utils#transformers.PreTrainedTokenizerBase.__call__)를 참조하세요. [입력 ID란 무엇인가요?](../glossary#input-ids)

attention_mask (`torch.BoolTensor`, shape `(batch_size, sequence_length)`, *선택 사항*) : 패딩 토큰 인덱스에 대한 어텐션을 수행하지 않도록 하는 마스크. `[0, 1]`에서 선택된 마스크 값: - **마스크되지 않은** 토큰은 1, - **마스크된** 토큰은 0. [어텐션 마스크란?](../glossary#attention-mask)

user_input_values (`torch.Tensor `의 shape은 `(batch_size, 1, audio_sequence_length)`, *선택 사항*) : 생성을 위한 오디오 사용자 프롬프트로 사용되는 오디오 웨이브폼입니다.

user_audio_codes (`torch.Tensor `of shape `(batch_size, num_codebooks, sequence_length), *optional*) : The audio codes used as audio user prompt for the generation. Has priority over `user_input_values` and represents the audio "tokens" of `user_input_values` once passed through the audio encoder.

moshi_input_values (`torch.Tensor `의 shape은 `(batch_size, 1, audio_sequence_length)`, *선택 사항*) : 생성을 위한 오디오 Moshi 프롬프트로 사용되는 오디오 웨이브폼입니다.

moshi_audio_codes (`torch.Tensor ` of shape `(batch_size, num_codebooks, sequence_length), *optional*) : The audio codes used as audio Moshi prompt for the generation. Has priority over `moshi_input_values` and represents the audio "tokens" of `moshi_input_values` once passed through the audio encoder.

past_key_values (`~cache_utils.Cache`, *선택*) : 순차적 디코딩을 가속화할 수 있는 사전 계산된 hidden-states(셀프 어텐션 블록과 크로스 어텐션 블록의 key 및 value)입니다. 일반적으로 `use_cache=True` 또는 `config.use_cache=True`일 때 모델이 디코딩의 이전 단계에서 반환한 `past_key_values`로 구성됩니다. 입력으로 [Cache](/docs/transformers/main/ko/internal/generation_utils#transformers.Cache) 인스턴스만 허용되며, [kv cache 가이드](https://huggingface.co/docs/transformers/en/kv_cache)를 참조하세요. `past_key_values`가 전달되지 않으면 기본적으로 [DynamicCache](/docs/transformers/main/ko/internal/generation_utils#transformers.DynamicCache)가 초기화됩니다. 모델은 입력으로 제공된 것과 동일한 캐시 형식을 출력합니다. `past_key_values`를 사용하는 경우, 이 모델에 과거 key value 상태가 제공되지 않은 `input_ids`(처리되지 않은 항목)만 `(batch_size, unprocessed_length)` 형식으로 입력해야 하며, `(batch_size, sequence_length)` 형식의 모든 `input_ids`를 입력하지 않습니다.

inputs_embeds (`torch.Tensor`, shape `(batch_size, sequence_length, hidden_size)`, *선택 사항*) : `input_ids`를 전달하는 대신 임베디드 표현을 직접 전달할 수 있습니다. `past_key_values`를 사용하는 경우, 선택적으로 마지막 `inputs_embeds`만 입력하면 됩니다(`past_key_values` 참조). 모델 내부 임베딩 조회 행렬보다 `input_ids` 인덱스를 관련 벡터로 변환하는 방식을 더 세밀하게 제어하려는 경우 유용합니다. `input_ids`와 `inputs_embeds`가 모두 설정되지 않은 경우, `inputs_embeds`는 `inputs_embeds`의 값을 취합니다.

text_labels (`torch.LongTensor`, shape `(batch_size, sequence_length)`, *선택 사항*) : 텍스트 언어 모델링을 위한 라벨. 모델 내부에서 라벨이 **시프트(shift)됩니다**. 즉, `labels = input_ids`로 설정할 수 있습니다. 인덱스는 `[-100, 0, ..., config.vocab_size]` 범위에서 선택됩니다. `-100`으로 설정된 모든 라벨은 무시(마스크)되며, 손실은 `[0, ..., config.vocab_size]` 범위의 라벨에 대해서만 계산됩니다.

audio_labels (`torch.LongTensor`, shape `(batch_size, num_codebooks, sequence_length)`, *선택 사항*) : 언어 모델링을 위한 라벨. 모델 내부에서 라벨이 **시프트**되므로 `labels = input_ids`로 설정할 수 있습니다. 인덱스는 `[-100, 0, ..., config.vocab_size]` 범위에서 선택됩니다. `-100`으로 설정된 모든 라벨은 무시(마스크)되며, 손실은 `[0, ..., config.audio_vocab_size]` 범위의 라벨에 대해서만 계산됩니다.

use_cache (`bool`, *선택 사항*) : `True`로 설정하면 `past_key_values` 키 값 상태가 반환되며, 디코딩 속도를 높이는 데 사용할 수 있습니다(`past_key_values` 참조).

**반환값:** `MoshiConditionalGenerationOutputWithPast` 또는 `tuple(torch.Tensor)`

구성([MoshiConfig](/docs/transformers/main/ko/model_doc/moshi#transformers.MoshiConfig))과 입력에 따라 다양한 요소를 포함하는 `MoshiConditionalGenerationOutputWithPast` 또는 `torch.Tensor`의 튜플(`return_dict=False`가 전달되거나 `config.return_dict=False`인 경우).

[MoshiForConditionalGeneration](/docs/transformers/main/ko/model_doc/moshi#transformers.MoshiForConditionalGeneration)의 forward 메서드는 `__call__` 특수 메서드를 오버라이드합니다.

`Module` 인스턴스는 전처리 및 후처리 단계를 실행하는 것을 처리하지만, 이 함수는 해당 단계를 조용히 무시하므로, 순전파(forward pass) 레시피를 이 함수 내에서 정의해야 하더라도 이후에는 이 함수 대신 `Module` 인스턴스를 호출해야 합니다.

- **loss** (`torch.Tensor`, shape `(1,)`, *선택 사항*, `text_labels`이 제공될 때 반환됨) -- 텍스트 언어 모델링 손실(다음 토큰 예측용).
- **logits** (`torch.Tensor`, shape `(batch_size, sequence_length, config.vocab_size)`) -- 텍스트 언어 모델링 헤드에 대한 예측 점수(SoftMax 적용 전 각 어휘 토큰의 점수).
- **last_hidden_state** (`torch.Tensor`, shape `(batch_size, sequence_length, hidden_size)`, *선택 사항*) -- 모델의 마지막 레이어 출력에서 생성된 hidden-state 시퀀스입니다.
- **past_key_values** (`Cache`, *선택 사항*, `use_cache=True`가 전달되었거나 `config.use_cache=True`인 경우 반환됨) -- [Cache](/docs/transformers/main/ko/internal/generation_utils#transformers.Cache) 인스턴스입니다. 자세한 내용은 [kv cache 가이드](https://huggingface.co/docs/transformers/en/kv_cache)를 참조하세요.

  순차적 디코딩을 가속화하는 데 사용할 수 있는 사전 계산된 hidden-states(셀프 어텐션 블록의 key와 value)를 포함합니다(입력 `past_key_values` 참조).
- **hidden_states** (`tuple[torch.Tensor, ...]`, *선택*, `output_hidden_states=True`가 전달되거나 `config.output_hidden_states=True`인 경우 반환) -- shape가 `(batch_size, sequence_length, hidden_size)`인 `torch.Tensor`의 튜플 (모델에 임베딩 레이어가 있는 경우 임베딩 출력 1개 + 각 레이어의 출력 1개).

  각 레이어의 출력에서 모델의 Hidden-states와 선택적 초기 임베딩 출력을 포함합니다.
- **attentions** (`tuple[torch.Tensor, ...]`, *선택*, `output_attentions=True`가 전달되었거나 `config.output_attentions=True`인 경우 반환) -- 각 레이어마다 하나씩 포함된 `torch.Tensor` 튜플로, shape는 `(batch_size, num_heads, sequence_length, sequence_length)`입니다.

  self-attention 헤드에서 가중 평균을 계산하는 데 사용되는 attention softmax 이후의 attention 가중치입니다.
- **depth_loss** (`torch.Tensor`, shape `(1,)`, *선택 사항*, `audio_labels`이 제공될 때 반환됨) -- 오디오 언어 모델링 손실(다음 토큰 예측용).
- **audio_logits** (`torch.Tensor`, shape `(batch_size, sequence_length, config.vocab_size)`) -- 오디오 언어 모델링 헤드의 예측 점수.
- **depth_past_key_values** (`Cache`, *선택 사항*, `use_cache=True`가 전달되거나 `config.use_cache=True`인 경우 반환됨) -- depth 디코더의 과거 key-value입니다.
- **depth_hidden_states** (`tuple(torch.Tensor)`, *선택 사항*, `output_hidden_states=True`가 전달되거나 `config.output_hidden_states=True`인 경우 반환됨) -- 깊이 디코더의 숨겨진 상태
- **depth_attentions** (`tuple(torch.Tensor)`, *선택 사항*, `output_attentions=True`가 전달되었거나 `config.output_attentions=True`인 경우 반환됨) -- self-attention heads에서 가중 평균을 계산하는 데 사용되는, attention softmax 이후의 Depth decoder의 Attentions 가중치입니다.

예:
```python
>>> 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[[transformers.MoshiForConditionalGeneration.generate]]

```python
generate(input_ids: typing.Optional[torch.LongTensor] = None, user_input_values: typing.Optional[torch.Tensor] = None, user_audio_codes: typing.Optional[torch.Tensor] = None, moshi_input_values: typing.Optional[torch.Tensor] = None, moshi_audio_codes: typing.Optional[torch.Tensor] = None, inputs_embeds: typing.Optional[torch.Tensor] = None, return_audio_waveforms: bool | None = True, return_audio_codes: bool | None = None, concat_unconditional_inputs: bool | None = True, **kwargs)
```

[소스](https://github.com/huggingface/transformers/blob/main/src/transformers/models/moshi/modeling_moshi.py#L1203)

**매개변수:**

input_ids (`torch.Tensor `의 shape은 `(batch_size, sequence_length)`, *선택 사항*) : 생성을 위한 텍스트 프롬프트로 사용되는 시퀀스.

user_input_values (`torch.Tensor `의 shape은 `(batch_size, 1, audio_sequence_length)`, *선택 사항*) : 생성을 위한 오디오 사용자 프롬프트로 사용되는 오디오 웨이브폼입니다.

user_audio_codes (`torch.Tensor `of shape `(batch_size, num_codebooks, sequence_length), *optional*) : The audio codes used as audio user prompt for the generation. Has priority over `user_input_values` and represents the audio "tokens" of `user_input_values` once passed through the audio encoder.

moshi_input_values (`torch.Tensor `의 shape은 `(batch_size, 1, audio_sequence_length)`, *선택 사항*) : 생성을 위한 오디오 Moshi 프롬프트로 사용되는 오디오 웨이브폼입니다.

moshi_audio_codes (`torch.Tensor ` of shape `(batch_size, num_codebooks, sequence_length), *optional*) : The audio codes used as audio Moshi prompt for the generation. Has priority over `moshi_input_values` and represents the audio "tokens" of `moshi_input_values` once passed through the audio encoder.

inputs_embeds (`torch.Tensor`, shape `(batch_size, sequence_length, hidden_size)`, *선택 사항*) : `input_ids`와 오디오 입력을 전달하는 대신 임베디드 표현을 직접 전달할 수 있습니다. 이는 모델의 내부 임베딩 조회 행렬보다 입력을 관련 벡터로 변환하는 방식에 대한 더 세밀한 제어가 필요한 경우 유용합니다.

return_audio_waveforms (`bool`, *선택 사항*, 기본값 `True`) : `False`인 경우 오디오 웨이브폼을 생성하지 않습니다.

return_audio_codes (`bool`, *선택 사항*) : `True`인 경우, 오디오 디코더를 통과하면 `audio_sequences`로 변환되는 중간 오디오 "토큰"인 생성된 오디오 코드도 반환합니다.

concat_unconditional_inputs (`bool`, *선택 사항*, 기본값 `True`) : `False`인 경우, 초기 오디오 및 텍스트 토큰을 연결하지 않습니다.

kwargs (`dict[str, Any]`, *선택*) : `generate` 메서드에 전달되는 나머지 키워드 인자 사전입니다. 사용법에 대한 자세한 내용은 원래의 [`generate` 문서 문자열](https://huggingface.co/docs/transformers/main/en/main_classes/text_generation#transformers.GenerationMixin.generate)을 참조하세요. *depth_* 접두사가 붙은 키워드는 depth decoder의 `generate` 메서드 입력으로 사용됩니다. 그렇지 않으면 해당 메서드는 기본 생성 구성을 사용합니다.

**반환값:**

`MoshiConditionalGenerationGenerateOutput`

텍스트 토큰 id와 오디오 토큰 id의 시퀀스를 생성합니다.

#### get_unconditional_inputs[[transformers.MoshiForConditionalGeneration.get_unconditional_inputs]]

```python
get_unconditional_inputs(num_samples = 1)
```

[소스](https://github.com/huggingface/transformers/blob/main/src/transformers/models/moshi/modeling_moshi.py#L1632)

**매개변수:**

num_samples (int, *선택 사항*) : 무조건 생성할 오디오 샘플 수.

max_new_tokens (int, *선택 사항*) : 각 샘플에 생성할 토큰 수. 토큰 수가 많을수록 오디오 샘플이 길어지지만, 샘플당 더 많은 오디오 토큰을 생성해야 하므로 추론 시간이 길어집니다.

…

예:
```python
>>> 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)
```