Hugging Face's logo

Transformers documentation

Whisper

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

이 모델은 2022-12-06에 HF papers에 게시되었으며, 2022-10-05에 Hugging Face Transformers에 기여되었습니다.

FlashAttention SDPA

Whisper

Whisper는 680,000시간의 라벨이 붙은 오디오 데이터로 사전 학습된 인코더-디코더(시퀀스-투-시퀀스) transformer입니다. 이 규모의 사전 학습 데이터는 영어를 비롯한 여러 언어의 오디오 작업에서 zero-shot 성능을 가능하게 합니다. 디코더는 추가적인 fine-tuning 없이 인코더가 학습한 음성 표현을 텍스트와 같은 유용한 출력으로 매핑할 수 있도록 합니다. Whisper는 설치 후 바로 사용할 수 있습니다.

모든 원본 Whisper 체크포인트는 Whisper 컬렉션에서 찾을 수 있습니다.

Whisper를 다양한 오디오 작업에 적용하는 방법에 대한 추가 예제는 오른쪽 사이드바의 Whisper 모델에서 확인하세요.

use_kernels=True를 from_pretrained()에 설정하여 Hub의 최적화 커널로 지원되는 레이어를 대체합니다. 자세한 내용은 커널 로딩을 참고하세요.

아래 예제는 Pipeline 또는 AutoModel 클래스를 사용하여 음성에서 텍스트로 자동으로 전사하는 방법을 보여줍니다.

Pipeline
AutoModel
from transformers import pipeline


pipeline = pipeline(
    task="automatic-speech-recognition",
    model="openai/whisper-large-v3-turbo",
    device=0
)
pipeline("https://huggingface.co/datasets/Narsil/asr_dummy/resolve/main/mlk.flac")

The input is a single word "Notes". 참고

  • Whisper는 추론을 위해 커스텀 generate를 사용하므로, 아래 문서를 꼭 확인하세요.
  • WhisperProcessor는 오디오를 준비하고 예측된 id를 텍스트로 복원하는 데 사용할 수 있습니다.

WhisperConfig

클래스 transformers.WhisperConfig

< >

( 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 = 0id2label: 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 = Noneis_encoder_decoder: bool = Truevocab_size: int = 51865num_mel_bins: int = 80encoder_layers: int = 4encoder_attention_heads: int = 6decoder_layers: int = 4decoder_attention_heads: int = 6decoder_ffn_dim: int = 1536encoder_ffn_dim: int = 1536encoder_layerdrop: float | int = 0.0decoder_layerdrop: float | int = 0.0decoder_start_token_id: int = 50257use_cache: bool = Trueactivation_function: str = 'gelu'd_model: int = 384dropout: float | int = 0.0attention_dropout: float | int = 0.0activation_dropout: float | int = 0.0init_std: float = 0.02scale_embedding: bool = Falsemax_source_positions: int = 1500max_target_positions: int = 448pad_token_id: int | None = 50256bos_token_id: int | None = 50256eos_token_id: int | list[int] | None = 50256suppress_tokens: list | None = Nonebegin_suppress_tokens: list[int] | tuple[int, ...] | None = (220, 50256)use_weighted_layer_sum: bool = Falseclassifier_proj_size: int = 256apply_spec_augment: bool = Falsemask_time_prob: float | int = 0.05mask_time_length: int = 10mask_time_min_masks: int = 2mask_feature_prob: float | int = 0.0mask_feature_length: int = 10mask_feature_min_masks: int = 0median_filter_width: int = 7tie_word_embeddings: bool = True )

매개변수

  • is_encoder_decoder (bool, 선택 사항, 기본값 True) — 모델이 인코더/디코더로 사용되는지 여부를 나타냅니다.
  • vocab_size (int, 선택 사항, 기본값 51865) — 모델의 어휘 크기입니다. input_ids로 표현할 수 있는 서로 다른 토큰의 수를 정의합니다.
  • num_mel_bins (int, 선택 사항, 기본값 80) — 입력 프레임당 사용되는 mel 특징의 수입니다. AutoFeatureExtractor 클래스에서 사용된 값과 일치해야 합니다.
  • encoder_layers (int, 선택 사항, 기본값 4) — Transformer 인코더의 숨겨진 레이어 수입니다. 설정하지 않으면 num_layers와 동일한 값을 사용합니다.
  • encoder_attention_heads (int, 선택 사항, 기본값 6) — Transformer 인코더의 각 어텐션 레이어에 사용할 어텐션 헤드 수입니다.
  • decoder_layers (int, 선택 사항, 기본값 4) — Transformer decoder의 숨겨진 레이어 수입니다. 설정하지 않으면 num_layers와 동일한 값을 사용합니다.
  • decoder_attention_heads (int, 선택 사항, 기본값 6) — Transformer decoder의 각 attention layer에 사용할 attention head 수입니다.
  • decoder_ffn_dim (int, 선택 사항, 기본값 1536) — decoder의 “intermediate”(일반적으로 feed-forward라고도 함) 레이어의 차원.
  • encoder_ffn_dim (int, 선택 사항, 기본값 1536) — 인코더의 “중간” 레이어(일반적으로 feed-forward 레이어라고도 함)의 차원입니다.
  • encoder_layerdrop (Union[float, int], 선택 사항, 기본값 0.0) — 인코더의 LayerDrop 확률입니다. 자세한 내용은 [LayerDrop 논문](https://huggingface.co/papers/1909.11556 참조)을 참고하세요.
  • decoder_layerdrop (Union[float, int], 선택 사항, 기본값 0.0) — 디코더의 LayerDrop 확률입니다. 자세한 내용은 [LayerDrop 논문](https://huggingface.co/papers/1909.11556 참조)을 참고하세요.
  • decoder_start_token_id (int, 선택 사항, 기본값 50257) — 인코더-디코더 모델이 bos와 다른 토큰으로 디코딩을 시작하는 경우, 해당 토큰의 id입니다.
  • use_cache (bool, 선택 사항, 기본값 True) — 모델이 마지막 key/values attention을 반환할지 여부입니다(모든 모델에서 사용되지 않음). config.is_decoder=True인 경우 또는 모델이 decoder-only 생성 모델인 경우에만 관련이 있습니다.
  • activation_function (str, 선택 사항, 기본값 gelu) — 디코더에서 사용되는 비선형 활성화 함수(함수 또는 문자열)입니다. 예를 들어, "gelu", "relu", "silu" 등이 있습니다.
  • d_model (int, 선택 사항, 기본값 384) — 인코더 레이어와 풀러 레이어의 크기입니다.
  • dropout (Union[float, int], 선택 사항, 기본값 0.0) — 모든 dropout 레이어에 적용할 비율입니다.
  • attention_dropout (Union[float, int], 선택 사항, 기본값 0.0) — Attention 확률에 적용할 dropout 비율입니다.
  • activation_dropout (Union[float, int], 선택 사항, 기본값 0.0) — 완전 연결 레이어 내부 활성화에 적용할 dropout 비율입니다.
  • init_std (float, 선택 사항, 기본값 0.02) — 모든 가중치 행렬을 초기화하는 truncated_normal_initializer의 표준 편차입니다.
  • scale_embedding (bool, 선택 사항, 기본값 False) — 임베딩을 sqrt(d_model)로 나누어 스케일링할지 여부.
  • max_source_positions (int, 선택 사항, 기본값 1500) — 이 모델이 사용될 수 있는 log-mel filter-bank feature의 최대 시퀀스 길이입니다.
  • max_target_positions (int, 선택 사항, 기본값 448) — 이 모델이 사용될 수 있는 최대 시퀀스 길이입니다. 혹시 모를 상황에 대비하여 일반적으로 큰 값(예: 512, 1024 또는 2048)으로 설정합니다.
  • pad_token_id (int, 선택 사항, 기본값 50256) — 어휘에서 패딩에 사용되는 토큰 ID입니다.
  • bos_token_id (int, 선택 사항, 기본값 50256) — 어휘에서 스트림 시작에 사용되는 토큰 ID입니다.
  • eos_token_id (Union[int, list[int]], 선택 사항, 기본값 50256) — 어휘에서 스트림 종료에 사용되는 토큰 id입니다.
  • suppress_tokens (list[int], optional) — generate 함수에서 logit processor가 사용하는 비음성(non-speech) 토큰을 포함하는 목록입니다. NON_SPEECH_TOKENS와 NON_SPEECH_TOKENS_MULTI는 각각 english-only 모델과 multilingual 모델에 해당합니다.
  • begin_suppress_tokens (list[int], 선택 사항, 기본값 [220,50256]) — 샘플링 과정의 시작 부분에 억제될 토큰을 포함하는 목록입니다. " " 토큰(blank_token_id)과 eos_token_id로 초기화됩니다.
  • use_weighted_layer_sum (bool, 선택 사항, 기본값 False) — 학습된 가중치를 사용하여 레이어 출력의 가중 평균을 사용할지 여부입니다. WhisperForAudioClassification 인스턴스를 사용하는 경우에만 관련이 있습니다.
  • classifier_proj_size (int, 선택 사항, 기본값 256) — 분류를 위한 토큰 평균 풀링 전에 적용되는 투영의 차원입니다. WhisperForAudioClassification 인스턴스를 사용할 때만 관련이 있습니다.
  • apply_spec_augment (bool, 선택 사항, 기본값 False) — 피처 인코더의 출력에 SpecAugment 데이터 증강을 적용할지 여부. 참고로 SpecAugment: A Simple Data Augmentation Method for Automatic Speech Recognition를 참조하세요.
  • mask_time_prob (float, 선택 사항, 기본값 0.05) — 시간 축을 따라 마스킹될 모든 특징 벡터의 비율(0에서 1 사이). 마스킹 절차는 해당 축에 대해 mask_time_prob*len(time_axis)/mask_time_length개의 독립적인 마스킹을 생성합니다. 마스킹될 벡터 스팬의 시작점으로 선택될 각 특징 벡터의 확률로부터 추론한다면, mask_time_prob는 prob_vector_start*mask_time_length여야 합니다. 겹침(overlap)으로 인해 실제 마스킹된 벡터의 비율이 감소할 수 있습니다. 이는 apply_spec_augment == True인 경우에만 관련이 있습니다.
  • mask_time_length (int, 선택 사항, 기본값 10) — 시간 축을 따라 벡터가 확장되는 길이.
  • mask_time_min_masks (int, 선택 사항, 기본값 2), — mask_feature_prob와 무관하게, 시간축의 각 시간 단계에서 mask_feature_length 길이의 최소 마스크 수입니다. "mask_time_prob*len(time_axis)/mask_time_length < mask_time_min_masks"인 경우에만 관련이 있습니다.
  • mask_feature_prob (float, 선택 사항, 기본값 0.0) — feature 축을 따라 모든 feature 벡터 중 마스킹될 비율(0에서 1 사이). 마스킹 절차는 해당 축에 대해 mask_feature_prob*len(feature_axis)/mask_time_length개의 독립적인 마스크를 생성합니다. 각 feature 벡터가 마스킹될 벡터 스팬의 시작점으로 선택될 확률로부터 추론한다면, mask_feature_prob은 prob_vector_start*mask_feature_length여야 합니다. 겹침(overlap)으로 인해 실제 마스킹된 벡터의 비율이 감소할 수 있습니다. 이는 apply_spec_augment is True인 경우에만 관련이 있습니다.
  • mask_feature_prob (Union[float, int], 선택 사항, 기본값 0.0) — feature 축을 따라 마스킹될 모든 feature 벡터의 비율(0에서 1 사이). 마스킹 절차는 해당 축에 대해 mask_feature_prob*len(feature_axis)/mask_time_length개의 독립적인 마스크를 생성합니다. 각 feature 벡터가 마스킹될 벡터 스팬의 시작점으로 선택될 확률로부터 추론한다면, mask_feature_prob는 prob_vector_start*mask_feature_length여야 합니다. 겹침(overlap)으로 인해 실제 마스킹된 벡터의 비율이 감소할 수 있습니다. 이는 apply_spec_augment가 True인 경우에만 관련이 있습니다.
  • mask_feature_length (int, 선택 사항, 기본값 10) — feature 축을 따라 벡터가 확장되는 길이입니다.
  • mask_feature_min_masks (int, 선택 사항, 기본값 0) — mask_feature_prob와 무관하게, 각 타임스텝마다 feature 축을 따라 생성되는 mask_feature_length 길이의 최소 마스크 수입니다. mask_feature_prob*len(feature_axis)/mask_feature_length < mask_feature_min_masks인 경우에만 관련이 있습니다.
  • median_filter_width (int, 선택 사항, 기본값 7) — 토큰 타임스탬프를 계산할 때 크로스 어텐션 출력을 부드럽게 만들기 위해 사용되는 중앙값 필터의 폭입니다. 홀수여야 합니다.
  • tie_word_embeddings (bool, 선택, 기본값 True) — 모델의 tied_weights_keys 매핑에 따라 가중치 임베딩을 묶을지 여부.

이것은 WhisperModel의 설정을 저장하기 위한 설정 클래스입니다. 지정된 인자에 따라 Whisper 모델을 초기화하여 모델 아키텍처를 정의하는 데 사용됩니다. 기본값으로 설정을 초기화하면 openai/whisper-tiny와 유사한 설정이 생성됩니다.

Configuration 객체는 PreTrainedConfig를 상속하며 모델 출력을 제어하는 데 사용할 수 있습니다. 자세한 내용은 PreTrainedConfig의 문서를 참고하세요.

예:

>>> from transformers import WhisperConfig, WhisperModel

>>> # Initializing a Whisper tiny style configuration
>>> configuration = WhisperConfig()

>>> # Initializing a model (with random weights) from the tiny style configuration
>>> model = WhisperModel(configuration)

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

WhisperTokenizer

class transformers.WhisperTokenizer

< >

( vocab: str | dict[str, int] | None = Nonemerges = Nonenormalizer_file = Noneunk_token = '<|endoftext|>'bos_token = '<|endoftext|>'eos_token = '<|endoftext|>'add_prefix_space = Falselanguage = Nonetask = Nonepredict_timestamps = False**kwargs )

매개변수

  • vocab_file (str, 선택 사항) — 어휘 파일의 경로입니다.
  • merges_file (str, 선택) — merges 파일의 경로.
  • normalizer_file (str, 선택 사항) — normalizer_file 파일의 경로.
  • tokenizer_file (str, 선택 사항) — 토크나이저를 로드하는 데 필요한 모든 정보가 포함된 tokenizers 파일(일반적으로 .json 확장자를 가짐)의 경로입니다.
  • unk_token (str, 선택 사항, 기본값 "<|endoftext|>") — 미지의 토큰입니다. 어휘에 없는 토큰은 ID로 변환할 수 없으므로, 대신 이 토큰으로 설정됩니다.
  • bos_token (str, 선택 사항, 기본값 "<|endoftext|>") — 시퀀스 시작 토큰입니다. 생성 시 decoder_start_token_id를 사용하여 첫 번째 토큰을 "<|startoftranscript|>"로 설정합니다.
  • eos_token (str, 선택 사항, 기본값 "<|endoftext|>") — 시퀀스 종료 토큰입니다.
  • add_prefix_space (bool, 선택 사항, 기본값 False) — 입력에 맨 앞에 공백을 추가할지 여부입니다. 이를 통해 맨 앞의 단어를 다른 단어와 동일하게 처리할 수 있습니다. (Whisper 토크나이저는 앞선 공백을 기준으로 단어의 시작을 감지합니다).
  • language (str, 선택 사항) — 전사 텍스트의 언어입니다. 다국어 음성 인식 및 음성 번역 작업에서는 해당 언어의 id 토큰이 시퀀스 시작 부분에 추가됩니다. 예를 들어 스페인어인 경우 "<|es|>" 토큰이 시퀀스 시작 부분에 추가됩니다. 이 인수는 다국어 파인튜닝에만 사용해야 합니다.
  • task (str, 선택 사항) — 시퀀스 시작 부분에 추가할 작업 식별자(있는 경우). 이는 다국어 fine-tuning에 사용되며, 음성 인식에는 "transcribe", 음성 번역에는 "translate"를 사용합니다.
  • predict_timestamps (bool, 선택 사항, 기본값 False) — 시퀀스 시작 부분에 <|notimestamps|> 토큰을 생략할지 여부입니다.

HuggingFace의 tokenizers 라이브러리를 기반으로 하는 “fast” Whisper 토크나이저를 구성합니다.

이 토크나이저는 대부분의 주요 메서드를 포함하는 PreTrainedTokenizerFast를 상속합니다. 해당 메서드에 대한 자세한 내용은 이 상위 클래스를 참고하세요.

set_prefix_tokens

< >

( language: str | None = Nonetask: str | None = Nonepredict_timestamps: bool | None = None )

매개변수

  • language (str, 선택 사항, 기본값 None) — 전사 텍스트의 언어입니다.
  • task (str, 선택 사항, 기본값 None) — 시퀀스 시작 부분에 추가할 작업 식별자(있는 경우).
  • predict_timestamps (bool, 선택 사항, 기본값 None) — 시퀀스 시작 부분에 <|notimestamps|> 토큰을 생략할지 여부입니다.

의 시작 부분에 추가되는 prefix 토큰을 재정의합니다. 이 메서드는 단독으로

fine-tuning 시 필요에 따라 prefix 토큰을 업데이트하세요. 예:

>>> # instantiate the tokenizer and set the prefix token to Spanish
>>> tokenizer = WhisperTokenizerFast.from_pretrained("openai/whisper-tiny", language="spanish")
>>> # now switch the prefix token from Spanish to French
>>> tokenizer.set_prefix_tokens(language="french")

get_special_tokens_mask

< >

( token_ids_0: listtoken_ids_1: list[int] | None = Nonealready_has_special_tokens: bool = False ) → list[int]

매개변수

  • token_ids_0 (list[int]) — ID 목록.
  • token_ids_1 (list[int], 선택 사항) — 시퀀스 쌍을 위한 선택적 두 번째 ID 목록입니다.
  • already_has_special_tokens (bool, 선택, 기본값 False) — 토큰 목록이 이미 모델의 특수 토큰으로 포맷되어 있는지 여부입니다.

반환값

list[int]

[0, 1] 범위의 정수 목록: 특수 토큰은 1, 시퀀스 토큰은 0.

특수 토큰이 추가되지 않은 토큰 목록에서 시퀀스 ID를 가져옵니다. 이 메서드는 토크나이저의 prepare_for_model 메서드를 사용하여 특수 토큰을 추가할 때 호출됩니다.

save_vocabulary

< >

( save_directory: strfilename_prefix: str | None = None )

batch_decode

< >

( sequences: list[int] | list[list[int]] | np.ndarray | torch.Tensorskip_special_tokens: bool = Falseclean_up_tokenization_spaces: bool | None = None**kwargs ) → list[str]

매개변수

  • sequences (Union[list[int], list[list[int]], np.ndarray, torch.Tensor]) — 토큰화된 입력 ID 목록입니다. __call__ 메서드를 사용하여 얻을 수 있습니다.
  • skip_special_tokens (bool, 선택 사항, 기본값 False) — 디코딩 과정에서 특수 토큰을 제거할지 여부입니다.
  • clean_up_tokenization_spaces (bool, 선택) — 토큰화 공백을 정리할지 여부입니다. None인 경우 기본값으로 self.clean_up_tokenization_spaces를 사용합니다.
  • kwargs (추가 키워드 인자, 선택 사항) — 기저 모델의 특정 decode 메서드에 전달됩니다.

반환값

list[str]

디코딩된 문장의 목록입니다.

decode를 호출하여 토큰 ID의 리스트로 된 리스트를 문자열의 리스트로 변환합니다.

이 메서드는 하위 호환성을 위해 제공됩니다. decode 메서드가 이제 배치 입력을 네이티브로 처리하므로, batch_decode 대신 decode를 직접 사용할 수 있습니다.

decode

< >

( token_idsskip_special_tokens: bool = Falseclean_up_tokenization_spaces: bool | None = Noneoutput_offsets: bool = Falsetime_precision: float = 0.02decode_with_timestamps: bool = Falsenormalize: bool = Falsebasic_normalize: bool = Falseremove_diacritics: bool = False**kwargs ) → str

매개변수

  • token_ids (Union[int, list[int], np.ndarray, torch.Tensor]) — 토큰화된 입력 ID 목록입니다. __call__ 메서드를 사용하여 얻을 수 있습니다.
  • skip_special_tokens (bool, 선택 사항, 기본값 False) — 디코딩 과정에서 특수 토큰을 제거할지 여부입니다. 존재하는 경우 이전 토큰(프롬프트 이전)도 함께 제거됩니다.
  • clean_up_tokenization_spaces (bool, 선택) — 토큰화 공백을 정리할지 여부입니다. None인 경우 tokenizer_config에서 사용할 수 있는 self.clean_up_tokenization_spaces 값이 기본값으로 적용됩니다.
  • output_offsets (bool, 선택, 기본값 False) — 토큰의 오프셋을 출력할지 여부입니다. 모델이 타임스탬프를 예측한 경우에만 설정해야 합니다. 디코딩할 이전 토큰(프롬프트 이전)이 있는 경우, 타임스탬프 토큰을 포함하고 있을 때만 디코딩된 텍스트에 표시됩니다.
  • time_precision (float, 선택 사항, 기본값 0.02) — 토큰을 시간으로 변환할 때 사용할 시간 비율입니다.
  • decode_with_timestamps (bool, 선택 사항, 기본값 False) — 원시 텍스트에 타임스탬프를 포함하여 디코딩할지 여부.
  • normalize (bool, 선택 사항, 기본값 False) — 디코딩된 텍스트에 영어 텍스트 정규화기를 적용할지 여부. 대상 텍스트가 영어인 경우에만 적용됩니다. 그렇지 않은 경우 기본 텍스트 정규화기를 적용해야 합니다.
  • basic_normalize (bool, 선택 사항, 기본값 False) — 디코딩된 텍스트에 Basic 텍스트 정규화기를 적용할지 여부입니다. 다국어 대상 텍스트에 적용됩니다.
  • remove_diacritics (bool, 선택, 기본값 False) — Basic 텍스트 정규화기를 적용할 때 발음 부호를 제거할지 여부입니다. 발음 부호를 제거하면 복호화된 텍스트의 정보가 손상될 수 있으므로 신중하게 사용해야 합니다.
  • kwargs (추가 키워드 인자, 선택 사항) — 기저 모델의 특정 decode 메서드에 전달됩니다.

반환값

str

복호화된 문장.

토크나이저와 어휘를 사용하여 문자열의 id 시퀀스를 변환하며, 특수 토큰 제거 및 토큰화 공간 정리 옵션을 제공합니다.

self.convert_tokens_to_string(self.convert_ids_to_tokens(token_ids))를 실행하는 것과 유사합니다.

basic_normalize

< >

( textremove_diacritics = False )

BasicTextNormalizer 클래스를 사용하여 주어진 문자열을 정규화합니다. 이 클래스는 다국어 텍스트에 대해 일반적인 변환을 수행합니다.

normalize

< >

( text )

EnglishTextNormalizer 클래스를 사용하여 주어진 문자열을 정규화합니다. 이 클래스는 영어 텍스트에 대한 일반적인 변환을 수행합니다.

WhisperFeatureExtractor

class transformers.WhisperFeatureExtractor

< >

( feature_size = 80sampling_rate = 16000hop_length = 160chunk_length = 30n_fft = 400padding_value = 0.0dither = 0.0return_attention_mask = False**kwargs )

매개변수

  • feature_size (int, 선택 사항, 기본값 80) — 추출된 특징의 차원입니다.
  • sampling_rate (int, 선택 사항, 기본값 16000) — 오디오 파일을 디지털화할 때 사용할 샘플링 주파수(Hz).
  • hop_length (int, 선택 사항, 기본값 160) — Mel Frequency 계수를 얻기 위해 사용되는 STFT의 겹치는 윈도우 길이.
  • chunk_length (int, 선택 사항, 기본값 30) — 더 길거나 더 짧은 오디오 시퀀스를 자르고 패딩하는 데 사용되는 sampling_rate 샘플 수의 최대 청크 수입니다.
  • n_fft (int, 선택 사항, 기본값 400) — 푸리에 변환의 크기.
  • padding_value (float, 선택 사항, 기본값 0.0) — 오디오를 패딩하는 데 사용되는 값입니다. 무음 구간과 대응해야 합니다.
  • dither (float, 선택 사항, 기본값 0.0) — 디더링을 추가합니다. 즉, 각 프레임에 작은 가우시안 노이즈를 추가합니다. 예를 들어 0.0001을 사용하면 0.0을 중심으로 표준편차가 0.0001인 정규 분포의 디더링을 추가합니다( raw_speech의 범위가 [-1,+1]이라고 가정). 0.0 값은 디더링을 하지 않음을 의미합니다. 디더링은 spectrogram(mel_floor=...)과 유사한 효과를 냅니다. 신호에 VAD 컷오프가 존재할 때, 하드 제로 구간이 있는 신호의 높은 log_mel_fbank 값을 줄입니다.

Whisper feature extractor를 생성합니다.

이 feature extractor는 SequenceFeatureExtractor를 상속하며, 이 클래스에는 대부분의 주요 메서드가 포함되어 있습니다. 해당 메서드에 대한 자세한 내용은 이 상위 클래스를 참고하세요.

이 클래스는 Short Time Fourier Transform의 커스텀 numpy 구현을 사용하여 원시 음성에서 mel-filter bank 특징을 추출하며, pytorch의 torch.stft와 동일한 결과를 내야 합니다.

__call__

< >

( raw_speech: numpy.ndarray | list[float] | list[numpy.ndarray] | list[list[float]]truncation: bool = Truepad_to_multiple_of: int | None = Nonereturn_tensors: str | transformers.utils.generic.TensorType | None = Nonereturn_attention_mask: bool | None = Nonepadding: str | None = 'max_length'max_length: int | None = Nonesampling_rate: int | None = Nonedo_normalize: bool | None = Nonedevice: str | None = 'cpu'**kwargs )

매개변수

  • raw_speech (np.ndarray, list[float], list[np.ndarray], list[list[float]]) — 패딩할 시퀀스 또는 시퀀스 배치입니다. 각 시퀀스는 numpy 배열, float 값의 리스트, numpy 배열의 리스트, 또는 float 값의 리스트의 리스트일 수 있습니다. 스테레오가 아닌 모노 채널 오디오여야 하며, 즉 각 타임스텝당 float 값이 하나만 있어야 합니다.
  • truncation (bool, 선택 사항, 기본값 True) — max_length보다 긴 입력 시퀀스를 max_length로 잘라내는 truncation을 활성화합니다.
  • pad_to_multiple_of (int, 선택 사항, 기본값은 None) — 설정하면 시퀀스를 제공된 값의 배수로 패딩합니다.

    이 기능은 NVIDIA 하드웨어에서 Tensor Cores 사용을 활성화하는 데 특히 유용하며, 이는 compute capability가 >= 7.5(Volta)인 하드웨어나, 시퀀스 길이가 128의 배수일 때 성능 향상을 얻는 TPU에서 해당됩니다.

  • return_tensors (str 또는 TensorType, 선택 사항) — 설정된 경우, Python 정수 목록 대신 텐서를 반환합니다. 허용되는 값은 다음과 같습니다:
    • 'pt': PyTorch torch.Tensor 객체를 반환합니다.
    • 'np': Numpy np.ndarray 객체를 반환합니다.
  • return_attention_mask (bool, 선택 사항) — attention mask를 반환할지 여부. 기본값을 그대로 두면 해당 feature_extractor의 기본 설정에 따라 attention mask를 반환합니다.

    어텐션 마스크란 무엇인가요?

    Whisper 모델의 경우, 미묘한 버그를 방지하기 위해 배치 추론 시 attention_mask를 항상 전달해야 합니다.

  • padding (str 또는 PaddingStrategy, 선택 사항, 기본값은 'max_length') — 패딩을 활성화하고 제어합니다. 다음 값을 받을 수 있습니다: 'longest': 배치 내 가장 긴 시퀀스 길이로 패딩합니다(단일 시퀀스만 제공된 경우 패딩하지 않음). 'max_length' (기본값): max_length 인수로 지정된 최대 길이로 패딩하거나, 해당 인수가 제공되지 않은 경우 모델이 허용하는 최대 입력 길이로 패딩합니다. 'do_not_pad': 패딩하지 않음(즉, 길이가 다른 시퀀스로 구성된 배치를 출력할 수 있음).
    • 'longest': 배치 내 가장 긴 시퀀스 길이에 맞게 패딩을 적용합니다(단일 시퀀스만 제공된 경우 패딩을 하지 않음).
    • 'max_length' (기본값): max_length 인수로 지정된 최대 길이로 패딩하거나, 해당 인수가 제공되지 않으면 모델이 허용하는 최대 입력 길이로 패딩합니다.
    • 'do_not_pad': 패딩 없음(즉, 서로 다른 길이의 시퀀스로 구성된 배치 출력 가능).
  • max_length (int, 선택 사항) — truncation/padding 파라미터 중 하나가 사용할 최대 길이를 제어합니다.

    설정하지 않거나 None으로 설정하면, truncation/padding 파라미터 중 하나가 최대 길이를 요구할 경우 미리 정의된 모델 최대 길이를 사용합니다. 모델에 특정 최대 입력 길이가 없는 경우(XLNet 등) 최대 길이로 truncation/padding하는 기능이 비활성화됩니다.

  • sampling_rate (int, 선택 사항) — raw_speech 입력이 샘플링된 샘플링 레이트입니다. 조용한 오류를 방지하고 자동 음성 인식 파이프라인을 사용할 수 있도록, forward 호출 시 sampling_rate를 전달하는 것을 강력히 권장합니다.
  • do_normalize (bool, 선택 사항, 기본값 False) — 입력을 평균 0, 분산 1로 정규화할지 여부입니다. 정규화를 적용하면 모델 성능을 크게 향상시킬 수 있습니다.
  • device (str, 선택 사항, 기본값 'cpu') — _torch_extract_fbank_features 메서드에서 오디오 신호의 log-mel spectrogram을 계산할 때 사용할 장치를 지정합니다. (예: “cpu”, “cuda”)
  • **kwargs — WhisperFeatureExtractor의 call()에서 지원되지 않으며 무시됩니다.

PyTorch가 사용 가능한 경우 STFT 계산에 이를 사용하는, 하나 이상의 시퀀스를 특징화하고 모델에 맞게 준비하는 주요 메서드입니다. 사용 불가능한 경우 더 느린 NumPy 기반 구현을 사용합니다.

WhisperProcessor

클래스 transformers.WhisperProcessor

< >

( feature_extractortokenizer )

매개변수

  • feature_extractor (WhisperFeatureExtractor) — 피처 추출기는 필수 입력입니다.
  • tokenizer (WhisperTokenizer) — 토크나이저는 필수 입력값입니다.

feature extractor와 tokenizer를 단일 processor로 감싸는 WhisperProcessor를 생성합니다.

WhisperProcessor는 WhisperFeatureExtractor와 WhisperTokenizer의 모든 기능을 제공합니다. 자세한 내용은 ~WhisperFeatureExtractor와 ~WhisperTokenizer를 참고하세요.

__call__

< >

( *args**kwargs )

매개변수

  • return_tensors (str 또는 TensorType, 선택 사항) — 설정된 경우, 특정 프레임워크의 텐서를 반환합니다. 허용되는 값은 다음과 같습니다:
    • 'pt': PyTorch torch.Tensor 객체를 반환합니다.
    • 'np': NumPy np.ndarray 객체를 반환합니다.

from_pretrained

< >

( pretrained_model_name_or_path: str | os.PathLikecache_dir: str | os.PathLike | None = Noneforce_download: bool = Falselocal_files_only: bool = Falsetoken: str | bool | None = Nonerevision: str = 'main'**kwargs )

매개변수

  • pretrained_model_name_or_path (str 또는 os.PathLike) — 다음 중 하나일 수 있습니다:
    • 문자열이며, huggingface.co의 모델 저장소에 호스팅된 사전 학습된 feature_extractor의 model id입니다.
    • save_pretrained() 메서드를 사용하여 feature extractor 파일을 저장한 디렉터리의 경로, 예: ./my_model_directory/.
    • 저장된 feature extractor JSON 파일의 경로, 예: ./my_model_directory/preprocessor_config.json.
  • **kwargs — from_pretrained()와 ~tokenization_utils_base.PreTrainedTokenizer.from_pretrained에 함께 전달되는 추가 키워드 인자입니다.

과(와) 연관된 를 초기화합니다.

이 클래스 메서드는 단순히 feature extractor의 from_pretrained(), image processor의 ImageProcessingMixin 및 tokenizer의 ~tokenization_utils_base.PreTrainedTokenizer.from_pretrained 메서드를 호출합니다. 자세한 내용은 위 메서드들의 docstring을 참고하세요.

save_pretrained

< >

( save_directorypush_to_hub: bool = False**kwargs )

매개변수

  • save_directory (str 또는 os.PathLike) — feature extractor JSON 파일과 tokenizer 파일이 저장될 디렉터리입니다(존재하지 않는 경우 생성됩니다).
  • push_to_hub (bool, 선택 사항, 기본값 False) — 모델을 저장한 후 Hugging Face 모델 허브에 푸시할지 여부입니다. repo_id를 사용하여 푸시할 저장소를 지정할 수 있으며, 지정하지 않으면 네임스페이스 내 save_directory의 이름이 기본값으로 사용됩니다.
  • kwargs (dict[str, Any], 선택) — push_to_hub() 메서드에 함께 전달되는 추가 키워드 인자입니다.

이 프로세서(feature extractor, tokenizer 등)의 속성을 지정된 디렉터리에 저장하여 from_pretrained() 메서드를 사용해 다시 로드할 수 있도록 합니다.

이 클래스 메서드는 단순히 save_pretrained()와 save_pretrained()를 호출합니다. 자세한 내용은 위 메서드의 docstring을 참고하세요.

batch_decode

< >

( *args**kwargs )

이 메서드는 모든 인수를 PreTrainedTokenizer의 batch_decode()로 전달합니다. 자세한 내용은 해당 메서드의 docstring을 참고하세요.

decode

< >

( *args**kwargs )

이 메서드는 모든 인수를 PreTrainedTokenizer의 decode()로 전달합니다. 자세한 내용은 해당 메서드의 docstring을 참조하세요.

WhisperModel

class transformers.WhisperModel

< >

( config: WhisperConfig )

매개변수

  • config (WhisperConfig) — 모델의 모든 매개변수를 포함하는 모델 구성 클래스입니다. 구성 파일로 초기화하는 것은 모델과 관련된 가중치를 로드하지 않으며, 구성 정보만 로드합니다. 모델 가중치를 로드하려면 from_pretrained() 메서드를 확인하세요.

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

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

이 모델은 또한 PyTorch torch.nn.Module의 하위 클래스입니다. 일반적인 PyTorch Module처럼 사용하며, 일반적인 사용법 및 동작과 관련된 모든 사항은 PyTorch 문서를 참조하세요.

forward

< >

( input_features: typing.Optional[torch.Tensor] = Noneattention_mask: typing.Optional[torch.LongTensor] = Nonedecoder_input_ids: typing.Optional[torch.LongTensor] = Nonedecoder_attention_mask: typing.Optional[torch.LongTensor] = Noneencoder_outputs: tuple[tuple[torch.Tensor]] | None = Nonepast_key_values: transformers.cache_utils.Cache | None = Nonedecoder_inputs_embeds: tuple[torch.Tensor] | None = Nonedecoder_position_ids: tuple[torch.LongTensor] | None = Noneuse_cache: bool | None = None**kwargs ) → Seq2SeqModelOutput or tuple(torch.Tensor)

매개변수

  • input_features (torch.Tensor, shape (batch_size, sequence_length, feature_dim), 선택 사항) — 입력 오디오 특징에 해당하는 텐서입니다. 오디오 특징은 WhisperFeatureExtractor를 사용하여 얻을 수 있습니다. 자세한 내용은 WhisperFeatureExtractor.call()를 참조하세요 (WhisperProcessor는 오디오 처리에 WhisperFeatureExtractor를 사용합니다).
  • attention_mask (torch.LongTensor 형상이 (batch_size, sequence_length), 선택 사항) — 패딩 토큰 인덱스에 대한 attention을 수행하지 않도록 하는 마스크. [0, 1]에서 선택된 마스크 값: 마스크되지 않은 토큰은 1, 마스크된 토큰은 0. attention mask란 무엇인가요? [0, 1]:
    • 마스크되지 않은 토큰에 대해 1
    • 마스크된 토큰에 대해 0

    어텐션 마스크란 무엇인가요?

  • decoder_input_ids (torch.LongTensor 형상 (batch_size, target_sequence_length), 선택 사항) — 어휘에서 디코더 입력 시퀀스 토큰의 인덱스입니다. WhisperTokenizer를 사용하여 인덱스를 가져올 수 있습니다. 자세한 내용은 PreTrainedTokenizer.encode() 및 PreTrainedTokenizer.call()를 참조하세요. 디코더 입력 ID란 무엇인가요? Whisper는 decoder_input_ids 생성의 시작 토큰으로 decoder_start_token_id를 사용합니다. past_key_values를 사용하는 경우, 선택적으로 마지막 decoder_input_ids만 입력하면 됩니다(past_key_values 참조).

    WhisperTokenizer를 사용하여 인덱스를 얻을 수 있습니다. 자세한 내용은 PreTrainedTokenizer.encode() 및 PreTrainedTokenizer.call()를 참고하세요.

    디코더 입력 ID란 무엇인가요?

    Whisper는 decoder_input_ids 생성의 시작 토큰으로 decoder_start_token_id를 사용합니다. past_key_values를 사용하는 경우, 선택적으로 마지막 decoder_input_ids만 입력하면 됩니다(past_key_values 참조).

  • decoder_attention_mask (torch.LongTensor 다음 shape의 (batch_size, target_sequence_length), 선택 사항) — 기본 동작: decoder_input_ids. 의 pad 토큰을 무시하는 텐서를 생성합니다. 기본값으로 Causal mask도 사용됩니다. 패딩 동작을 변경하려면 modeling_whisper._prepare_decoder_attention_mask를 읽고 필요에 맞게 수정하세요. 기본 전략에 대한 자세한 내용은 BART 논문에서 다이어그램 1을 참고하세요.

    패딩 동작을 변경하려면 modeling_whisper._prepare_decoder_attention_mask를 읽고 필요에 맞게 수정해야 합니다. 기본 전략에 대한 자세한 내용은 BART 논문의 다이어그램 1을 참고하세요.

  • encoder_outputs (tuple[tuple[torch.Tensor]], 선택 사항) — (last_hidden_state, 선택 사항: hidden_states, 선택 사항: attentions)으로 구성된 Tuple입니다. last_hidden_state의 shape은 (batch_size, sequence_length, hidden_size), 선택 사항)이며, 인코더의 마지막 레이어 출력에서 생성된 hidden-states의 시퀀스입니다. 디코더의 cross-attention에 사용됩니다.
  • past_key_values (~cache_utils.Cache, 선택 사항) — 순차적 디코딩을 가속화할 수 있는 사전 계산된 hidden-states(self-attention 블록과 cross-attention 블록의 key 및 value). 일반적으로 이는 past_key_values 디코딩의 이전 단계에서 모델이 반환한 use_cache=True 또는 config.use_cache=True.

    입력으로 Cache 인스턴스만 허용되며, kv cache 가이드를 참고하세요. past_key_values가 전달되지 않으면 기본적으로 DynamicCache가 초기화됩니다.

    모델은 입력으로 제공된 것과 동일한 캐시 형식을 출력합니다.

    past_key_values를 사용하는 경우, 이 모델에 과거 키 값 상태가 제공되지 않은 input_ids만 입력해야 하며, 이때의 shape은 (batch_size, unprocessed_length)입니다. shape이 (batch_size, sequence_length)인 전체 input_ids를 입력하지 않습니다.

  • decoder_inputs_embeds (tuple[torch.Tensor] 형태가 (batch_size, target_sequence_length, hidden_size), 선택 사항) — 선택적으로 decoder_input_ids 대신에 임베딩된 표현을 직접 전달할 수 있습니다. past_key_values 이 사용되면, 선택적으로 마지막 decoder_inputs_embeds 만 입력하면 됩니다(참고: past_key_values). 모델의 내부 임베딩 조회 행렬보다 decoder_input_ids 인덱스를 관련 벡터로 변환하는 방식에 대해 더 많은 제어를 원할 때 유용합니다.

    decoder_input_ids와 decoder_inputs_embeds가 모두 설정되지 않은 경우, decoder_inputs_embeds는 inputs_embeds의 값을 가져옵니다.

  • decoder_position_ids (torch.LongTensor 형상 (batch_size, sequence_length), 선택 사항) — 입력 시퀀스 토큰의 위치 임베딩에서 각 토큰의 위치 인덱스입니다. 범위는 [0, config.n_positions - 1].

    포지션 ID란 무엇인가요?

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

반환값

Seq2SeqModelOutput 또는 tuple(torch.Tensor)

torch.Tensor의 튜플 또는 Seq2SeqModelOutput입니다. return_dict=False가 전달되거나 config.return_dict=False인 경우, 구성(WhisperConfig)과 입력에 따라 다양한 요소로 구성됩니다.

WhisperModel의 forward 메서드는 __call__ 특수 메서드를 오버라이드합니다.

이 함수 내에서 forward pass의 레시피를 정의해야 하지만, 이후에는 이 함수 대신 Module 인스턴스를 호출해야 합니다. 전자는 전처리 및 후처리 단계를 실행하는 것을 처리하는 반면, 후자는 이를 조용히 무시하기 때문입니다.

  • last_hidden_state (torch.Tensor, shape (batch_size, sequence_length, hidden_size)) — 모델의 decoder 마지막 레이어 출력의 hidden-state 시퀀스입니다.

    past_key_values가 사용되면, (batch_size, 1, hidden_size) 형태의 시퀀스의 마지막 hidden-state만 출력됩니다.

  • past_key_values (EncoderDecoderCache, 선택 사항, use_cache=True가 전달되었거나 config.use_cache=True인 경우 반환됨) — EncoderDecoderCache 인스턴스입니다. 자세한 내용은 kv 캐시 가이드를 참고하세요.

    순차적 디코딩을 가속화하는 데 사용할 수 있는 사전 계산된 hidden-states(셀프 어텐션 블록과 크로스 어텐션 블록의 key 및 value)를 포함합니다(입력 past_key_values 참조).

  • decoder_hidden_states (tuple(torch.Tensor), 선택 사항, output_hidden_states=True가 전달되거나 config.output_hidden_states=True인 경우 반환됨) — torch.Tensor의 튜플(모델에 임베딩 레이어가 있는 경우 임베딩의 출력에 대한 것 1개 + 각 레이어의 출력에 대한 것 1개)로, 모양은 (batch_size, sequence_length, hidden_size)입니다.

    각 레이어 출력의 decoder hidden-states와 선택적인 초기 embedding 출력

  • decoder_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 이후의 decoder의 attention 가중치입니다.

  • cross_attentions (tuple(torch.Tensor), 선택 사항, output_attentions=True가 전달되었거나 config.output_attentions=True인 경우 반환됨) — 각 레이어마다 하나씩 포함된 torch.Tensor의 튜플로, 모양은 (batch_size, num_heads, sequence_length, sequence_length)입니다.

    decoder의 cross-attention 레이어에서 attention softmax를 적용한 후, cross-attention 헤드에서 가중 평균을 계산하는 데 사용되는 attention 가중치입니다.

  • encoder_last_hidden_state (torch.Tensor, shape (batch_size, sequence_length, hidden_size), 선택 사항) — 모델 인코더의 마지막 레이어 출력에서 생성된 hidden-state 시퀀스입니다.

  • encoder_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와 선택적인 초기 임베딩 출력.

  • encoder_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 가중치입니다.

예:

>>> import torch
>>> from transformers import AutoFeatureExtractor, WhisperModel
>>> from datasets import load_dataset

>>> model = WhisperModel.from_pretrained("openai/whisper-base")
>>> feature_extractor = AutoFeatureExtractor.from_pretrained("openai/whisper-base")
>>> ds = load_dataset("hf-internal-testing/librispeech_asr_dummy", "clean", split="validation")
>>> inputs = feature_extractor(ds[0]["audio"]["array"], return_tensors="pt")
>>> input_features = inputs.input_features
>>> decoder_input_ids = torch.tensor([[1, 1]]) * model.config.decoder_start_token_id
>>> last_hidden_state = model(input_features, decoder_input_ids=decoder_input_ids).last_hidden_state
>>> list(last_hidden_state.shape)
[1, 2, 512]

_mask_input_features

< >

( input_features: Tensorattention_mask: typing.Optional[torch.LongTensor] = None )

SpecAugment에 따라 시간 축 및/또는 특징 축을 따라 추출된 특징을 가립니다.

WhisperForConditionalGeneration

클래스 transformers.WhisperForConditionalGeneration

< >

( config: WhisperConfig )

매개변수

  • config (WhisperConfig) — 모델의 모든 매개변수를 포함하는 모델 구성 클래스입니다. 구성 파일로 초기화하는 것은 모델과 관련된 가중치를 로드하지 않으며, 구성 정보만 로드합니다. 모델 가중치를 로드하려면 from_pretrained() 메서드를 확인하세요.

언어 모델링 헤드가 포함된 Whisper 모델. 자동 음성 인식에 사용할 수 있습니다.

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

이 모델은 또한 PyTorch torch.nn.Module의 하위 클래스입니다. 일반적인 PyTorch Module처럼 사용하며, 일반적인 사용법 및 동작과 관련된 모든 사항은 PyTorch 문서를 참조하세요.

forward

< >

( input_features: typing.Optional[torch.Tensor] = Noneattention_mask: typing.Optional[torch.LongTensor] = Nonedecoder_input_ids: typing.Optional[torch.LongTensor] = Nonedecoder_attention_mask: typing.Optional[torch.LongTensor] = Noneencoder_outputs: tuple[tuple[torch.Tensor]] | None = Nonepast_key_values: transformers.cache_utils.Cache | None = Nonedecoder_inputs_embeds: tuple[torch.Tensor] | None = Nonedecoder_position_ids: tuple[torch.LongTensor] | None = Nonelabels: typing.Optional[torch.LongTensor] = Noneuse_cache: bool | None = None**kwargs ) → Seq2SeqLMOutput or tuple(torch.Tensor)

매개변수

  • input_features (torch.Tensor, shape (batch_size, sequence_length, feature_dim), 선택 사항) — 입력 오디오 특징에 해당하는 텐서입니다. 오디오 특징은 WhisperFeatureExtractor를 사용하여 얻을 수 있습니다. 자세한 내용은 WhisperFeatureExtractor.call()를 참조하세요 (WhisperProcessor는 오디오 처리에 WhisperFeatureExtractor를 사용합니다).
  • attention_mask (torch.LongTensor 형상이 (batch_size, sequence_length), 선택 사항) — 패딩 토큰 인덱스에 대한 attention을 수행하지 않도록 하는 마스크. [0, 1]에서 선택된 마스크 값: 마스크되지 않은 토큰은 1, 마스크된 토큰은 0. attention mask란 무엇인가요? [0, 1]:
    • 마스크되지 않은 토큰에 대해 1
    • 마스크된 토큰에 대해 0

    어텐션 마스크란 무엇인가요?

  • decoder_input_ids (torch.LongTensor 형상 (batch_size, target_sequence_length), 선택 사항) — 어휘에서 디코더 입력 시퀀스 토큰의 인덱스입니다. WhisperTokenizer를 사용하여 인덱스를 가져올 수 있습니다. 자세한 내용은 PreTrainedTokenizer.encode() 및 PreTrainedTokenizer.call()를 참조하세요. 디코더 입력 ID란 무엇인가요? Whisper는 decoder_input_ids 생성의 시작 토큰으로 decoder_start_token_id를 사용합니다. past_key_values를 사용하는 경우, 선택적으로 마지막 decoder_input_ids만 입력하면 됩니다(past_key_values 참조).

    WhisperTokenizer를 사용하여 인덱스를 얻을 수 있습니다. 자세한 내용은 PreTrainedTokenizer.encode() 및 PreTrainedTokenizer.call()를 참고하세요.

    디코더 입력 ID란 무엇인가요?

    Whisper는 decoder_input_ids 생성의 시작 토큰으로 decoder_start_token_id를 사용합니다. past_key_values를 사용하는 경우, 선택적으로 마지막 decoder_input_ids만 입력하면 됩니다(past_key_values 참조).

  • decoder_attention_mask (torch.LongTensor 다음 shape의 (batch_size, target_sequence_length), 선택 사항) — 기본 동작: decoder_input_ids. 의 pad 토큰을 무시하는 텐서를 생성합니다. 기본값으로 Causal mask도 사용됩니다. 패딩 동작을 변경하려면 modeling_whisper._prepare_decoder_attention_mask를 읽고 필요에 맞게 수정하세요. 기본 전략에 대한 자세한 내용은 BART 논문에서 다이어그램 1을 참고하세요.

    패딩 동작을 변경하려면 modeling_whisper._prepare_decoder_attention_mask를 읽고 필요에 맞게 수정해야 합니다. 기본 전략에 대한 자세한 내용은 BART 논문의 다이어그램 1을 참고하세요.

  • encoder_outputs (tuple[tuple[torch.Tensor]], 선택 사항) — (last_hidden_state, 선택 사항: hidden_states, 선택 사항: attentions)으로 구성된 Tuple입니다. last_hidden_state의 shape은 (batch_size, sequence_length, hidden_size), 선택 사항)이며, 인코더의 마지막 레이어 출력에서 생성된 hidden-states의 시퀀스입니다. 디코더의 cross-attention에 사용됩니다.
  • past_key_values (~cache_utils.Cache, 선택 사항) — 순차적 디코딩을 가속화할 수 있는 사전 계산된 hidden-states(self-attention 블록과 cross-attention 블록의 key 및 value). 일반적으로 이는 past_key_values 디코딩의 이전 단계에서 모델이 반환한 use_cache=True 또는 config.use_cache=True.

    입력으로 Cache 인스턴스만 허용되며, kv cache 가이드를 참고하세요. past_key_values가 전달되지 않으면 기본적으로 DynamicCache가 초기화됩니다.

    모델은 입력으로 제공된 것과 동일한 캐시 형식을 출력합니다.

    past_key_values를 사용하는 경우, 이 모델에 과거 키 값 상태가 제공되지 않은 input_ids만 입력해야 하며, 이때의 shape은 (batch_size, unprocessed_length)입니다. shape이 (batch_size, sequence_length)인 전체 input_ids를 입력하지 않습니다.

  • decoder_inputs_embeds (tuple[torch.Tensor] 형태가 (batch_size, target_sequence_length, hidden_size), 선택 사항) — 선택적으로 decoder_input_ids 대신에 임베딩된 표현을 직접 전달할 수 있습니다. past_key_values 이 사용되면, 선택적으로 마지막 decoder_inputs_embeds 만 입력하면 됩니다(참고: past_key_values). 모델의 내부 임베딩 조회 행렬보다 decoder_input_ids 인덱스를 관련 벡터로 변환하는 방식에 대해 더 많은 제어를 원할 때 유용합니다.

    decoder_input_ids와 decoder_inputs_embeds가 모두 설정되지 않은 경우, decoder_inputs_embeds는 inputs_embeds의 값을 가져옵니다.

  • decoder_position_ids (torch.LongTensor 형상 (batch_size, sequence_length), 선택 사항) — 입력 시퀀스 토큰의 위치 임베딩에서 각 토큰의 위치 인덱스입니다. 범위는 [0, config.n_positions - 1].

    포지션 ID란 무엇인가요?

  • labels (torch.LongTensor, shape (batch_size, sequence_length), 선택 사항) — 언어 모델링 손실을 계산하는 데 사용되는 라벨입니다. 인덱스는 [0, ..., config.vocab_size] 범위 내의 값이거나 -100이어야 합니다(input_ids docstring 참조). 인덱스가 -100으로 설정된 토큰은 무시(마스크)되며, 손실은 [0, ..., config.vocab_size] 범위의 라벨을 가진 토큰에 대해서만 계산됩니다. sequence_length는 config.max_target_positions보다 작거나 같아야 합니다.
  • use_cache (bool, 선택 사항) — True로 설정하면 past_key_values 키 값 상태가 반환되며, 디코딩 속도를 높이는 데 사용할 수 있습니다( past_key_values 참조).

반환값

Seq2SeqLMOutput 또는 tuple(torch.Tensor)

torch.Tensor의 튜플 또는 Seq2SeqLMOutput입니다. return_dict=False가 전달되었거나 config.return_dict=False인 경우, 구성(WhisperConfig)과 입력에 따라 다양한 요소를 포함합니다.

WhisperForConditionalGeneration의 forward 메서드는 __call__ 특수 메서드를 오버라이드합니다.

이 함수 내에서 forward pass의 레시피를 정의해야 하지만, 이후에는 이 함수 대신 Module 인스턴스를 호출해야 합니다. 전자는 전처리 및 후처리 단계를 실행하는 것을 처리하는 반면, 후자는 이를 조용히 무시하기 때문입니다.

  • loss (torch.Tensor, shape (1,), 선택 사항, labels이 제공될 때 반환됨) — 언어 모델링 손실.

  • logits (torch.Tensor, shape (batch_size, sequence_length, config.vocab_size)) — 언어 모델링 헤드에서 생성된 예측 점수(SoftMax 적용 전 각 어휘 토큰에 대한 점수).

  • past_key_values (EncoderDecoderCache, 선택 사항, use_cache=True가 전달되었거나 config.use_cache=True인 경우 반환됨) — EncoderDecoderCache 인스턴스입니다. 자세한 내용은 kv 캐시 가이드를 참고하세요.

    순차적 디코딩을 가속화하는 데 사용할 수 있는 사전 계산된 hidden-states(셀프 어텐션 블록과 크로스 어텐션 블록의 key 및 value)를 포함합니다(입력 past_key_values 참조).

  • decoder_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와 초기 임베딩 출력을 더한 값.

  • decoder_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 이후의 decoder의 attention 가중치입니다.

  • cross_attentions (tuple(torch.Tensor), 선택 사항, output_attentions=True가 전달되었거나 config.output_attentions=True인 경우 반환됨) — 각 레이어마다 하나씩 포함된 torch.Tensor의 튜플로, 모양은 (batch_size, num_heads, sequence_length, sequence_length)입니다.

    decoder의 cross-attention 레이어에서 attention softmax를 적용한 후, cross-attention 헤드에서 가중 평균을 계산하는 데 사용되는 attention 가중치입니다.

  • encoder_last_hidden_state (torch.Tensor, shape (batch_size, sequence_length, hidden_size), 선택 사항) — 모델 인코더의 마지막 레이어 출력에서 생성된 hidden-state 시퀀스입니다.

  • encoder_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와 초기 임베딩 출력을 더한 값.

  • encoder_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 가중치입니다.

예:

>>> import torch
>>> from transformers import AutoProcessor, WhisperForConditionalGeneration
>>> from datasets import load_dataset

>>> processor = AutoProcessor.from_pretrained("openai/whisper-tiny.en")
>>> model = WhisperForConditionalGeneration.from_pretrained("openai/whisper-tiny.en")

>>> ds = load_dataset("hf-internal-testing/librispeech_asr_dummy", "clean", split="validation")

>>> inputs = processor(ds[0]["audio"]["array"], return_tensors="pt")
>>> input_features = inputs.input_features

>>> generated_ids = model.generate(inputs=input_features)

>>> transcription = processor.batch_decode(generated_ids, skip_special_tokens=True)[0]
>>> transcription
' Mr. Quilter is the apostle of the middle classes, and we are glad to welcome his gospel.'

generate

< >

( input_features: typing.Optional[torch.Tensor] = Nonegeneration_config: transformers.generation.configuration_utils.GenerationConfig | None = Nonelogits_processor: transformers.generation.logits_process.LogitsProcessorList | None = Nonestopping_criteria: transformers.generation.stopping_criteria.StoppingCriteriaList | None = Noneprefix_allowed_tokens_fn: collections.abc.Callable[[int, torch.Tensor], list[int]] | None = Nonesynced_gpus: bool = Falsereturn_timestamps: bool | None = Nonetask: str | None = Nonelanguage: str | list[str] | None = Noneis_multilingual: bool | None = Noneprompt_ids: typing.Optional[torch.Tensor] = Noneprompt_condition_type: str | None = Nonecondition_on_prev_tokens: bool | None = Nonetemperature: float | tuple[float, ...] | None = Nonecompression_ratio_threshold: float | None = Nonelogprob_threshold: float | None = Noneno_speech_threshold: float | None = Nonenum_segment_frames: int | None = Noneattention_mask: typing.Optional[torch.Tensor] = Nonetime_precision: float = 0.02time_precision_features: float = 0.01return_token_timestamps: bool | None = Nonereturn_segments: bool = Falsereturn_dict_in_generate: bool | None = Noneforce_unique_generate_call: bool | None = Nonemonitor_progress: collections.abc.Callable[[torch.Tensor], None] | None = None**kwargs ) → ModelOutput or dict[str, Any] or torch.LongTensor

매개변수

  • input_features (torch.Tensor, shape (batch_size, feature_size, sequence_length), 선택 사항) — 원시 음성 웨이브폼에서 추출한 log-mel feature의 float 값입니다. 원시 음성 웨이브폼은 .flac 또는 .wav 오디오 파일을 list[float], numpy.ndarray 또는 torch.Tensor 타입의 배열로 로드하여 얻을 수 있으며, 예를 들어 torchcodec 라이브러리(pip install torchcodec)나 soundfile 라이브러리(pip install soundfile)를 사용할 수 있습니다. input_features 배열을 준비하려면, mel feature 추출, padding, 그리고 torch.Tensor 타입의 텐서 변환을 위해 AutoFeatureExtractor를 사용해야 합니다. 자세한 내용은 call()를 참조하세요.
  • generation_config (GenerationConfig, 선택) — 생성 호출의 기본 파라미터화로 사용할 생성 구성입니다. **kwargs 를 통해 generate에 전달되며 generation_config의 속성과 일치하는 값은 해당 속성을 덮어씁니다. generation_config가 제공되지 않으면 기본값이 사용되며, 이 기본값은 다음 로딩 우선순위를 따릅니다: 1) generation_config.json 모델 파일이 존재하는 경우 해당 파일에서; 2) 모델 구성에서. 명시되지 않은 파라미터는 GenerationConfig의 기본값을 상속받으므로, 생성을 파라미터화하려면 해당 문서에서 기본값을 확인해야 합니다.
  • logits_processor (LogitsProcessorList, 선택) — 인자와 generation config에서 기본으로 생성되는 logits processor를 보완하는 사용자 정의 logits processor입니다. 인자나 generation config로 이미 생성된 logit processor를 전달하면 오류가 발생합니다. 이 기능은 고급 사용자를 위해 제공됩니다.
  • stopping_criteria (StoppingCriteriaList, 선택 사항) — 인자와 generation config에서 기본으로 생성되는 stopping criteria를 보완하는 사용자 정의 stopping criteria입니다. 인자 또는 generation config로 이미 생성된 stopping criteria가 전달되면 오류가 발생합니다. 이 기능은 고급 사용자를 대상으로 합니다.
  • prefix_allowed_tokens_fn (Callable[[int, torch.Tensor], list[int]], 선택) — 지정된 경우, 이 함수는 각 단계에서 beam search를 허용된 토큰으로만 제한합니다. 지정되지 않으면 제약이 적용되지 않습니다. 이 함수는 두 개의 인수를 받습니다: 배치 ID batch_id와 input_ids. 배치 ID batch_id와 이전에 생성된 토큰 inputs_ids에 조건부인 다음 생성 단계에 허용되는 토큰의 목록을 반환해야 합니다. 이 인수는 Autoregressive Entity Retrieval에 설명된 바와 같이 접두사에 조건부인 제약 생성에 유용합니다.
  • synced_gpus (bool, 선택 사항, 기본값 False) — FullyShardedDataParallel 및 DeepSpeed ZeRO Stage 3에서 데드락을 방지하기 위해 max_length까지 while 루프를 계속 실행할지 여부.
  • return_timestamps (bool, 선택 사항) — 텍스트와 함께 타임스탬프를 반환할지 여부입니다. 이 설정은 WhisperTimestampsLogitsProcessor를 활성화합니다. 30초보다 긴 오디오의 경우 return_timestamps=True로 설정해야 합니다.
  • task (str, 선택 사항) — 생성에 사용할 태스크로, “translate” 또는 “transcribe” 중 하나입니다.
  • language (str 또는 str 리스트, 선택 사항) — 생성에 사용할 언어 토큰으로, <|en|>, en 또는 english 형식 중 하나를 사용할 수 있습니다. 배치 생성의 경우 언어 토큰 리스트를 전달할 수 있습니다. 사용 가능한 모든 언어 토큰은 model.generation_config.lang_to_id 사전에서 확인할 수 있습니다.
  • is_multilingual (bool, 선택 사항) — 모델이 다국어인지 여부.
  • prompt_ids (torch.Tensor, 선택 사항) — get_prompt_ids()에 텍스트를 전달하여 생성된 토큰 ID의 Rank-1 텐서로, 각 청크에 프롬프트로 제공됩니다. 이를 통해 전사 컨텍스트를 제공하거나 “프롬프트 엔지니어링”하여, 예를 들어 맞춤 어휘나 고유명사가 더 정확하게 예측될 가능성을 높일 수 있습니다. decoder_start_token_id와 함께 사용할 수 없으며, 이 값을 덮어쓰기 때문입니다.
  • prompt_condition_type (str, 선택 사항) — 긴 형식의 전사(long-form transcription)에만 관련이 있습니다. prompt_ids의 조건 유형입니다. ‘first-segment’는 첫 번째 세그먼트만 prompt_ids에 조건부임을 의미합니다. ‘all-segments’는 각 세그먼트가 prompt_ids에 조건부임을 의미합니다. ‘all-segments’의 경우 condition_on_prev_tokens를 활성화해야 합니다. 기본값은 ‘first-segment’입니다. 짧은 형식의 전사(short-term transcription)의 경우 ‘first-segment’만 가능합니다.
  • condition_on_prev_tokens (bool, 선택) — 긴 형식의 전사(long-form transcription)에만 관련이 있습니다. 각 세그먼트를 이전 세그먼트에 조건부로 처리할지 여부를 지정합니다. Whisper 논문에서 보여주듯, 이를 통해 성능을 향상시킬 수 있습니다.
  • temperature (float 또는 float 목록, 선택 사항) — 생성에 사용할 temperature입니다. 단일 float 값을 전달하고 do_sample=True를 설정하면 샘플링을 사용한 생성이 활성화됩니다. 긴 형식의 전사(long-form transcription)의 경우, (0.0, 0.2, 0.4, 0.6, 0.8, 1.0)과 같은 float 값 목록을 전달하여 temperature fallback을 활성화할 수 있습니다. Whisper 논문에 제시된 바와 같이, 이를 통해 성능을 향상시킬 수 있습니다.
  • compression_ratio_threshold (float, 선택) — 긴 형식의 전사(long-form transcription)에만 관련이 있습니다. 값이 정의된 경우 각 세그먼트의 zlib 압축률이 계산됩니다. 특정 세그먼트의 압축률이 compression_ratio_threshold보다 높으면 temperature fallback이 활성화됩니다. 즉, 생성된 세그먼트가 폐기되고 더 높은 temperature를 사용하여 생성이 반복됩니다. 이 기능의 근거는 압축률이 매우 높은 세그먼트는 반복(repetition)이 많이 발생한다는 점입니다. temperature를 높여 무작위성을 더 주입함으로써 원치 않는 반복을 줄일 수 있습니다. compression_ratio_threshold가 정의된 경우 temperature가 값의 리스트인지 확인하십시오. compression_ratio_threshold의 일반적인 값은 1.35입니다. Whisper 논문에서 보여주듯, 이를 통해 성능을 향상시킬 수 있습니다.
  • logprob_threshold (float, 선택 사항) — 긴 형식의 전사(long-form transcription)에만 관련이 있습니다. 값이 정의된 경우, 각 세그먼트의 평균 로그 확률(log-probability)이 계산됩니다. 특정 세그먼트의 로그 확률이 logprob_threshold보다 낮으면 temperature fallback이 활성화됩니다. 생성된 세그먼트가 폐기되고, 더 높은 temperature를 사용하여 생성이 반복됩니다. 이 기능의 직관은, 낮은 로그 확률을 가진 세그먼트는 temperature를 높여 무작위성을 더 주입함으로써 개선될 수 있다는 것입니다. logprob_threshold가 정의된 경우 temperature가 값의 리스트인지 확인하십시오. logprob_threshold의 일반적인 값은 -1.0입니다. Whisper 논문에서 보여주었듯이, 이를 통해 성능을 향상시킬 수 있습니다.
  • no_speech_threshold (float, 선택) — 긴 형식의 전사(long-form transcription)에만 관련이 있습니다. 정의된 경우, “no-speech” 토큰과 logprob_threshold를 조합하여 해당 세그먼트가 무음만 포함하는지 여부를 결정합니다. 이 경우 해당 세그먼트의 전사는 건너뜁니다. Whisper 논문에서 보여준 바와 같이, 이를 통해 성능을 향상시킬 수 있습니다.
  • num_segment_frames (int, 선택 사항) — 단일 세그먼트를 구성하는 프레임 수입니다. 정의되지 않은 경우, num_segment_frames는 모델의 스트라이드와 최대 입력 길이의 곱으로 기본 설정됩니다.
  • attention_mask (torch.Tensor, 선택 사항) — attention_mask는 배치 크기가 1보다 큰 경우 장문 전사(long-form transcription)를 수행할 때 전달해야 합니다.
  • time_precision (int, 선택 사항, 기본값 0.02) — 출력 토큰의 지속 시간(초). 예를 들어 0.02는 생성된 토큰 하나가 평균적으로 20 ms를 차지한다는 의미입니다.
  • time_precision_features (int, 선택 사항, 기본값 0.01) — 초 단위로 표현된 특징 프레임의 지속 시간입니다.
  • return_token_timestamps (bool, 선택) — 텍스트와 함께 토큰 수준의 타임스탬프를 반환할지 여부입니다. 이 옵션은 return_timestamps 옵션과 함께 사용하거나 단독으로 사용할 수 있습니다. 단어 수준의 타임스탬프를 얻으려면 토크나이저를 사용하여 토큰을 단어로 그룹화하세요.
  • return_segments (bool, 선택 사항, 기본값 False) — 모든 세그먼트의 목록을 추가로 반환할지 여부입니다. 이 옵션은 장문 전사(long-form transcription)를 수행할 때만 활성화할 수 있습니다.
  • return_dict_in_generate (bool, 선택, 기본값 False) — 생성된 토큰만 반환하는 대신 ModelOutput를 반환할지 여부입니다. 긴 형식의 전사(long-form transcription)를 수행할 때, return_dict_in_generate는 return_segments가 True로 설정된 경우에만 활성화할 수 있습니다. 이 경우 각 세그먼트의 생성 출력이 해당 세그먼트에 추가됩니다.
  • force_unique_generate_call (bool, 선택) — 기저 GenerationMixin의 generate() 메서드에 대한 호출을 고유한 호출로 강제할지 여부입니다. 이는 assisted decoding 및 테스트 목적으로, generate()에 대한 호출이 단 한 번만 이루어지도록 보장하여 decoder 입력 토큰 id와 eos 토큰 id가 반환되도록 하는 데 유용합니다.
  • monitor_progress (Callable[[torch.Tensor], None], 선택 사항) — 제공된 경우, 이 함수를 호출하여 오디오 전사 진행 상황을 보고할 수 있습니다. 이 함수는 n이 배치 크기인 (n, 2) 형태의 텐서 인자 p를 받습니다. p[i, 0]에는 배치 항목 i에 대해 현재 전사 중인 오디오 프레임의 인덱스가 포함되어 있습니다. p[i, 1]에는 배치 항목 i의 총 프레임 수가 포함되어 있습니다. 반환 값은 기대되지 않습니다.
  • kwargs (dict[str, Any], 선택) — generate_config의 즉석 파라미터화 및/또는 모델의 forward 함수로 전달되는 모델 특정 추가 kwargs입니다. 모델이 인코더-디코더 모델인 경우, 인코더 특정 kwargs에는 접두사를 붙이지 않고 디코더 특정 kwargs에는 decoder_ 접두사를 붙여야 합니다.

반환값

ModelOutput 또는 dict[str, Any] 또는 torch.LongTensor

다음 중 하나:

  • return_dict_in_generate=True이고 (return_timestamps=False 또는 force_unique_generate_call=True)인 경우, decoder 입력 id와 시퀀스 종료 id를 포함하는 ModelOutput
  • (return_dict_in_generate=True이고 return_timestamps=True인 경우) 또는 return_segments=True 또는 return_token_timestamps=True인 경우 dict[str, Any]
  • 디코더 입력 id와 시퀀스 종료 id를 제외한 모든 다른 경우, torch.LongTensor

가능한 ModelOutput 유형은 다음과 같습니다:

segments는 segment의 리스트(배치 요소당 하나의 리스트)입니다. segment는 start, end, tokens, idxs, result 키를 가진 딕셔너리입니다.

  • start: 세그먼트의 시작 타임스탬프.
  • end: 세그먼트의 종료 타임스탬프.
  • tokens: decoder input ids와 end of sequence id를 제외한 세그먼트의 토큰
  • idxs: result에 포함된 GenerationMixin의 generate() 기본 호출에서 해당 세그먼트의 tokens 시작(포함) 및 끝(제외) 인덱스.
  • result: generate()에 대한 GenerationMixin의 기본 호출 결과.

return_timestamps=True인 경우, return_dict_in_generate=True는 기본 GenerationMixin의 generate() 호출 각각에 적용되며, 출력은 각 segment의 result에 저장됩니다.

log-mel 입력 특징을 오토레그레시브 방식으로 생성된 토큰 id 시퀀스로 전사하거나 번역합니다.

대부분의 생성 제어 매개변수는 generation_config에 설정되며, 전달되지 않으면 모델의 기본 생성 구성으로 설정됩니다. generation_config의 항목은 generate()에 해당 매개변수를 전달하여 오버라이드할 수 있습니다. 예를 들어 .generate(inputs, num_beams=4, do_sample=True)와 같이 사용할 수 있습니다.

생성 전략 개요와 코드 예제는 다음 가이드를 참고하세요.

예:

  • Longform transcription: To transcribe or translate audios longer than 30 seconds, process the audio files without truncation and pass all mel features at once to generate. It is necessary to set return_timestamps=True. Indeed, long-form transcription uses a sequential algorithm based on timestamps predictions, with heuristics like compression ratio threshold, log probability threshold and temperature fallback. This algorithm is described in the the Whisper original paper, section 3.8. Long-form Transcription.
>>> import torch
>>> from transformers import AutoProcessor, WhisperForConditionalGeneration
>>> from datasets import load_dataset, Audio

>>> processor = AutoProcessor.from_pretrained("openai/whisper-tiny.en")
>>> model = WhisperForConditionalGeneration.from_pretrained("openai/whisper-tiny.en")
>>> model.cuda()
>>> # load audios > 30 seconds
>>> ds = load_dataset("distil-whisper/meanwhile", "default")["test"]
>>> # resample to 16kHz
>>> ds = ds.cast_column("audio", Audio(sampling_rate=16000))
>>> # take first 8 audios and retrieve array
>>> audio = ds[:8]["audio"]
>>> audio = [x["array"] for x in audio]

>>> # make sure to NOT truncate the input audio, to return the `attention_mask` and to pad to the longest audio
>>> inputs = processor(audio, return_tensors="pt", truncation=False, padding="longest", return_attention_mask=True, sampling_rate=16_000)
>>> inputs = inputs.to("cuda", torch.float32)

>>> # transcribe audio to ids
>>> generated_ids = model.generate(**inputs, return_timestamps=True)

>>> transcription = processor.batch_decode(generated_ids, skip_special_tokens=True)
>>> transcription[0]
" Folks, if you watch the show, you know, I spent a lot of time right over there. Patiently and astutely scrutinizing the boxwood and mahogany chest set of the day's biggest stories developing the central headline pawns, definitely maneuvering an oso topical night to F6, fainting a classic Sicilian, nade door variation on the news, all the while seeing eight moves deep and patiently marshalling the latest press releases into a fisher's shows in Lip Nitsky attack that culminates in the elegant lethal slow-played, all-passant checkmate that is my nightly monologue. But sometimes, sometimes, folks, I. CHEERING AND APPLAUSE Sometimes I startle away, cubside down in the monkey bars of a condemned playground on a super fun site. Get all hept up on goofballs. Rummage that were discarded tag bag of defective toys. Yank out a fist bowl of disembodied doll limbs, toss them on a stained kid's place mat from a defunct dennies. set up a table inside a rusty cargo container down by the Wharf and challenged toothless drifters to the godless bughouse blitz of tournament that is my segment. Meanwhile."

monitor_progress 콜백은 전사 진행 상황을 모니터링하는 데 사용할 수 있습니다:

>>> from tqdm import tqdm

>>> # prepare inputs like above

>>> # define a callback to monitor the progress of the transcription.
>>> with tqdm(desc="Progress") as pbar:
>>>     def monitor_progress(p_batch):
>>>         i = torch.argmax(p_batch[:, 1])
>>>         p = p_batch[i].detach().cpu()
>>>         pbar.total = int(p[1])
>>>         pbar.n = int(p[0])
>>>         pbar.update()

>>>     # transcribe audio to ids
>>>     generated_ids = model.generate(**inputs, return_timestamps=True, monitor_progress=monitor_progress)

>>> transcription = processor.batch_decode(generated_ids, skip_special_tokens=True)
>>> transcription[0]
Progress:  95%|█████████████████████████████████████████████████████████████████████████████████████████████████▎    | 8497/8901 [00:04<00:00, 2052.79it/s]
" Folks, if you watch the show, you know, I spent a lot of time right over there. Patiently and astutely scrutinizing the boxwood and mahogany chest set of the day's biggest stories developing the central headline pawns, definitely maneuvering an oso topical night to F6, fainting a classic Sicilian, nade door variation on the news, all the while seeing eight moves deep and patiently marshalling the latest press releases into a fisher's shows in Lip Nitsky attack that culminates in the elegant lethal slow-played, all-passant checkmate that is my nightly monologue. But sometimes, sometimes, folks, I. CHEERING AND APPLAUSE Sometimes I startle away, cubside down in the monkey bars of a condemned playground on a super fun site. Get all hept up on goofballs. Rummage that were discarded tag bag of defective toys. Yank out a fist bowl of disembodied doll limbs, toss them on a stained kid's place mat from a defunct dennies. set up a table inside a rusty cargo container down by the Wharf and challenged toothless drifters to the godless bughouse blitz of tournament that is my segment. Meanwhile."
  • 짧은 형식 전사: 입력된 mel 특징이 30초 이하인 경우, 다음 두 가지 가능성이 있습니다:
    • return_timestamps=False: 전체 오디오가 GenerationMixin의 generate()를 한 번 호출하여 전사됩니다.
    • return_timestamps=True: 오디오는 장문 전사와 동일한 로직을 사용하여 전사됩니다.
>>> import torch
>>> from transformers import AutoProcessor, WhisperForConditionalGeneration
>>> from datasets import load_dataset

>>> processor = AutoProcessor.from_pretrained("openai/whisper-tiny.en")
>>> model = WhisperForConditionalGeneration.from_pretrained("openai/whisper-tiny.en")

>>> ds = load_dataset("hf-internal-testing/librispeech_asr_dummy", "clean", split="validation")

>>> inputs = processor(ds[0]["audio"]["array"], return_tensors="pt")
>>> input_features = inputs.input_features

>>> generated_ids = model.generate(inputs=input_features)

>>> transcription = processor.batch_decode(generated_ids, skip_special_tokens=True)[0]
>>> transcription
' Mr. Quilter is the apostle of the middle classes, and we are glad to welcome his gospel.'

WhisperForCausalLM

클래스 transformers.WhisperForCausalLM

< >

( config: WhisperConfig )

매개변수

  • config (WhisperConfig) — 모델의 모든 매개변수를 포함하는 모델 구성 클래스입니다. 구성 파일로 초기화하는 것은 모델과 관련된 가중치를 로드하지 않으며, 구성 정보만 로드합니다. 모델 가중치를 로드하려면 from_pretrained() 메서드를 확인하세요.

선형 레이어(입력 임베딩과 가중치가 공유됨)로 구성된 언어 모델링 헤드가 위에 있는 Whisper decoder

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

이 모델은 또한 PyTorch torch.nn.Module의 하위 클래스입니다. 일반적인 PyTorch Module처럼 사용하며, 일반적인 사용법 및 동작과 관련된 모든 사항은 PyTorch 문서를 참조하세요.

forward

< >

( input_ids: typing.Optional[torch.LongTensor] = Noneattention_mask: typing.Optional[torch.Tensor] = Noneencoder_outputs: tuple[torch.Tensor] | None = Nonepast_key_values: transformers.cache_utils.Cache | None = Noneinputs_embeds: typing.Optional[torch.Tensor] = Nonelabels: typing.Optional[torch.LongTensor] = Noneuse_cache: bool | None = None**kwargs ) → CausalLMOutputWithCrossAttentions or tuple(torch.Tensor)

매개변수

  • input_ids (torch.LongTensor 형상이 (batch_size, sequence_length), 선택 사항) — 어휘(input vocabulary)에서 입력 시퀀스 토큰의 인덱스입니다. 기본적으로 패딩은 무시됩니다.

    AutoTokenizer를 사용하여 인덱스를 얻을 수 있습니다. 자세한 내용은 PreTrainedTokenizer.encode() 및 PreTrainedTokenizer.call()를 참조하세요.

    입력 ID란 무엇인가요?

  • attention_mask (torch.Tensor 형상이 (batch_size, sequence_length), 선택 사항) — 패딩 토큰 인덱스에 대한 attention을 수행하지 않도록 방지하는 마스크. [0, 1]에서 선택된 마스크 값: 마스크되지 않은 토큰은 1, 마스크된 토큰은 0. attention mask란 무엇인가요? [0, 1]:
    • 마스크되지 않은 토큰에 대해 1
    • 마스크된 토큰에 대해 0

    어텐션 마스크란 무엇인가요?

  • encoder_outputs (torch.Tensor, shape (batch_size, sequence_length, hidden_size), 선택 사항) — 인코더의 마지막 레이어 출력에서 생성된 hidden-states 시퀀스입니다. 모델이 decoder로 구성된 경우 cross-attention에 사용됩니다.
  • past_key_values (~cache_utils.Cache, 선택 사항) — 순차적 디코딩을 가속화할 수 있는 사전 계산된 hidden-states(self-attention 블록과 cross-attention 블록의 key 및 value). 일반적으로 이는 past_key_values 디코딩의 이전 단계에서 모델이 반환한 use_cache=True 또는 config.use_cache=True.

    입력으로 Cache 인스턴스만 허용되며, kv cache 가이드를 참고하세요. past_key_values가 전달되지 않으면 기본적으로 DynamicCache가 초기화됩니다.

    모델은 입력으로 제공된 것과 동일한 캐시 형식을 출력합니다.

    past_key_values를 사용하는 경우, 이 모델에 과거 키 값 상태가 제공되지 않은 input_ids만 입력해야 하며, 이때의 shape은 (batch_size, unprocessed_length)입니다. shape이 (batch_size, sequence_length)인 전체 input_ids를 입력하지 않습니다.

  • inputs_embeds (torch.Tensor, shape (batch_size, sequence_length, hidden_size), 선택) — input_ids를 전달하는 대신 임베딩 표현을 직접 전달할 수 있습니다. 이는 모델 내부의 임베딩 조회 행렬보다 input_ids 인덱스를 관련 벡터로 변환하는 방식에 대해 더 세밀한 제어가 필요한 경우에 유용합니다.
  • labels (torch.LongTensor, shape (batch_size, sequence_length), 선택 사항) — 마스크 언어 모델링 손실을 계산하는 데 사용되는 라벨입니다. 인덱스는 [0, ..., config.vocab_size] 범위 내의 값이거나 -100이어야 합니다(input_ids docstring 참조). 인덱스가 -100으로 설정된 토큰은 무시(마스크)되며, 손실은 [0, ..., config.vocab_size] 범위의 라벨을 가진 토큰에 대해서만 계산됩니다.
  • use_cache (bool, 선택 사항) — True로 설정하면 past_key_values 키 값 상태가 반환되며, 디코딩 속도를 높이는 데 사용할 수 있습니다( past_key_values 참조).

반환값

CausalLMOutputWithCrossAttentions 또는 tuple(torch.Tensor)

torch.Tensor의 튜플 또는 CausalLMOutputWithCrossAttentions입니다. return_dict=False가 전달되거나 config.return_dict=False인 경우, 구성(WhisperConfig)과 입력에 따라 다양한 요소를 포함합니다.

WhisperForCausalLM의 forward 메서드는 __call__ 특수 메서드를 오버라이드합니다.

이 함수 내에서 forward pass의 레시피를 정의해야 하지만, 이후에는 이 함수 대신 Module 인스턴스를 호출해야 합니다. 전자는 전처리 및 후처리 단계를 실행하는 것을 처리하는 반면, 후자는 이를 조용히 무시하기 때문입니다.

  • loss (torch.Tensor, shape (1,), 선택 사항, labels이 제공될 때 반환됨) — 언어 모델링 손실(다음 토큰 예측용).

  • logits (torch.Tensor, shape (batch_size, sequence_length, config.vocab_size)) — 언어 모델링 헤드에서 생성된 예측 점수(SoftMax 적용 전 각 어휘 토큰에 대한 점수).

  • 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 가중치.

  • cross_attentions (tuple(torch.Tensor), 선택 사항, output_attentions=True가 전달되었거나 config.output_attentions=True인 경우 반환됨) — 각 레이어마다 하나씩 포함된 torch.Tensor의 튜플로, 모양은 (batch_size, num_heads, sequence_length, sequence_length)입니다.

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

  • past_key_values (Cache, 선택 사항, use_cache=True가 전달되었거나 config.use_cache=True인 경우 반환됨) — Cache 인스턴스입니다. 자세한 내용은 kv cache 가이드를 참고하세요.

    순차적 디코딩을 가속화하는 데 사용할 수 있는 사전 계산된 hidden-states(attention 블록의 key와 value)를 포함합니다(입력 past_key_values 참조).

예:

>>> from transformers import WhisperForCausalLM, WhisperForConditionalGeneration, WhisperProcessor
>>> import torch
>>> from datasets import load_dataset

>>> processor = WhisperProcessor.from_pretrained("openai/whisper-large-v2")
>>> model = WhisperForConditionalGeneration.from_pretrained("openai/whisper-large-v2")

>>> assistant_model = WhisperForCausalLM.from_pretrained("distil-whisper/distil-large-v2")

>>> ds = load_dataset("hf-internal-testing/librispeech_asr_dummy", "clean", split="validation")
>>> sample = ds[0]["audio"]
>>> input_features = processor(
...     sample["array"], sampling_rate=sample["sampling_rate"], return_tensors="pt"
... ).input_features

>>> predicted_ids = model.generate(input_features, assistant_model=assistant_model)

>>> # decode token ids to text
>>> transcription = processor.batch_decode(predicted_ids, skip_special_tokens=True)[0]
>>> transcription
' Mr. Quilter is the apostle of the middle classes and we are glad to welcome his gospel.'

WhisperForAudioClassification

class transformers.WhisperForAudioClassification

< >

( config: WhisperConfig )

매개변수

  • config (WhisperConfig) — 모델의 모든 매개변수를 포함하는 모델 구성 클래스입니다. 구성 파일로 초기화하는 것은 모델과 관련된 가중치를 로드하지 않으며, 구성 정보만 로드합니다. 모델 가중치를 로드하려면 from_pretrained() 메서드를 확인하세요.

SUPERB Keyword Spotting와 같은 작업을 위해, 풀링된 출력 위에 선형 레이어를 적용한 시퀀스 분류 헤드를 갖춘 Whisper Encoder Model

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

이 모델은 또한 PyTorch torch.nn.Module의 하위 클래스입니다. 일반적인 PyTorch Module처럼 사용하며, 일반적인 사용법 및 동작과 관련된 모든 사항은 PyTorch 문서를 참조하세요.

forward

< >

( input_features: typing.Optional[torch.LongTensor] = Noneencoder_outputs: tuple[tuple[torch.Tensor]] | None = Nonelabels: typing.Optional[torch.LongTensor] = None**kwargs ) → SequenceClassifierOutput or tuple(torch.Tensor)

매개변수

  • input_features (torch.LongTensor, shape (batch_size, sequence_length, feature_dim), 선택 사항) — 입력 오디오 특징에 해당하는 텐서입니다. 오디오 특징은 WhisperFeatureExtractor를 사용하여 얻을 수 있습니다. 자세한 내용은 WhisperFeatureExtractor.call()를 참조하세요 (WhisperProcessor는 오디오 처리에 WhisperFeatureExtractor를 사용합니다).
  • encoder_outputs (tuple[tuple[torch.Tensor]], 선택 사항) — (last_hidden_state, 선택 사항: hidden_states, 선택 사항: attentions)으로 구성된 Tuple입니다. last_hidden_state의 shape은 (batch_size, sequence_length, hidden_size), 선택 사항)이며, 인코더의 마지막 레이어 출력에서 생성된 hidden-states의 시퀀스입니다. 디코더의 cross-attention에 사용됩니다.
  • labels (torch.LongTensor, shape (batch_size,), 선택 사항) — 시퀀스 분류/회귀 손실을 계산하는 데 사용되는 라벨입니다. 인덱스는 [0, ..., config.num_labels - 1] 범위에 있어야 합니다. config.num_labels == 1인 경우 회귀 손실(Mean-Square loss)이 계산되고, config.num_labels > 1인 경우 분류 손실(Cross-Entropy)이 계산됩니다.

반환값

SequenceClassifierOutput 또는 tuple(torch.Tensor)

torch.Tensor의 튜플 또는 SequenceClassifierOutput입니다. return_dict=False가 전달되거나 config.return_dict=False인 경우, 구성(WhisperConfig)과 입력에 따라 다양한 요소로 구성됩니다.

WhisperForAudioClassification의 forward 메서드는 __call__ 특수 메서드를 오버라이드합니다.

이 함수 내에서 forward pass의 레시피를 정의해야 하지만, 이후에는 이 함수 대신 Module 인스턴스를 호출해야 합니다. 전자는 전처리 및 후처리 단계를 실행하는 것을 처리하는 반면, 후자는 이를 조용히 무시하기 때문입니다.

  • loss (torch.Tensor, shape (1,), 선택 사항, labels이 제공될 때 반환됨) — 분류 (또는 config.num_labels==1인 경우 회귀) 손실.

  • logits (torch.Tensor, shape (batch_size, config.num_labels)) — SoftMax 적용 전 분류(또는 config.num_labels==1인 경우 회귀) 점수.

  • 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 가중치.

예:

>>> import torch
>>> from transformers import AutoFeatureExtractor, WhisperForAudioClassification
>>> from datasets import load_dataset

>>> feature_extractor = AutoFeatureExtractor.from_pretrained("sanchit-gandhi/whisper-medium-fleurs-lang-id")
>>> model = WhisperForAudioClassification.from_pretrained("sanchit-gandhi/whisper-medium-fleurs-lang-id")

>>> ds = load_dataset("google/fleurs", "all", split="validation", streaming=True)
>>> sample = next(iter(ds))

>>> inputs = feature_extractor(
...     sample["audio"]["array"], sampling_rate=sample["audio"]["sampling_rate"], return_tensors="pt"
... )
>>> input_features = inputs.input_features

>>> with torch.no_grad():
...     logits = model(input_features).logits

>>> predicted_class_ids = torch.argmax(logits).item()
>>> predicted_label = model.config.id2label[predicted_class_ids]
>>> predicted_label
'Afrikaans'
Update on GitHub

←WavLM X-Codec→