Transformers documentation

Audio Flamingo 3

Transformers

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

Join the Hugging Face community

and get access to the augmented documentation experience

Collaborate on models, datasets and Spaces

Faster examples with accelerated inference

Switch between documentation themes

to get started

Mô hình này được công bố trên HF papers vào ngày 2025-07-10 và được đóng góp cho Hugging Face Transformers vào ngày 2025-11-12.

Audio Flamingo 3

Tổng quan

Audio Flamingo 3 (AF3) là một mô hình ngôn ngữ – âm thanh lớn hoàn toàn mã nguồn mở, được thiết kế để hiểu và suy luận một cách vững chắc về giọng nói, âm thanh môi trường và âm nhạc. AF3 kết hợp bộ mã hóa âm thanh kiểu Whisper với mô hình ngôn ngữ nhân quả và thực hiện tích hợp âm thanh – văn bản thay thế tại chỗ: bộ xử lý căn chỉnh các khung âm thanh sau pooling với một token placeholder chuyên dụng, và mô hình thay thế các vị trí token đó bằng các embedding âm thanh đã chiếu trong quá trình truyền tiến.

Checkpoint của model có sẵn tại: nvidia/audio-flamingo-3-hf

Điểm nổi bật:

Bộ mã hóa âm thanh thống nhất cho giọng nói, âm thanh và nhạc.
Hỗ trợ âm thanh dài thông qua phân khung và căn chỉnh sau khi pool (tối đa 10 phút). Mô hình xử lý âm thanh theo các khung 30 giây với giới hạn cứng là 20 khung (tổng cộng 10 phút). Âm thanh dài hơn 10 phút sẽ bị cắt bớt.
Nối hợp tất định (deterministic fusion) bảo toàn độ dài chuỗi bằng cách thay thế các token giữ chỗ âm thanh bằng các vector nhúng âm thanh.

Mô hình này được đóng góp bởi Lasha Koroshinadze và Eric Bezzam.

Bài báo

Audio Flamingo 3: Nâng cao Trí tuệ Âm thanh với các Mô hình Ngôn ngữ Âm thanh Lớn Hoàn toàn Mở
A. Goel, S. Ghosh, J. Kim, S. Kumar, Z. Kong, S. Lee, C.-H. H. Yang, R. Duraiswami, D. Manocha, R. Valle, B. Catanzaro
NVIDIA và Đại học Maryland
Dự án: https://research.nvidia.com/labs/adlr/AF3/

Cách sử dụng

Chế độ Instruct cho Âm thanh

Mô hình hỗ trợ các chỉ dẫn dạng âm thanh-văn bản, bao gồm cả tương tác đa lượt, tất cả đều được xử lý theo lô.

➡️ audio + hướng dẫn dạng văn bản

from transformers import AudioFlamingo3ForConditionalGeneration, AutoProcessor


model_id = "nvidia/audio-flamingo-3-hf"
processor = AutoProcessor.from_pretrained(model_id)
model = AudioFlamingo3ForConditionalGeneration.from_pretrained(model_id, device_map="auto")

conversation = [
    {
        "role": "user",
        "content": [
            {"type": "text", "text": "Transcribe the input speech."},
            {"type": "audio", "path": "https://huggingface.co/datasets/nvidia/AudioSkills/resolve/main/assets/WhDJDIviAOg_120_10.mp3"},
        ],
    }
]

inputs = processor.apply_chat_template(
    conversation,
    tokenize=True,
    add_generation_prompt=True,
    return_dict=True,
).to(model.device, dtype=model.dtype)

outputs = model.generate(**inputs, max_new_tokens=500)

decoded_outputs = processor.decode(outputs[:, inputs.input_ids.shape[1]:], skip_special_tokens=True)
print(decoded_outputs)

➡️ nhiều lượt:

from transformers import AudioFlamingo3ForConditionalGeneration, AutoProcessor


model_id = "nvidia/audio-flamingo-3-hf"
processor = AutoProcessor.from_pretrained(model_id)
model = AudioFlamingo3ForConditionalGeneration.from_pretrained(model_id, device_map="auto")

conversation = [
    {
        "role": "user",
        "content": [
            {
                "type": "text",
                "text": "Instruction: How does the tone of female speech change throughout the audio? Choose the correct option among the options below: (A) Sad to happy (B) Happy to sad (C) Neutral to happy (D) Happy to neutral.",
            },
            {"type": "audio", "path": "https://huggingface.co/datasets/nvidia/AudioSkills/resolve/main/assets/000000786159.31.wav"},
        ],
    },
    {
        "role": "assistant",
        "content": [{"type": "text", "text": "(A) Sad to happy"}],
    },
    {
        "role": "user",
        "content": [
            {"type": "text", "text": "Why do you think so?"},
        ],
    },
]

inputs = processor.apply_chat_template(
    conversation,
    tokenize=True,
    add_generation_prompt=True,
    return_dict=True,
).to(model.device, dtype=model.dtype)

outputs = model.generate(**inputs, max_new_tokens=500)

decoded_outputs = processor.decode(outputs[:, inputs.input_ids.shape[1]:], skip_special_tokens=True)
print(decoded_outputs)

➡️ chỉ văn bản:

from transformers import AudioFlamingo3ForConditionalGeneration, AutoProcessor


model_id = "nvidia/audio-flamingo-3-hf"
processor = AutoProcessor.from_pretrained(model_id)
model = AudioFlamingo3ForConditionalGeneration.from_pretrained(model_id, device_map="auto")

conversation = [
    {
        "role": "user",
        "content": [
            {"type": "text", "text": "What is the capital of France?"},
        ],
    }
]

inputs = processor.apply_chat_template(
    conversation,
    tokenize=True,
    add_generation_prompt=True,
    return_dict=True,
).to(model.device, dtype=model.dtype)

outputs = model.generate(**inputs, max_new_tokens=500)

decoded_outputs = processor.decode(outputs[:, inputs.input_ids.shape[1]:], skip_special_tokens=True)
print(decoded_outputs)

➡️ chỉ có âm thanh:

from transformers import AudioFlamingo3ForConditionalGeneration, AutoProcessor


model_id = "nvidia/audio-flamingo-3-hf"
processor = AutoProcessor.from_pretrained(model_id)
model = AudioFlamingo3ForConditionalGeneration.from_pretrained(model_id, device_map="auto")

conversation = [
    {
        "role": "user",
        "content": [
            {"type": "audio", "path": "https://huggingface.co/datasets/nvidia/AudioSkills/resolve/main/assets/WhDJDIviAOg_120_10.mp3"},
        ],
    }
]

inputs = processor.apply_chat_template(
    conversation,
    tokenize=True,
    add_generation_prompt=True,
    return_dict=True,
).to(model.device, dtype=model.dtype)

outputs = model.generate(**inputs, max_new_tokens=500)

decoded_outputs = processor.decode(outputs[:, inputs.input_ids.shape[1]:], skip_special_tokens=True)
print(decoded_outputs)

➡️ suy luận theo lô!

from transformers import AudioFlamingo3ForConditionalGeneration, AutoProcessor


model_id = "nvidia/audio-flamingo-3-hf"
processor = AutoProcessor.from_pretrained(model_id)
model = AudioFlamingo3ForConditionalGeneration.from_pretrained(model_id, device_map="auto")

conversations = [
    [
        {
            "role": "user",
            "content": [
                {"type": "text", "text": "Transcribe the input speech."},
                {
                    "type": "audio",
                    "path": "https://huggingface.co/datasets/nvidia/AudioSkills/resolve/main/assets/t_837b89f2-26aa-4ee2-bdf6-f73f0dd59b26.wav",
                },
            ],
        }
    ],
    [
        {
            "role": "user",
            "content": [
                {
                    "type": "text",
                    "text": "This track feels really peaceful and introspective. What elements make it feel so calming and meditative?",
                },
                {"type": "audio", "path": "https://huggingface.co/datasets/nvidia/AudioSkills/resolve/main/assets/FPSbCAANfbJLVSwD.mp3"},
            ],
        }
    ],
]

inputs = processor.apply_chat_template(
    conversations,
    tokenize=True,
    add_generation_prompt=True,
    return_dict=True,
).to(model.device, dtype=model.dtype)

outputs = model.generate(**inputs, max_new_tokens=500)

decoded_outputs = processor.decode(outputs[:, inputs.input_ids.shape[1]:], skip_special_tokens=True)
print(decoded_outputs)

➡️ Huấn luyện:

chuyển văn bản

mẫu chat

➡️ lối tắt chuyển văn

from transformers import AudioFlamingo3ForConditionalGeneration, AutoProcessor


model_id = "nvidia/audio-flamingo-3-hf"
processor = AutoProcessor.from_pretrained(model_id)
model = AudioFlamingo3ForConditionalGeneration.from_pretrained(model_id, device_map="auto")

inputs = processor.apply_transcription_request(audio="https://huggingface.co/datasets/nvidia/AudioSkills/resolve/main/assets/t_837b89f2-26aa-4ee2-bdf6-f73f0dd59b26.wav").to(model.device, dtype=model.dtype)

outputs = model.generate(**inputs, max_new_tokens=500)
decoded_outputs = processor.decode(outputs[:, inputs.input_ids.shape[1]:], skip_special_tokens=True, strip_prefix=True)

print(decoded_outputs)

Mô hình được huấn luyện để phát ra các bản ghi âm có tiền tố khung trợ lý như The spoken content of the audio is "<text>".. Hãy sử dụng strip_prefix=True (như đã minh họa ở trên) để loại bỏ câu trợ lý cố định và các dấu nháy bao quanh, chỉ giữ lại phần bản ghi âm.

Cách hoạt động của mô hình

Kiến trúc

AudioFlamingo3Encoder Bộ trích xuất đặc trưng + bộ mã hóa kiểu Whisper → average-pool theo thời gian (stride 2) → LayerNorm. Sinh ra trạng thái ẩn theo từng khung hình ở tốc độ sau khi pool.
AudioFlamingo3MultiModalProjector Một MLP nhỏ ánh xạ các đặc trưng từ bộ mã hóa sang kích thước ẩn của mô hình ngôn ngữ.
AudioFlamingo3ForConditionalGeneration Một mô hình ngôn ngữ nhân quả nhận các embedding văn bản, trong đó mỗi vị trí token placeholder âm thanh được thay thế tại chỗ bằng một embedding khung âm thanh. Việc hợp nhất không gây ra thay đổi về độ dài chuỗi.

Căn chỉnh ở cấp độ bộ xử lý

Mỗi dạng sóng thô được chia thành các cửa sổ có độ dài cố định dựa trên chunk_length (giây) và sampling_rate (Hz) của bộ trích xuất đặc trưng.
Với mỗi cửa sổ, bộ xử lý tính toán số khung sau khi pool post_pool_len mà bộ mã hóa sẽ xuất ra (khớp với lịch trình conv/pool).
Bộ xử lý mở rộng token giữ chỗ âm thanh bằng tổng số khung sau pooling trên tất cả các cửa sổ.
Mô hình sau đó thay thế các vị trí token đó bằng các embedding âm thanh đã chiếu tương ứng.

Các mẫu sử dụng

Phím tắt cho việc chuyển văn bản

Đối với nhận dạng giọng nói tự động, bạn có thể bỏ qua việc viết lại chỉ thị mặc định mỗi lần và gọi apply_transcription_request():

inputs = processor.apply_transcription_request(audio=audio_array)

Truyền prompt="Transcribe the input speech." (hoặc một danh sách các prompt cho âm thanh theo lô) để tùy chỉnh chỉ thị trong khi vẫn giữ nguyên cách xử lý vị trí chèn âm thanh.

audio chấp nhận mảng trong bộ nhớ, đường dẫn tệp cục bộ hoặc URL. Mọi tham số của bộ xử lý (text_kwargs, audio_kwargs, v.v.) đều được chuyển tiếp, vì vậy bạn có thể điều chỉnh padding hoặc định dạng tensor giống như khi gọi processor(...).

Âm thanh dài và phân khung

Quan trọng: Độ dài tối đa của âm thanh là 10 phút. Âm thanh dài hơn mức này sẽ bị cắt bớt.

Cấu hình mặc định xử lý các cửa sổ 30 giây ở 16 kHz đơn kênh.
Trình xử lý áp dụng giới hạn cứng là 20 cửa sổ cho mỗi mẫu, dẫn đến tối đa 10 phút âm thanh (20 cửa sổ × 30 giây).
Với mỗi cửa sổ:
- mel_len là độ dài mel đã được đệm.
- Một stack conv giảm thời gian vì conv_output_len = (mel_len - 1) // 2 + 1.
- Số khung sau pooling cho mỗi cửa sổ: post_pool_len = (conv_output_len - 2) // 2 + 1.
- Một token placeholder âm thanh được mở rộng thành tổng của post_pool_len trên tất cả các cửa sổ.

Đệm, chú ý và bộ nhớ đệm

Đệm trái so với đệm phải Đối với việc tạo ra dữ liệu với độ dài prompt hỗn hợp trong một batch, đệm trái thường được ưu tiên hơn. Đối với huấn luyện, đệm phải là phổ biến; cơ chế fusion của AF3 bản thân nó không phụ thuộc vào kiểu đệm vì nó thay thế tại chỗ.
Mặt nạ chú ý Bộ xử lý trả về attention_mask (văn bản) và input_features_mask (âm thanh). Mô hình xây dựng một mặt nạ 4 chiều bên trong trên trục pre-pool của bộ mã hóa, với giá trị âm vô cùng tại các vị trí đệm.
Đệm (Caching) Trong quá trình sinh, input_features và input_features_mask chỉ được truyền ở bước đầu tiên. Các bước tiếp theo sẽ sử dụng các khóa/giá trị được đệm từ mô hình ngôn ngữ.

Xử lý sự cố

Đầu ra rỗng hoặc bị cắt khi xử lý theo lô Sử dụng đệm bên trái (left padding) cho việc tạo theo lô và chỉ giải mã các token mới sau độ dài của prompt, như đã minh họa trong phần khởi động nhanh.

AudioFlamingo3Config

lớp transformers.AudioFlamingo3Config

< source >

( transformers_version: str | None = Nonearchitectures: list[str] | None = Noneoutput_hidden_states: bool | None = Falsereturn_dict: bool | None = Truedtype: str | torch.dtype | None = Nonechunk_size_feed_forward: int = 0is_encoder_decoder: bool = Falseid2label: dict[int, str] | dict[str, str] | None = Nonelabel2id: dict[str, int] | dict[str, str] | None = Noneproblem_type: Literal['regression', 'single_label_classification', 'multi_label_classification'] | None = Noneaudio_config: dict | transformers.configuration_utils.PreTrainedConfig | None = Nonetext_config: dict | transformers.configuration_utils.PreTrainedConfig | None = Noneaudio_token_id: int = 151669projector_hidden_act: str = 'gelu'projector_bias: bool = True )

Tham số

audio_config (Union[dict, ~configuration_utils.PreTrainedConfig], tùy chọn) — Đối tượng cấu hình hoặc từ điển của audio backbone.
text_config (Union[dict, ~configuration_utils.PreTrainedConfig], tùy chọn) — Đối tượng cấu hình hoặc từ điển của bộ khung văn bản.
audio_token_id (int, tùy chọn, mặc định là 151669) — Chỉ số token âm thanh được dùng làm ký tự thay thế cho âm thanh đầu vào.
projector_hidden_act (str, tùy chọn, mặc định là gelu) — Hàm kích hoạt được sử dụng bởi bộ chiếu đa phương thức.
projector_bias (bool, tùy chọn, mặc định là True) — Có sử dụng bias trong bộ chiếu đa phương thức hay không.

Đây là lớp cấu hình để lưu trữ cấu hình của một AudioFlamingo3Model. Nó được sử dụng để khởi tạo một mô hình Audioflamingo3 theo các đối số được chỉ định, xác định kiến trúc mô hình. Khởi tạo một cấu hình với các giá trị mặc định sẽ tạo ra một cấu hình tương tự như của nvidia/audio-flamingo-3-hf

Các đối tượng cấu hình kế thừa từ PreTrainedConfig và có thể được sử dụng để kiểm soát đầu ra của mô hình. Đọc tài liệu từ PreTrainedConfig để biết thêm thông tin.

Ví dụ:

>>> from transformers import AudioFlamingo3ForConditionalGeneration, AudioFlamingo3Config, AudioFlamingo3EncoderConfig, Qwen2Config

>>> # Initializing an AudioFlamingo3Encoder config
>>> audio_config = AudioFlamingo3EncoderConfig()

>>> # Initializing a Qwen2 config
>>> text_config = Qwen2Config()

>>> # Initializing an AudioFlamingo3 configuration
>>> configuration = AudioFlamingo3Config(audio_config, text_config)

>>> # Initializing a model from the audioflamingo3 style configuration
>>> model = AudioFlamingo3ForConditionalGeneration(configuration)

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

AudioFlamingo3EncoderConfig

lớp transformers.AudioFlamingo3EncoderConfig

< source >

( transformers_version: str | None = Nonearchitectures: list[str] | None = Noneoutput_hidden_states: bool | None = Falsereturn_dict: bool | None = Truedtype: str | torch.dtype | None = Nonechunk_size_feed_forward: int = 0is_encoder_decoder: bool = Falseid2label: dict[int, str] | dict[str, str] | None = Nonelabel2id: dict[str, int] | dict[str, str] | None = Noneproblem_type: Literal['regression', 'single_label_classification', 'multi_label_classification'] | None = Nonenum_mel_bins: int = 128num_hidden_layers: int = 32num_attention_heads: int = 20intermediate_size: int = 5120layerdrop: float | int = 0.0activation_function: str = 'gelu'hidden_size: int = 1280dropout: float | int = 0.0attention_dropout: float | int = 0.0activation_dropout: float | int = 0.0initializer_range: float = 0.02scale_embedding: bool = Falsemax_source_positions: int = 1500 )

Tham số

num_mel_bins (int, tùy chọn, mặc định là 128) — Số lượng đặc trưng mel được sử dụng cho mỗi khung đầu vào. Cần khớp với giá trị được dùng trong lớp AutoFeatureExtractor.
num_hidden_layers (int, tùy chọn, mặc định là 32) — Số lượng lớp ẩn trong bộ giải mã Transformer.
num_attention_heads (int, tùy chọn, mặc định là 20) — Số lượng đầu chú ý (attention heads) cho mỗi lớp chú ý trong bộ giải mã Transformer.
intermediate_size (int, tùy chọn, mặc định là 5120) — Kích thước của các biểu diễn MLP.
layerdrop (Union[float, int], tùy chọn, mặc định là 0.0) — Xác suất LayerDrop. Xem [bài báo LayerDrop](xem https://huggingface.co/papers/1909.11556) để biết thêm chi tiết.
activation_function (str, tùy chọn, mặc định là gelu) — Hàm kích hoạt phi tuyến (hàm hoặc chuỗi) trong bộ giải mã. Ví dụ, "gelu", "relu", "silu", v.v.
hidden_size (int, tùy chọn, mặc định là 1280) — Kích thước của các biểu diễn ẩn.
dropout (Union[float, int], tùy chọn, mặc định là 0.0) — Tỷ lệ cho tất cả các lớp dropout.
attention_dropout (Union[float, int], tùy chọn, mặc định là 0.0) — Tỷ lệ dropout cho các xác suất chú ý.
activation_dropout (Union[float, int], tùy chọn, mặc định là 0.0) — Tỷ lệ dropout cho các kích hoạt bên trong lớp liên kết đầy đủ.
initializer_range (float, tùy chọn, mặc định là 0.02) — Độ lệch chuẩn của truncated_normal_initializer để khởi tạo tất cả các ma trận trọng số.
scale_embedding (bool, tùy chọn, mặc định là False) — Có nên chia embedding cho sqrt(d_model) để chuẩn hóa hay không.
max_source_positions (int, tùy chọn, mặc định là 1500) — Chiều dài tối đa của chuỗi các đặc trưng log-mel filter-bank mà mô hình này có thể được sử dụng.

Ví dụ:

>>> from transformers import AudioFlamingo3EncoderConfig, AudioFlamingo3Encoder

>>> # Initializing an AudioFlamingo3EncoderConfig
>>> configuration = AudioFlamingo3EncoderConfig()

>>> # Initializing an AudioFlamingo3Encoder (with random weights)
>>> model = AudioFlamingo3Encoder(configuration)

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

AudioFlamingo3Processor

lớp transformers.AudioFlamingo3Processor

< source >

( feature_extractortokenizerchat_template = Noneaudio_token = '<sound>'default_transcription_prompt = 'Transcribe the input speech.'max_audio_len = 600 )

Tham số

feature_extractor (WhisperFeatureExtractor) — Bộ trích xuất đặc trưng là một đầu vào bắt buộc.
tokenizer (Qwen2Tokenizer) — Tokenizer là đầu vào bắt buộc.
chat_template (str) — Một mẫu Jinja để chuyển đổi các danh sách tin nhắn trong một cuộc trò chuyện thành chuỗi có thể token hóa.
audio_token (Optional[str], tùy chọn, mặc định là "<sound>") — Token đặc biệt được sử dụng để đại diện cho các đầu vào âm thanh trong chat template.
default_transcription_prompt (str, tùy chọn, mặc định là "Transcribe the input speech.") — Prompt mặc định được sử dụng cho các tác vụ chuyển giọng nói thành văn bản khi áp dụng các yêu cầu chuyển giọng nói thành văn bản.
max_audio_len (int, tùy chọn, mặc định là 600) — Chiều dài tối đa của các chuỗi âm thanh tính bằng giây. Âm thanh dài hơn giá trị này sẽ bị cắt bớt.

Tạo một AudioFlamingo3Processor đóng gói một bộ trích xuất đặc trưng và một bộ phân từ thành một bộ xử lý duy nhất.

AudioFlamingo3Processor cung cấp đầy đủ các chức năng của WhisperFeatureExtractor và Qwen2Tokenizer. Xem ~WhisperFeatureExtractor và ~Qwen2Tokenizer để biết thêm thông tin.

call

< source >

( text: str | list[str]audio: typing.Union[numpy.ndarray, ForwardRef('torch.Tensor'), collections.abc.Sequence[numpy.ndarray], collections.abc.Sequence['torch.Tensor'], NoneType] = Noneoutput_labels: bool | None = False**kwargs: *<class 'transformers.models.audioflamingo3.processing_audioflamingo3.AudioFlamingo3ProcessorKwargs'> ) → BatchFeature

Tham số

text (Union[str, list[str]]) — Chuỗi hoặc lô các chuỗi cần được mã hóa. Mỗi chuỗi có thể là một chuỗi ký tự hoặc một danh sách các chuỗi ký tự (chuỗi đã được tách token trước). Nếu bạn truyền vào dữ liệu đầu vào đã được tách token trước, hãy đặt is_split_into_words=True để tránh nhầm lẫn với các đầu vào dạng lô.
audio (Union[numpy.ndarray, torch.Tensor, collections.abc.Sequence[numpy.ndarray], collections.abc.Sequence[torch.Tensor]], optional) — Âm thanh hoặc lô âm thanh cần được chuẩn bị. Mỗi âm thanh có thể là một mảng NumPy hoặc tensor PyTorch. Trong trường hợp là mảng NumPy/tensor PyTorch, mỗi âm thanh nên có hình dạng (C, T), trong đó C là số kênh và T là độ dài mẫu của âm thanh.
output_labels (bool, tùy chọn, mặc định=False) — Có trả về nhãn cho việc huấn luyện hay không.
return_tensors (str hoặc TensorType, tùy chọn) — Nếu được đặt, sẽ trả về tensor của một framework cụ thể. Các giá trị chấp nhận được là:
- 'pt': Trả về các đối tượng torch.Tensor của PyTorch.
- 'np': Trả về các đối tượng np.ndarray của NumPy.
**kwargs (ProcessingKwargs, optional) — Các tùy chọn xử lý bổ sung cho từng modality (text, images, videos, audio). Các tham số cụ thể của model được liệt kê ở trên; xem lớp TypedDict để biết danh sách đầy đủ các đối số được hỗ trợ.

Trả về

BatchFeature

Một từ điển chứa văn bản đã được token hóa (input_ids, attention_mask) và đặc trưng âm thanh (input_features, input_features_mask).

AudioFlamingo3Encoder

lớp transformers.AudioFlamingo3Encoder

< source >

( config: AudioFlamingo3EncoderConfig )

Tham số

config (AudioFlamingo3EncoderConfig) — Lớp cấu hình mô hình chứa tất cả các tham số của mô hình. Khởi tạo bằng tệp cấu hình sẽ không tải trọng số liên quan đến mô hình, chỉ tải cấu hình. Xem phương thức from_pretrained() để tải trọng số mô hình.

Mô hình âm thanh từ AudioFlamingo3 không có bất kỳ đầu (head) hay lớp chiếu (projection) nào ở phía trên.

Mô hình này kế thừa từ PreTrainedModel. Xem tài liệu của lớp cha để biết các phương thức chung mà thư viện triển khai cho tất cả các mô hình của nó (chẳng hạn như tải xuống hoặc lưu trữ, thay đổi kích thước các nhúng đầu vào, cắt tỉa các đầu, v.v.)

Mô hình này cũng là một lớp con của torch.nn.Module trong PyTorch. Hãy sử dụng nó như một Module PyTorch thông thường và tham khảo tài liệu PyTorch cho mọi vấn đề liên quan đến cách sử dụng và hành vi chung.

forward

< source >

( input_features: Tensorinput_features_mask: typing.Optional[torch.Tensor] = None**kwargs )

Tham số

input_features (torch.Tensor có hình dạng (batch_size, feature_size, sequence_length)) — Các đặc trưng Log-Mel được trích xuất từ âm thanh thô. Hãy sử dụng bộ xử lý/bộ trích xuất đặc trưng để tính toán và đệm (pad) các đặc trưng này từ đầu vào dạng sóng.
input_features_mask (torch.Tensor có shape (batch_size, sequence_length), tùy chọn) — Mặt nạ để tránh thực hiện attention trên các chỉ mục đặc trưng padding. Các giá trị mặt nạ được chọn trong [0, 1]:
- 1 cho các token không bị che,
- 0 cho các token bị che.

AudioFlamingo3Model

lớp transformers.AudioFlamingo3Model

< source >

( config: AudioFlamingo3Config )

Tham số

config (AudioFlamingo3Config) — Lớp cấu hình mô hình chứa tất cả các tham số của mô hình. Khởi tạo bằng tệp cấu hình không tải trọng số liên quan đến mô hình, chỉ tải cấu hình. Xem phương thức from_pretrained() để tải trọng số mô hình.

Mô hình AudioFlamingo3 (encoder Whisper được tinh chỉnh, bộ chiếu đa phương thức, mô hình ngôn ngữ Qwen2), không có đầu mô hình hóa ngôn ngữ.

forward

< source >

( input_ids: typing.Optional[torch.LongTensor] = Noneinput_features: typing.Optional[torch.Tensor] = Noneinput_features_mask: typing.Optional[torch.Tensor] = Noneattention_mask: typing.Optional[torch.Tensor] = Noneposition_ids: typing.Optional[torch.LongTensor] = Nonepast_key_values: transformers.cache_utils.Cache | None = Noneinputs_embeds: typing.Optional[torch.Tensor] = Noneuse_cache: bool | None = None**kwargs: *<class 'transformers.utils.generic.TransformersKwargs'> ) → AudioFlamingo3ModelOutputWithPast or tuple(torch.Tensor)

Tham số

input_ids (torch.LongTensor có dạng (batch_size, sequence_length), tùy chọn) — Chỉ số của các token trong chuỗi đầu vào theo từ điển. Mặc định, padding sẽ bị bỏ qua.
Các chỉ số có thể được lấy bằng cách sử dụng AutoTokenizer. Xem PreTrainedTokenizer.encode() và PreTrainedTokenizer.call() để biết thêm chi tiết.

ID đầu vào là gì?
input_features (torch.Tensor có hình dạng (batch_size, sequence_length, feature_dim), tùy chọn) — Các tensor tương ứng với các đặc trưng âm thanh đầu vào. Các đặc trưng âm thanh có thể được lấy bằng cách sử dụng WhisperFeatureExtractor. Xem WhisperFeatureExtractor.call() để biết chi tiết (AudioFlamingo3Processor sử dụng WhisperFeatureExtractor để xử lý âm thanh).
input_features_mask (torch.Tensor có hình dạng (batch_size, feature_sequence_length)) — Mặt nạ để tránh thực hiện chú ý trên các chỉ mục đặc trưng đệm.
attention_mask (torch.Tensor có hình dạng (batch_size, sequence_length), tùy chọn) — Mặt nạ để tránh thực hiện chú ý trên các chỉ số token đệm. Các giá trị mặt nạ được chọn trong [0, 1]:
- 1 cho các token không bị che,
- 0 cho các token bị che.
Mặt nạ chú ý là gì?
position_ids (torch.LongTensor có hình dạng (batch_size, sequence_length), tùy chọn) — Chỉ số vị trí của các token trong mỗi chuỗi đầu vào trong các position embeddings. Được chọn trong khoảng [0, config.n_positions - 1].
ID vị trí là gì?
past_key_values (~cache_utils.Cache, tuỳ chọn) — Các hidden-state đã tính trước (key và value trong các khối self-attention và cross-attention) có thể được sử dụng để tăng tốc giải mã tuần tự. Điều này thường bao gồm past_key_values được trả về bởi mô hình ở một giai đoạn giải mã trước đó, khi use_cache=True hoặc config.use_cache=True.
Chỉ cho phép Cache instance làm đầu vào, xem hướng dẫn kv cache của chúng tôi. Nếu không truyền past_key_values, DynamicCache sẽ được khởi tạo theo mặc định.

Mô hình sẽ xuất ra cùng định dạng cache được đưa vào làm đầu vào.

Nếu past_key_values được sử dụng, người dùng được kỳ vọng chỉ nhập input_ids chưa được xử lý (những phần chưa có trạng thái key value quá khứ được cung cấp cho mô hình này) có hình dạng (batch_size, unprocessed_length) thay vì toàn bộ input_ids có hình dạng (batch_size, sequence_length).
inputs_embeds (torch.Tensor có hình dạng (batch_size, sequence_length, hidden_size), tùy chọn) — Tùy chọn, thay vì truyền input_ids, bạn có thể chọn truyền trực tiếp một biểu diễn nhúng. Điều này hữu ích nếu bạn muốn kiểm soát nhiều hơn cách chuyển đổi các chỉ số input_ids thành các vector liên quan so với ma trận tra cứu nhúng nội bộ của mô hình.
use_cache (bool, tùy chọn) — Nếu đặt thành True, các trạng thái key value của past_key_values sẽ được trả về và có thể được sử dụng để tăng tốc quá trình giải mã (xem past_key_values).

Trả về

AudioFlamingo3ModelOutputWithPast hoặc tuple(torch.Tensor)

Một AudioFlamingo3ModelOutputWithPast hoặc một tuple của torch.Tensor (nếu return_dict=False được truyền hoặc khi config.return_dict=False) bao gồm các thành phần khác nhau tùy thuộc vào cấu hình (AudioFlamingo3Config) và đầu vào.

Phương thức forward của AudioFlamingo3Model ghi đè lên phương thức đặc biệt __call__.

Mặc dù công thức cho bước truyền tiến cần được định nghĩa bên trong hàm này, người dùng nên gọi instance của Module sau đó thay vì gọi hàm này, vì instance Module sẽ đảm nhận việc thực hiện các bước tiền xử lý và hậu xử lý, trong khi hàm này sẽ lặng lẽ bỏ qua chúng.

audio_hidden_states (torch.Tensor, tùy chọn) — Trạng thái ẩn âm thanh đã được chiếu.

AudioFlamingo3ForConditionalGeneration

lớp transformers.AudioFlamingo3ForConditionalGeneration

< source >

( config: AudioFlamingo3Config )

Tham số

config (AudioFlamingo3Config) — Lớp cấu hình mô hình chứa tất cả các tham số của mô hình. Khởi tạo bằng tệp cấu hình không tải trọng số liên quan đến mô hình, chỉ tải cấu hình. Xem phương thức from_pretrained() để tải trọng số mô hình.

Mô hình AudioFlamingo3 bao gồm một encoder Whisper được tinh chỉnh, một bộ dự chiếu đa phương thức và một mô hình ngôn ngữ Qwen2.

forward

< source >

( input_ids: typing.Optional[torch.LongTensor] = Noneinput_features: typing.Optional[torch.Tensor] = Noneinput_features_mask: typing.Optional[torch.Tensor] = Noneattention_mask: typing.Optional[torch.Tensor] = Noneposition_ids: typing.Optional[torch.LongTensor] = Nonepast_key_values: transformers.cache_utils.Cache | None = Noneinputs_embeds: typing.Optional[torch.Tensor] = Nonelabels: typing.Optional[torch.LongTensor] = Noneuse_cache: bool | None = Nonelogits_to_keep: typing.Union[int, torch.Tensor] = 0**kwargs: *<class 'transformers.utils.generic.TransformersKwargs'> ) → AudioFlamingo3CausalLMOutputWithPast or tuple(torch.Tensor)

Tham số

input_ids (torch.LongTensor có dạng (batch_size, sequence_length), tùy chọn) — Chỉ số của các token trong chuỗi đầu vào theo từ điển. Mặc định, padding sẽ bị bỏ qua.
Các chỉ số có thể được lấy bằng cách sử dụng AutoTokenizer. Xem PreTrainedTokenizer.encode() và PreTrainedTokenizer.call() để biết thêm chi tiết.

ID đầu vào là gì?
input_features (torch.Tensor có hình dạng (batch_size, sequence_length, feature_dim), tùy chọn) — Các tensor tương ứng với các đặc trưng âm thanh đầu vào. Các đặc trưng âm thanh có thể được lấy bằng cách sử dụng WhisperFeatureExtractor. Xem WhisperFeatureExtractor.call() để biết chi tiết (AudioFlamingo3Processor sử dụng WhisperFeatureExtractor để xử lý âm thanh).
input_features_mask (torch.Tensor có hình dạng (batch_size, feature_sequence_length)) — Mặt nạ để tránh thực hiện chú ý trên các chỉ mục đặc trưng đệm.
attention_mask (torch.Tensor có hình dạng (batch_size, sequence_length), tùy chọn) — Mặt nạ để tránh thực hiện chú ý trên các chỉ số token đệm. Các giá trị mặt nạ được chọn trong [0, 1]:
- 1 cho các token không bị che,
- 0 cho các token bị che.
Mặt nạ chú ý là gì?
position_ids (torch.LongTensor có hình dạng (batch_size, sequence_length), tùy chọn) — Chỉ số vị trí của các token trong mỗi chuỗi đầu vào trong các position embeddings. Được chọn trong khoảng [0, config.n_positions - 1].
ID vị trí là gì?
past_key_values (~cache_utils.Cache, tuỳ chọn) — Các hidden-state đã tính trước (key và value trong các khối self-attention và cross-attention) có thể được sử dụng để tăng tốc giải mã tuần tự. Điều này thường bao gồm past_key_values được trả về bởi mô hình ở một giai đoạn giải mã trước đó, khi use_cache=True hoặc config.use_cache=True.
Chỉ cho phép Cache instance làm đầu vào, xem hướng dẫn kv cache của chúng tôi. Nếu không truyền past_key_values, DynamicCache sẽ được khởi tạo theo mặc định.

Mô hình sẽ xuất ra cùng định dạng cache được đưa vào làm đầu vào.

Nếu past_key_values được sử dụng, người dùng được kỳ vọng chỉ nhập input_ids chưa được xử lý (những phần chưa có trạng thái key value quá khứ được cung cấp cho mô hình này) có hình dạng (batch_size, unprocessed_length) thay vì toàn bộ input_ids có hình dạng (batch_size, sequence_length).
inputs_embeds (torch.Tensor có hình dạng (batch_size, sequence_length, hidden_size), tùy chọn) — Tùy chọn, thay vì truyền input_ids, bạn có thể chọn truyền trực tiếp một biểu diễn nhúng. Điều này hữu ích nếu bạn muốn kiểm soát nhiều hơn cách chuyển đổi các chỉ số input_ids thành các vector liên quan so với ma trận tra cứu nhúng nội bộ của mô hình.
labels (torch.LongTensor có hình dạng (batch_size, sequence_length), tùy chọn) — Nhãn để tính toán tổn thất mô hình hóa ngôn ngữ có che (masked language modeling loss).
use_cache (bool, tùy chọn) — Nếu đặt thành True, các trạng thái key value của past_key_values sẽ được trả về và có thể được sử dụng để tăng tốc quá trình giải mã (xem past_key_values).
logits_to_keep (Union[int, torch.Tensor], tùy chọn, mặc định là 0) — Nếu là int, tính logits cho logits_to_keep token cuối. Nếu là 0, tính logits cho tất cả input_ids (trường hợp đặc biệt). Chỉ cần logits của token cuối cho quá trình sinh, và việc chỉ tính cho token đó có thể tiết kiệm bộ nhớ, điều này trở nên khá đáng kể với các chuỗi dài hoặc kích thước từ vựng lớn. Nếu là torch.Tensor, phải là 1 chiều tương ứng với các chỉ số cần giữ trong chiều độ dài chuỗi. Điều này hữu ích khi sử dụng định dạng tensor đóng gói (một chiều duy nhất cho batch và độ dài chuỗi).

Trả về

AudioFlamingo3CausalLMOutputWithPast hoặc tuple(torch.Tensor)

Một AudioFlamingo3CausalLMOutputWithPast hoặc một tuple của torch.Tensor (nếu return_dict=False được truyền hoặc khi config.return_dict=False) bao gồm các thành phần khác nhau tùy thuộc vào cấu hình (AudioFlamingo3Config) và đầu vào.

Phương thức forward của AudioFlamingo3ForConditionalGeneration ghi đè lên phương thức đặc biệt __call__.

Mặc dù công thức cho bước truyền tiến cần được định nghĩa bên trong hàm này, người dùng nên gọi instance của Module sau đó thay vì gọi hàm này, vì instance Module sẽ đảm nhận việc thực hiện các bước tiền xử lý và hậu xử lý, trong khi hàm này sẽ lặng lẽ bỏ qua chúng.

loss (torch.Tensor có shape (1,), tùy chọn, được trả về khi labels được cung cấp) — Loss của language modeling (cho next-token prediction).
logits (torch.Tensor có hình dạng (batch_size, sequence_length, config.vocab_size)) — Điểm dự đoán của đầu mô hình hóa ngôn ngữ.
past_key_values (Cache, tùy chọn, được trả về khi use_cache=True được truyền vào hoặc khi config.use_cache=True) — Đây là một instance của Cache.
hidden_states (tuple[torch.Tensor], tuỳ chọn, được trả về khi output_hidden_states=True được truyền vào hoặc khi config.output_hidden_states=True) — Tuple của torch.Tensor (một cho đầu ra của embeddings, nếu mô hình có lớp embedding, + một cho đầu ra của mỗi lớp) có hình dạng (batch_size, sequence_length, hidden_size).

Trạng thái ẩn của mô hình tại đầu ra của mỗi lớp cùng với các đầu ra embedding ban đầu tùy chọn.
attentions (tuple[torch.Tensor], tuỳ chọn, được trả về khi output_attentions=True được truyền vào hoặc khi config.output_attentions=True) — Tuple của torch.Tensor (một cho mỗi lớp) có hình dạng (batch_size, num_heads, sequence_length, sequence_length).

Trọng số chú ý sau softmax của attention, được sử dụng để tính trung bình có trọng số trong các đầu self-attention.
audio_hidden_states (torch.Tensor, tùy chọn) — Trạng thái ẩn của bộ mã hóa âm thanh sau khi chiếu.

Ví dụ:

>>> from transformers import AudioFlamingo3ForConditionalGeneration, AutoProcessor

>>> model_id = "nvidia/audio-flamingo-3-hf"
>>> processor = AutoProcessor.from_pretrained(model_id)
>>> model = AudioFlamingo3ForConditionalGeneration.from_pretrained(model_id, device_map="auto")

get_audio_features

< source >

( input_featuresinput_features_mask**kwargs )

Update on GitHub

←Aria AyaVision→