ultravox.py 26.6 KB
Newer Older
1
2
# SPDX-License-Identifier: Apache-2.0

3
4
5
# Adapted from https://github.com/fixie-ai/ultravox/blob/ecd58c4041030bae2ad15aa6bcf04ab43199ea02/ultravox/model/ultravox_model.py
"""PyTorch Ultravox model."""
import math
6
from collections.abc import Iterable, Mapping, Sequence
7
from functools import cached_property
8
from typing import Any, List, Literal, Optional, Set, Tuple, TypedDict, Union
9
10
11
12
13

import torch
import torch.utils.checkpoint
from torch import nn
from torch.nn import functional as F
14
from transformers import BatchFeature, ProcessorMixin
15
16
17
from transformers.models.whisper import WhisperFeatureExtractor
from transformers.models.whisper.modeling_whisper import WhisperEncoder

18
from vllm import envs
19
from vllm.config import VllmConfig
20
from vllm.forward_context import get_forward_context
21
from vllm.model_executor.layers.activation import MulAndSilu, get_act_fn
22
from vllm.model_executor.layers.layernorm import RMSNorm
Joe Runde's avatar
Joe Runde committed
23
from vllm.model_executor.layers.sampler import SamplerOutput, get_sampler
24
from vllm.model_executor.model_loader.loader import DefaultModelLoader
25
from vllm.model_executor.models.module_mapping import MultiModelKeys
26
from vllm.model_executor.sampling_metadata import SamplingMetadata
27
from vllm.multimodal import MULTIMODAL_REGISTRY
28
29
from vllm.multimodal.inputs import (MultiModalFieldConfig, MultiModalKwargs,
                                    NestedTensors)
30
from vllm.multimodal.parse import MultiModalDataItems, MultiModalDataParser
31
from vllm.multimodal.processing import (BaseMultiModalProcessor,
32
33
                                        BaseProcessingInfo, PromptReplacement,
                                        PromptUpdate)
34
from vllm.multimodal.profiling import BaseDummyInputsBuilder, ProcessorInputs
35
from vllm.sequence import IntermediateTensors
36
37
from vllm.transformers_utils.configs.ultravox import UltravoxConfig

38
from .interfaces import (MultiModalEmbeddings, SupportsLoRA,
39
                         SupportsMultiModal, SupportsPP, SupportsV0Only)
40
from .utils import (AutoWeightsLoader, WeightsMapper, flatten_bn,
41
                    init_vllm_registered_model, maybe_prefix,
42
                    merge_multimodal_embeddings,
43
                    merge_multimodal_embeddings_from_map)
44

45
46
_AUDIO_PLACEHOLDER_OVERRIDE = "<|reserved_special_token_0|>"
_AUDIO_PLACEHOLDER_TOKEN = 128002
47
_AUDIO_TOKENS_PER_SECOND = 6.25
48
_MAX_ENCODER_BATCH_SIZE = 16
49
50
51
52


class UltravoxAudioFeatureInputs(TypedDict):
    type: Literal["audio_features"]
53
    data: NestedTensors
54
55
56
57
58
59
60
61
62
63
64
    """Shape: `(batch_size, num_chunks, 80, M)`"""
    lens: NestedTensors
    """
    Length of the audio frames. Used for attention mask in WhisperEncoder.
    Shape: `(batch_size, num_chunks)`
    """
    token_len: NestedTensors
    """
    Length of the audio tokens. Used for flattening the audio features.
    Shape: `(batch_size, num_chunks)`
    """
65
66
67
68


class UltravoxAudioEmbeddingInputs(TypedDict):
    type: Literal["audio_embeds"]
69
    data: NestedTensors
70
    """Shape: `(batch_size, num_audios, audio_feature_size, hidden_size)`"""
71
72
73
74
75
76


UltravoxAudioInputs = Union[UltravoxAudioFeatureInputs,
                            UltravoxAudioEmbeddingInputs]


77
class UltravoxProcessingInfo(BaseProcessingInfo):
78

79
    def get_hf_processor(
80
81
82
83
        self,
        *,
        # Ignored in initialization
        sampling_rate: Optional[int] = None,
84
        **kwargs: object,
85
    ) -> ProcessorMixin:
86
        hf_processor = self.ctx.get_hf_processor(**kwargs)
87
88
89
90
91
92

        # NOTE: Ultravox processing definition uses '<|eot_id|>' as the
        # placeholder that will cause confusion with the actual end of turn
        # token, thus we override placeholder with a reserved special
        # token.
        hf_processor.audio_token_replacement = _AUDIO_PLACEHOLDER_OVERRIDE
93
        hf_processor.audio_replacement_token_id = _AUDIO_PLACEHOLDER_TOKEN
94
        return hf_processor
95

96
    def get_feature_extractor(
97
98
99
100
101
        self,
        *,
        # Ignored in initialization
        sampling_rate: Optional[int] = None,
    ) -> WhisperFeatureExtractor:
102
        hf_processor = self.get_hf_processor(sampling_rate=sampling_rate)
103
104
105
106
107
        audio_processor = hf_processor.audio_processor  # type: ignore
        feature_extractor = audio_processor.feature_extractor  # type: ignore
        assert isinstance(feature_extractor, WhisperFeatureExtractor)
        return feature_extractor

108
109
    def get_supported_mm_limits(self) -> Mapping[str, Optional[int]]:
        return {"audio": None}
110

111
112
113
114
115
    def get_mm_max_tokens_per_item(
        self,
        seq_len: int,
        mm_counts: Mapping[str, int],
    ) -> Mapping[str, int]:
116
        feature_extractor = self.get_feature_extractor()
117
118
        max_audio_tokens = math.ceil(feature_extractor.chunk_length *
                                     _AUDIO_TOKENS_PER_SECOND)
119

120
        return {"audio": max_audio_tokens * _MAX_ENCODER_BATCH_SIZE}
121

122
123
124
125

class UltravoxDummyInputsBuilder(BaseDummyInputsBuilder[UltravoxProcessingInfo]
                                 ):

126
    def get_dummy_processor_inputs(
127
        self,
128
129
130
        seq_len: int,
        mm_counts: Mapping[str, int],
    ) -> ProcessorInputs:
131
        feature_extractor = self.info.get_feature_extractor()
132
133

        sampling_rate = feature_extractor.sampling_rate
134
135
        audio_len = (feature_extractor.chunk_length * sampling_rate *
                     _MAX_ENCODER_BATCH_SIZE)
136
137
138
139
140
141
142
143
144
145
146
        num_audios = mm_counts.get("audio", 0)

        mm_data = {
            "audio":
            self._get_dummy_audios(length=audio_len, num_audios=num_audios)
        }

        return ProcessorInputs(
            prompt_text="<|audio|>" * num_audios,
            mm_data=mm_data,
        )
147

148

149
150
class UltravoxMultiModalProcessor(
        BaseMultiModalProcessor[UltravoxProcessingInfo]):
151

152
    def _get_data_parser(self) -> MultiModalDataParser:
153
        feature_extractor = self.info.get_feature_extractor()
154
        return MultiModalDataParser(target_sr=feature_extractor.sampling_rate)
155
156

    def _call_hf_processor(
157
158
        self,
        prompt: str,
159
160
        mm_data: Mapping[str, object],
        mm_kwargs: Mapping[str, object],
161
    ) -> BatchFeature:
162
        # Text-only input not supported in composite processor
163
        if not mm_data or not mm_data.get("audios", []):
164
165
            prompt_ids = self.info.get_tokenizer().encode(
                prompt, add_special_tokens=False)
166
            prompt_ids = self._apply_hf_processor_tokens_only(prompt_ids)
167
168
169
170
            return BatchFeature(dict(input_ids=[prompt_ids]), tensor_type="pt")

        mm_data = dict(mm_data)
        audios = mm_data.pop("audios", [])
171
        assert isinstance(audios, list)
172

173
        feature_extractor = self.info.get_feature_extractor()
174
175
        mm_kwargs = dict(
            **mm_kwargs,
176
            sampling_rate=feature_extractor.sampling_rate,
177
            include_audio_num_chunks=True,
178
179
        )

180
        item_processor_data = dict(**mm_data, audios=audios)
181

182
183
184
185
        output = super()._call_hf_processor(
            prompt=prompt,
            mm_data=item_processor_data,
            mm_kwargs=mm_kwargs,
186
        )
187
188
189
        output['audio_features'] = output.pop('audio_values')

        return output
190

191
192
193
194
195
    def _get_mm_fields_config(
        self,
        hf_inputs: BatchFeature,
        hf_processor_mm_kwargs: Mapping[str, object],
    ) -> Mapping[str, MultiModalFieldConfig]:
196
        num_chunks = hf_inputs.get('audio_num_chunks', torch.zeros(0))
197
        return dict(
198
199
200
201
202
203
204
205
206
207
208
            # to handle longer than 30s audio, each audio might be split
            # into multiple chunks as such, their batch dimension can be
            # higher than the number of audio samples
            audio_features=MultiModalFieldConfig.flat_from_sizes(
                "audio", num_chunks),
            audio_token_len=MultiModalFieldConfig.flat_from_sizes(
                "audio", num_chunks),
            audio_lens=MultiModalFieldConfig.flat_from_sizes(
                "audio", num_chunks),
            # num_chunks can convert audio_chunked to audio batch dimension
            audio_num_chunks=MultiModalFieldConfig.batched("audio"),
209
210
211
            audio_embeds=MultiModalFieldConfig.batched("audio"),
        )

212
    def _get_prompt_updates(
213
214
        self,
        mm_items: MultiModalDataItems,
215
        hf_processor_mm_kwargs: Mapping[str, Any],
216
        out_mm_kwargs: MultiModalKwargs,
217
    ) -> Sequence[PromptUpdate]:
218
        hf_processor = self.info.get_hf_processor(**hf_processor_mm_kwargs)
219

220
221
222
223
224
225
226
227
228
229
230
        replacement_id = hf_processor.audio_replacement_token_id  # type: ignore

        # Each audio can be split into multiple chunks.
        # chunks_start_idx[i] indicates the start index of the chunks
        # belonging to the i-th audio.
        num_chunks = out_mm_kwargs.get("audio_num_chunks", torch.zeros(0))
        chunks_start_idx: torch.Tensor = torch.cumsum(num_chunks,
                                                      dim=0,
                                                      dtype=torch.int32)
        chunks_start_idx = torch.cat(
            [torch.tensor([0], dtype=torch.int32), chunks_start_idx])
231
232

        def get_replacement_ultravox(item_idx: int):
233
234
235
            start = chunks_start_idx[item_idx]
            end = chunks_start_idx[item_idx + 1]
            audio_token_len = out_mm_kwargs["audio_token_len"][start:end].sum()
236
            return [replacement_id] * int(audio_token_len)  # type: ignore
237
238
239
240

        return [
            PromptReplacement(
                modality="audio",
241
                target="<|audio|>",
242
243
244
                replacement=get_replacement_ultravox,
            )
        ]
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273


class StackAudioFrames(nn.Module):
    """
    Stack the audio embedding frames to reduce the sequence length by a factor
    of `stack_factor`.
    """

    def __init__(self, stack_factor: int = 8):
        super().__init__()
        self.stack_factor = stack_factor

    def forward(self, audio_embeds: torch.Tensor) -> torch.Tensor:
        B, T, C = audio_embeds.shape
        T_pad = (T + self.stack_factor -
                 1) // self.stack_factor * self.stack_factor
        audio_embeds = F.pad(audio_embeds, (0, 0, 0, T_pad - T))
        B, T, C = audio_embeds.shape
        audio_embeds = audio_embeds.view(B, T // self.stack_factor,
                                         C * self.stack_factor)
        return audio_embeds


class UltravoxProjector(nn.Module):

    def __init__(self, config: UltravoxConfig):
        super().__init__()
        self.hidden_dim = config.hidden_size
        self._pad_and_stack = StackAudioFrames(config.stack_factor)
274
275
276
277
        dim_in = config.audio_config.hidden_size * config.stack_factor
        self.ln_pre = RMSNorm(dim_in)
        self.linear_1 = nn.Linear(dim_in, self.hidden_dim, bias=False)
        dim_mid = self.hidden_dim
278
279

        if config.projector_act == "swiglu":
280
            self.act = MulAndSilu()
281
            dim_mid = dim_mid // 2
282
283
284
        else:
            self.act = get_act_fn(config.projector_act)

285
286
287
288
289
290
291
292
293
294
295
        dim_out = config.text_config.hidden_size
        self.linear_2 = nn.Linear(dim_mid, dim_out, bias=False)

        # Ultravox v0.4.1 and below use layer_norm after the second linear layer
        # while v0.5.0 and above uses layer_norm after the first linear layer.
        if config.projector_ln_mid:
            self.ln_mid: nn.Module = RMSNorm(dim_mid)
            self.ln_post = nn.Identity()
        else:
            self.ln_mid = nn.Identity()
            self.ln_post = RMSNorm(dim_out)
296
297
298
299
300
301

    def forward(self, audio_features: torch.Tensor) -> torch.Tensor:
        audio_features = self._pad_and_stack(audio_features)
        audio_features = self.ln_pre(audio_features)
        hidden_states = self.linear_1(audio_features)
        hidden_states = self.act(hidden_states)
302
        hidden_states = self.ln_mid(hidden_states)
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
        hidden_states = self.linear_2(hidden_states)
        hidden_states = self.ln_post(hidden_states)
        return hidden_states


class ModifiedWhisperEncoder(WhisperEncoder):
    """
    Encoder portion of OpenAI's Whisper model.

    This implementation is a slightly modified version of HF Transformers'
    Whisper Encoder, with only a few fixes:
    1. base_model_prefix updated to allow for doing `.from_pretrained`
       directly on the encoder
    2. allow less than 30 second of audio padding to be passed in:
        - relaxed ValueError check for `input_features` length to be less
           than or equal to `expected_seq_length` instead of strictly equal
        - embed_pos is now sliced to match the length of `inputs_embeds`

    Original: https://github.com/huggingface/transformers/blob/main/src/transformers/models/whisper/modeling_whisper.py
    See commentary: https://github.com/huggingface/transformers/issues/25744
    """

    base_model_prefix = "model.encoder"

327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
    def __init__(self, *args, **kwargs):
        super().__init__(*args, **kwargs)
        self.config.is_decoder = False

    @property
    def max_context_length(self):
        return (self.config.max_source_positions * self.conv1.stride[0] *
                self.conv2.stride[0])

    def get_attention_mask_by_audio_len(self,
                                        audio_lens: Optional[torch.Tensor],
                                        hidden_states: torch.Tensor):
        """
        Create attention mask based on audio lengths to mask out padding tokens
        For each sample in batch:
        - Convert raw audio length to feature length after convolutions
        - Create bool mask: True for valid positions and False for padding
        - Convert to attention mask format expected by transformer layers
        (1.0 for positions to attend to, large negative for positions to ignore)
        This masking ensures consistent behavior between training and inference
        by preventing the model from attending to padding tokens in both cases
        """
        if audio_lens is None:
            return None

        audio_feature_len = self._get_feat_extract_output_lengths(audio_lens)
        max_seq_len = hidden_states.shape[1]
        attention_mask = torch.arange(max_seq_len,
                                      device=hidden_states.device)[None, :].lt(
                                          audio_feature_len.view(-1, 1))
        attention_mask = self.get_extended_attention_mask(
            attention_mask,
            None,
            dtype=hidden_states.dtype,
        )
        return attention_mask

364
365
    def forward(
        self,
366
367
        input_features: torch.Tensor,
        audio_lens: Optional[torch.Tensor] = None,
368
    ):
369
        expected_seq_length = self.max_context_length
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
        if input_features.shape[-1] > expected_seq_length:
            raise ValueError(
                f"Whisper expects the mel input features to be of length "
                f"{expected_seq_length} or less, but found "
                f"{input_features.shape[-1]}. Make sure to pad the input mel "
                f"features to {expected_seq_length}.")

        inputs_embeds = nn.functional.gelu(self.conv1(input_features))
        inputs_embeds = nn.functional.gelu(self.conv2(inputs_embeds))

        inputs_embeds = inputs_embeds.permute(0, 2, 1)
        embed_pos = self.embed_positions.weight[:inputs_embeds.size(-2)]

        hidden_states = inputs_embeds + embed_pos
        hidden_states = nn.functional.dropout(hidden_states,
                                              p=self.dropout,
                                              training=self.training)

388
389
390
        attention_mask = self.get_attention_mask_by_audio_len(
            audio_lens, hidden_states)

391
392
393
        for encoder_layer in self.layers:
            layer_outputs = encoder_layer(
                hidden_states,
394
                attention_mask,
395
396
397
398
399
400
401
402
403
                layer_head_mask=None,
            )

            hidden_states = layer_outputs[0]

        hidden_states = self.layer_norm(hidden_states)
        return hidden_states


404
405
406
407
@MULTIMODAL_REGISTRY.register_processor(
    UltravoxMultiModalProcessor,
    info=UltravoxProcessingInfo,
    dummy_inputs=UltravoxDummyInputsBuilder)
408
409
class UltravoxModel(nn.Module, SupportsMultiModal, SupportsPP, SupportsLoRA,
                    SupportsV0Only):
410
411
412
413
414
415

    packed_modules_mapping = {
        "qkv_proj": ["q_proj", "k_proj", "v_proj"],
        "gate_up_proj": ["gate_proj", "up_proj"]
    }

416
417
418
    hf_to_vllm_mapper = WeightsMapper(
        orig_to_new_prefix={"audio_tower.model.encoder.": "audio_tower."})

419
    def __init__(self, *, vllm_config: VllmConfig, prefix: str = ""):
420
        super().__init__()
421
422
        config = vllm_config.model_config.hf_config
        multimodal_config = vllm_config.model_config.multimodal_config
423
424
425
426
        self.config = config
        self.multi_modal_config = multimodal_config
        assert self.multi_modal_config

427
428
        self.secondary_weights = []
        self.audio_tower = ModifiedWhisperEncoder(config.audio_config)
429
        if config.audio_model_id is not None:
430
431
            # this prefix is not for initialization, but for loading weights
            # note the trailing dot
432
433
434
435
436
437
            self.secondary_weights.append(
                DefaultModelLoader.Source(
                    model_or_path=config.audio_model_id,
                    revision=None,
                    prefix="audio_tower.",
                ))
438
439
        self.multi_modal_projector = UltravoxProjector(config)
        self.language_model = init_vllm_registered_model(
440
            vllm_config=vllm_config,
441
442
443
            hf_config=config.text_config,
            prefix=maybe_prefix(prefix, "language_model"),
        )
444
        if config.text_model_id is not None:
445
446
            # this prefix is not for initialization, but for loading weights
            # note the trailing dot
447
448
449
450
            self.secondary_weights.append(
                DefaultModelLoader.Source(model_or_path=config.text_model_id,
                                          revision=None,
                                          prefix="language_model."))
451

452
453
454
455
456
457
458
459
        self.make_empty_intermediate_tensors = (
            self.language_model.make_empty_intermediate_tensors)

    @cached_property
    def sampler(self):
        if hasattr(self.language_model, "sampler"):
            return self.language_model.sampler

Joe Runde's avatar
Joe Runde committed
460
        return get_sampler()
461

462
463
464
465
466
467
468
469
470
471
    def get_mm_mapping(self) -> MultiModelKeys:
        """
        Get the module prefix in multimodal models
        """
        return MultiModelKeys.from_string_field(
            language_model="language_model.",
            connector="multi_modal_projector.",
            tower_model="audio_tower.",
        )

472
    def _audio_features_to_embeddings(
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
            self, input_features: torch.Tensor,
            audio_lens: torch.Tensor) -> torch.Tensor:
        audio_features = input_features.to(self.audio_tower.dtype)
        batch_size = audio_features.size(0)
        audio_embeddings = []

        # Process audio features in batches to keep memory usage predictable
        for start in range(0, batch_size, _MAX_ENCODER_BATCH_SIZE):
            end = min(start + _MAX_ENCODER_BATCH_SIZE, batch_size)
            # Process through audio tower
            batch_features = self.audio_tower(audio_features[start:end],
                                              audio_lens[start:end])
            batch_features = batch_features.to(self.audio_tower.dtype)

            # Process through projector
            batch_embeddings = self.multi_modal_projector(batch_features)
            audio_embeddings.append(batch_embeddings)

        # Concatenate results
        audio_embeddings = torch.cat(audio_embeddings, dim=0)
493
494
495
496
497
498
        return audio_embeddings

    def _parse_and_validate_audio_input(
            self, **kwargs: object) -> Optional[UltravoxAudioInputs]:
        audio_features = kwargs.pop("audio_features", None)
        audio_embeds = kwargs.pop("audio_embeds", None)
499
500
        audio_lens = kwargs.pop("audio_lens", None)
        audio_token_len = kwargs.pop("audio_token_len", None)
501
502
503
504
505
506
507
508
509
510

        if audio_features is None and audio_embeds is None:
            return None

        if audio_features is not None:
            if not isinstance(audio_features, (torch.Tensor, list)):
                raise ValueError("Incorrect type of audio features. "
                                 f"Got type: {type(audio_features)}")

            return UltravoxAudioFeatureInputs(type="audio_features",
511
512
513
                                              data=audio_features,
                                              lens=audio_lens,
                                              token_len=audio_token_len)
514
515

        if audio_embeds is not None:
516
            if not isinstance(audio_embeds, (torch.Tensor, list)):
517
518
519
520
521
522
523
524
525
                raise ValueError("Incorrect type of audio embeds. "
                                 f"Got type: {type(audio_embeds)}")

            return UltravoxAudioEmbeddingInputs(type="audio_embeds",
                                                data=audio_embeds)

        raise AssertionError("This line should be unreachable.")

    def _process_audio_input(
526
            self, audio_input: UltravoxAudioInputs) -> NestedTensors:
527
528
529
        if audio_input["type"] == "audio_embeds":
            return audio_input["data"]

530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
        # Pad and concatenate audio features
        # [[B1, 80, M1], [B2, 80, M2]] -> [B1+B2, 80, max(M1, M2)]
        audio_features = pad_and_concat_to_dim3(audio_input["data"])

        if isinstance(audio_input['lens'], list):
            # [B1, B2] -> [B1+B2]
            audio_lens = torch.cat(audio_input['lens'])
            audio_token_len = torch.cat(audio_input['token_len'])
        else:
            audio_lens = flatten_bn(audio_input['lens'])
            audio_token_len = flatten_bn(audio_input['token_len'])

        embeddings = self._audio_features_to_embeddings(
            audio_features, audio_lens)

        # We should flatten and concatenate embeddings based on token lengths
        # For example, with token_len = [4, 2, 3], flattened_embeddings will be
        # concat(embeddings[0][:4], embeddings[1][:2], embeddings[2][:3])
548

549
550
551
552
553
554
555
556
557
        # Create a mask of valid indices based on token lengths
        max_len = embeddings.shape[1]
        indices = torch.arange(max_len, device=embeddings.device).expand(
            embeddings.shape[0], -1)
        mask = indices < audio_token_len[:, None]
        # Apply mask and flatten
        flattened_embeddings = embeddings[mask]

        return flattened_embeddings
558

559
    def get_multimodal_embeddings(
560
            self, **kwargs: object) -> Optional[MultiModalEmbeddings]:
561
562
563
564
565
566
567
568
569
        audio_input = self._parse_and_validate_audio_input(**kwargs)
        if audio_input is None:
            return None
        audio_embeddings = self._process_audio_input(audio_input)
        return audio_embeddings

    def get_input_embeddings(
        self,
        input_ids: torch.Tensor,
570
        multimodal_embeddings: Optional[MultiModalEmbeddings] = None,
571
572
573
574
    ) -> torch.Tensor:
        inputs_embeds = self.language_model.get_input_embeddings(input_ids)
        if multimodal_embeddings is not None:

575
576
            # TODO(ywang96): remove this block after v0 is deprecated.
            if not envs.VLLM_USE_V1:
577
                attn_metadata = get_forward_context().attn_metadata
578
579
580
581
582
583
584
                merge_multimodal_embeddings_from_map(
                    inputs_embeds, multimodal_embeddings,
                    attn_metadata.multi_modal_placeholder_index_maps["audio"])
            else:
                inputs_embeds = merge_multimodal_embeddings(
                    input_ids, inputs_embeds, multimodal_embeddings,
                    _AUDIO_PLACEHOLDER_TOKEN)
585
586
587
588
589
590
591
        return inputs_embeds

    def forward(self,
                input_ids: torch.Tensor,
                positions: torch.Tensor,
                intermediate_tensors: Optional[torch.Tensor] = None,
                inputs_embeds: Optional[torch.Tensor] = None,
592
                **kwargs) -> Union[torch.Tensor, IntermediateTensors]:
593
594
595
596
597
598
599
600
601
602
        """Run forward pass for Ultravox

        One key thing to understand is the `input_ids` already accounts for the
        positions of the to-be-inserted audio embeddings. The to-be-inserted
        audio has a size that is essentially 6.25 tokens per second of audio.

        This way, the `positions` and `attn_metadata` are consistent
        with the `input_ids`.

        Args:
603
604
605
606
607
            audio_features: A batch of audio input chunks [B, N, 80, M].
            audio_lens: Length of audio frames for each audio chunk [B].
            audio_token_len: Length of audio tokens for each audio chunk [B'].
                Note: batch dim is different from batch dim in audio chunks.

608
        """
609

610
        if intermediate_tensors is not None:
611
            inputs_embeds = None
612
613
614
615
616
617
618

        # NOTE: In v1, inputs_embeds is always generated at model runner, this
        # condition is for v0 compatibility.
        elif inputs_embeds is None:
            multimodal_embeddings = self.get_multimodal_embeddings(**kwargs)

            inputs_embeds = self.get_input_embeddings(input_ids,
619
                                                      multimodal_embeddings)
620
621
622
623
624
625
            input_ids = None

        hidden_states = self.language_model.model(input_ids,
                                                  positions,
                                                  intermediate_tensors,
                                                  inputs_embeds=inputs_embeds)
626
627
628
629
630
631
632
633
634
635
636
637
638
639
        return hidden_states

    def compute_logits(self, hidden_states: torch.Tensor,
                       sampling_metadata: SamplingMetadata) -> torch.Tensor:
        return self.language_model.compute_logits(hidden_states,
                                                  sampling_metadata)

    def sample(
        self,
        logits: torch.Tensor,
        sampling_metadata: SamplingMetadata,
    ) -> Optional[SamplerOutput]:
        return self.language_model.sample(logits, sampling_metadata)

640
641
    def load_weights(self, weights: Iterable[Tuple[str,
                                                   torch.Tensor]]) -> Set[str]:
642
643
644

        loader = AutoWeightsLoader(self,
                                   ignore_unexpected_prefixes=["audio_tower."])
645
        return loader.load_weights(weights, mapper=self.hf_to_vllm_mapper)
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673


def pad_and_concat_to_dim3(
    features: Union[torch.Tensor, List[torch.Tensor], List[List[torch.Tensor]]]
) -> torch.Tensor:
    """
    Pad and concatenate a list of tensors.

    output:
        Tensor of shape [B, C, M] where M is the maximum length of the input
        tensors, B is the sum of the batch sizes of the input tensors.
        C must be the same for all input tensors.
    """
    if isinstance(features, torch.Tensor):
        if features.ndim > 3:
            # Flatten [B, N, 80, M] -> [B * N, 80, M]
            features = flatten_bn(features)
        return features

    features = [pad_and_concat_to_dim3(f) for f in features]

    max_len = max(f.shape[-1] for f in features)
    # Ensure all features have dim=3
    features = [f.view(-1, *f.shape[-2:]) for f in features]
    # Pad and oncatenate:
    # [[B1, 80, M1], [B2, 80, M2]] -> [B1+B2, 80, max(M1, M2)]
    features = [F.pad(f, (0, max_len - f.shape[-1])) for f in features]
    return torch.cat(features)