-
Notifications
You must be signed in to change notification settings - Fork 3.7k
Expand file tree
/
Copy pathtest_dynamic_engine.py
More file actions
2041 lines (1779 loc) · 85.6 KB
/
test_dynamic_engine.py
File metadata and controls
2041 lines (1779 loc) · 85.6 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
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
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
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
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
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
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
# Copyright (c) 2025 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
import asyncio
import gc
import math
import random
import types
from dataclasses import dataclass, field
from functools import partial
from typing import Dict, List, Optional, Tuple
import pytest
import torch
from tqdm import tqdm
from transformer_engine.pytorch.fp8 import check_fp8_support
from megatron.core import parallel_state
from megatron.core.inference.config import (
InferenceConfig,
KVCacheManagementMode,
MambaInferenceStateConfig,
)
from megatron.core.inference.contexts.dynamic_context import (
ActiveRequestCountOverflowError,
BlockOverflowError,
DynamicInferenceContext,
RequestOverflowError,
TokenOverflowError,
)
from megatron.core.inference.engines import DynamicInferenceEngine
from megatron.core.inference.engines.dynamic_engine import EngineState
from megatron.core.inference.inference_request import DynamicInferenceRequest, Status
from megatron.core.inference.model_inference_wrappers.gpt.gpt_inference_wrapper import (
GPTInferenceWrapper,
)
from megatron.core.inference.sampling_params import SamplingParams
from megatron.core.inference.text_generation_controllers.text_generation_controller import (
TextGenerationController,
)
from megatron.core.models.gpt.gpt_layer_specs import (
get_gpt_layer_local_spec,
get_gpt_layer_with_inference_spec,
get_gpt_layer_with_transformer_engine_spec,
)
from megatron.core.models.gpt.gpt_model import GPTModel
from megatron.core.models.mamba.mamba_layer_specs import mamba_stack_spec
from megatron.core.models.mamba.mamba_model import MambaModel
from megatron.core.ssm.mamba_mixer import _check_mamba_sequence_packing_support
from megatron.core.tensor_parallel.random import model_parallel_cuda_manual_seed
from megatron.core.transformer.cuda_graphs import CudaGraphManager, _CudagraphGlobalRecord
from megatron.core.transformer.enums import CudaGraphScope
from megatron.core.transformer.transformer_config import MLATransformerConfig, TransformerConfig
from megatron.core.utils import is_fa_min_version, is_te_min_version
from tests.unit_tests.test_utilities import Utils
try:
from torch_memory_saver import torch_memory_saver # noqa: F401
HAVE_TORCH_MEMORY_SAVER = True
except ImportError:
HAVE_TORCH_MEMORY_SAVER = False
def skip_if_mamba_sequence_packing_not_available(model_provider: str):
if model_provider == "mamba":
sequence_packing_available, reason_for_no_sequence_packing = (
_check_mamba_sequence_packing_support()
)
if not sequence_packing_available:
pytest.skip(reason_for_no_sequence_packing)
def set_rounder(value):
"""Utility function to set the DynamicInferenceContext rounder."""
DynamicInferenceContext.ROUNDER = value # For backwards compatibility
DynamicInferenceContext.TOKEN_ROUNDER = value
DynamicInferenceContext.REQUEST_ROUNDER = value
def mock_forward(input_ids, position_ids, attention_mask, *args, **kwargs):
"""Mock forward function to avoid numerics issues with random inputs."""
return torch.randn(
input_ids.size(0),
input_ids.size(1),
kwargs["vocab_size"],
device=input_ids.device,
dtype=torch.bfloat16,
)
@dataclass
class DynamicEngineTestConfig:
"""Test configuration args."""
random_seed = 123
vocab_size = 100
set_rounder(4)
num_requests: int = 2 * DynamicInferenceContext.round_up_requests(1, 1)
min_prompt_length: int = 4
max_prompt_length: int = 16
num_tokens_to_generate: Optional[int] = 4
num_tokens_total: Optional[int] = None
max_sequence_length: Optional[int] = None
num_gap_steps: int = 2
context_buffer_size_gb: float = 0.1 # enough room for all tokens.
context_paused_buffer_size_gb: float | None = None
context_block_size_tokens: int = 256
context_max_requests: Optional[int] = None
context_max_tokens: Optional[int] = None
tensor_model_parallel_size: int = 1
pipeline_model_parallel_size: int = 1
expert_model_parallel_size: int = 1
sequence_parallel: bool = False
use_fixed_output_lengths: bool = False
num_cuda_graphs: int = None
use_cuda_graphs_for_non_decode_steps: bool = True
fp8: bool = False
model_provider: str = "gpt"
return_log_probs: bool = False
materialize_only_last_token_logits: bool = True
skip_prompt_log_probs: bool = False
enable_chunked_prefill: bool = False
cuda_graph_scope: List[CudaGraphScope] = field(
default_factory=lambda: [CudaGraphScope.full_iteration_inference]
)
force_build_cuda_graphs: bool = False
transformer_impl: str = "local"
# If False, do not build cuda graphs in the tests, even if
# num_cuda_graphs is set.
# For tests concerning cuda-graph warmups, we set this to False
# to avoid the overhead of building the graphs, which is not
# relevant to the test. The tests only check if the required
# context attributes are set correctly.
suspend_resume_interval: Optional[int] = None
kv_cache_management_mode: str = "persist"
static_kv_memory_pointers: bool = True
track_generated_token_events: bool = False
use_mla: bool = False
cache_mla_latent: bool = False
def __post_init__(self):
assert self.max_sequence_length is None
assert (
self.num_tokens_to_generate is None or self.num_tokens_total is None
) and self.num_tokens_to_generate != self.num_tokens_total
if self.use_mla and self.cache_mla_latent:
# Fix paged KV cache block size requirement (needs to be divisible by 256).
# Note, this doesn't work with FlashMLA, which requires a block size of exactly 64.
self.context_block_size_tokens = 256
# Compute max_sequence_length.
if self.num_tokens_to_generate is not None:
self.max_sequence_length = self.max_prompt_length + self.num_tokens_to_generate
else:
self.max_sequence_length = self.num_tokens_total
# Default paused buffer size.
if self.context_paused_buffer_size_gb is None:
self.context_paused_buffer_size_gb = 0.2 * self.context_buffer_size_gb
@dataclass
class DynamicEngineTestEnv:
"""Test environment, including requests and engine."""
config: DynamicEngineTestConfig
requests: List[DynamicInferenceRequest]
engine: DynamicInferenceEngine
mem_usage: dict = field(
default_factory=lambda: {"start": None, "end": None, "suspend_resume": {}}
)
class TestDynamicInferenceEngine:
@classmethod
def _build_requests(cls, test_config: DynamicEngineTestConfig) -> List[DynamicInferenceRequest]:
requests = []
for request_id in range(test_config.num_requests):
# Prompt length.
if test_config.min_prompt_length == test_config.max_prompt_length:
prompt_length = test_config.min_prompt_length
else:
prompt_length = random.randint(
test_config.min_prompt_length, test_config.max_prompt_length + 1
)
# Num tokens to generate.
num_tokens_to_generate = test_config.num_tokens_to_generate
num_tokens_total = test_config.num_tokens_total
if test_config.use_fixed_output_lengths:
if num_tokens_to_generate is not None:
num_tokens_to_generate = random.randint(
1, test_config.max_sequence_length - prompt_length
)
else:
num_tokens_total = random.randint(
prompt_length + 1, test_config.max_sequence_length
)
# Sampling params.
sampling_params = SamplingParams(
num_tokens_to_generate=num_tokens_to_generate,
termination_id=(
-1 if test_config.use_fixed_output_lengths else test_config.vocab_size - 1
),
return_log_probs=test_config.return_log_probs,
skip_prompt_log_probs=test_config.skip_prompt_log_probs,
)
if not hasattr(sampling_params, "num_tokens_total"):
# Remove this if statement branch in megatron-core 0.16
sampling_params.add_attributes({"num_tokens_total": num_tokens_total})
else:
sampling_params.num_tokens_total = num_tokens_total
# Request.
prompt_tokens = torch.randint(
0,
test_config.vocab_size - 1,
(prompt_length,),
dtype=torch.int64,
device=torch.cuda.current_device(),
)
request = DynamicInferenceRequest(
request_id=request_id, prompt_tokens=prompt_tokens, sampling_params=sampling_params
)
requests.append(request)
return requests
@classmethod
def _build_inference_context(
cls,
test_config: DynamicEngineTestConfig,
transformer_config: TransformerConfig,
requests: List[DynamicInferenceRequest],
mamba_inference_state_config: Optional[MambaInferenceStateConfig] = None,
):
"""The inference context manages the KV cache and other inference state."""
# Inference context.
context = DynamicInferenceContext(
model_config=transformer_config,
inference_config=InferenceConfig(
max_sequence_length=test_config.max_sequence_length,
num_cuda_graphs=test_config.num_cuda_graphs,
use_cuda_graphs_for_non_decode_steps=True,
buffer_size_gb=test_config.context_buffer_size_gb,
paused_buffer_size_gb=test_config.context_paused_buffer_size_gb,
block_size_tokens=test_config.context_block_size_tokens,
max_requests=test_config.context_max_requests,
max_tokens=test_config.context_max_tokens,
mamba_inference_state_config=mamba_inference_state_config,
materialize_only_last_token_logits=test_config.materialize_only_last_token_logits,
kv_cache_management_mode=KVCacheManagementMode(
test_config.kv_cache_management_mode
),
static_kv_memory_pointers=test_config.static_kv_memory_pointers,
enable_chunked_prefill=test_config.enable_chunked_prefill,
use_flashinfer_fused_rope=None, # default to using flash-infer if available
# this is for compatibility with the LTS environment
unified_memory_level=0, # unit tests currently broken with UVM
track_generated_token_events=test_config.track_generated_token_events,
),
)
return context
@classmethod
@torch.inference_mode()
def _build_test_env(cls, test_config):
Utils.initialize_model_parallel(
tensor_model_parallel_size=test_config.tensor_model_parallel_size,
pipeline_model_parallel_size=test_config.pipeline_model_parallel_size,
)
set_rounder(4)
# Random state.
random.seed(test_config.random_seed)
torch.manual_seed(test_config.random_seed)
model_parallel_cuda_manual_seed(
seed=test_config.random_seed,
inference_rng_tracker=True,
use_cudagraphable_rng=False,
force_reset_rng=True,
)
# Requests.
requests = cls._build_requests(test_config)
# Values required for proper cache_mla_latent functioning
qk_head_dim = 128
qk_pos_emb_head_dim = 64
transformer_config_cls = (
partial(
MLATransformerConfig,
cache_mla_latents=test_config.cache_mla_latent,
qk_head_dim=qk_head_dim,
qk_pos_emb_head_dim=qk_pos_emb_head_dim,
# For cache_mla_latent, the following needs to hold:
# v_head_dim == qk_head_dim + qk_pos_emb_head_dim
v_head_dim=(
(qk_head_dim + qk_pos_emb_head_dim) if test_config.cache_mla_latent else 128
),
)
if test_config.use_mla
else TransformerConfig
)
if test_config.model_provider == "gpt":
# Transformer config.
transformer_config = transformer_config_cls(
params_dtype=torch.bfloat16,
num_layers=4,
hidden_size=128 if test_config.fp8 else 32,
num_attention_heads=4,
use_cpu_initialization=True,
cuda_graph_impl=(
"local"
if test_config.num_cuda_graphs is not None
and test_config.force_build_cuda_graphs
else "none"
),
inference_rng_tracker=True,
tensor_model_parallel_size=test_config.tensor_model_parallel_size,
pipeline_model_parallel_size=test_config.pipeline_model_parallel_size,
expert_model_parallel_size=test_config.expert_model_parallel_size,
num_moe_experts=(
None
if test_config.expert_model_parallel_size == 1
else test_config.expert_model_parallel_size
),
sequence_parallel=test_config.sequence_parallel,
pipeline_dtype=torch.bfloat16,
add_bias_linear=test_config.expert_model_parallel_size == 1
and not (test_config.transformer_impl == "inference_optimized"),
fp8="hybrid" if test_config.fp8 else None,
fp8_recipe="tensorwise" if test_config.fp8 else None,
inference_sampling_seed=test_config.random_seed,
cuda_graph_scope=test_config.cuda_graph_scope,
transformer_impl=test_config.transformer_impl,
normalization=(
"RMSNorm"
if test_config.transformer_impl == "inference_optimized"
else "LayerNorm"
),
# inference optimized currently only supports RMS Norm
)
if test_config.fp8 or test_config.transformer_impl == "transformer_engine":
layer_spec = get_gpt_layer_with_transformer_engine_spec(
multi_latent_attention=test_config.use_mla
)
elif test_config.transformer_impl == "local":
layer_spec = get_gpt_layer_local_spec(multi_latent_attention=test_config.use_mla)
elif test_config.transformer_impl == "inference_optimized":
layer_spec = get_gpt_layer_with_inference_spec(
multi_latent_attention=test_config.use_mla
)
# GPT model.
model = GPTModel(
config=transformer_config,
transformer_layer_spec=layer_spec,
vocab_size=test_config.vocab_size,
max_sequence_length=test_config.max_sequence_length,
parallel_output=True,
pre_process=parallel_state.is_pipeline_first_stage(),
post_process=parallel_state.is_pipeline_last_stage(),
).cuda()
elif test_config.model_provider == "mamba":
pp_size = test_config.pipeline_model_parallel_size
# Transformer config.
transformer_config = transformer_config_cls(
params_dtype=torch.bfloat16,
num_layers=(
3 if pp_size == 1 else 6
), # 1 Mamba layer, 1 attention layer, 1 MLP layer
hidden_size=256, # The Mamba layer places several constraints on this
mamba_num_heads=16,
num_attention_heads=16,
use_cpu_initialization=True,
cuda_graph_impl=(
"local"
if test_config.num_cuda_graphs is not None
and test_config.force_build_cuda_graphs
else "none"
),
inference_rng_tracker=True,
tensor_model_parallel_size=test_config.tensor_model_parallel_size,
pipeline_model_parallel_size=pp_size,
expert_model_parallel_size=test_config.expert_model_parallel_size,
num_moe_experts=(
None
if test_config.expert_model_parallel_size == 1
else test_config.expert_model_parallel_size
),
sequence_parallel=test_config.sequence_parallel,
pipeline_dtype=torch.bfloat16,
add_bias_linear=test_config.expert_model_parallel_size == 1,
fp8="hybrid" if test_config.fp8 else None,
fp8_recipe="tensorwise" if test_config.fp8 else None,
cuda_graph_scope=test_config.cuda_graph_scope,
is_hybrid_model=True, # Needs to be set for correct out_proj init
)
# Mamba model.
model = MambaModel(
config=transformer_config,
mamba_stack_spec=mamba_stack_spec,
vocab_size=test_config.vocab_size,
max_sequence_length=test_config.max_sequence_length,
parallel_output=True,
hybrid_layer_pattern=(
"M*-" if pp_size == 1 else "M*-|M*-"
), # 3 or 6 layers (2 PP stages)
pre_process=parallel_state.is_pipeline_first_stage(),
post_process=parallel_state.is_pipeline_last_stage(),
).cuda()
else:
raise ValueError(f"Invalid model provider {test_config.model_provider}")
for param in model.parameters():
param.data = param.data.to(transformer_config.params_dtype)
model.eval()
mamba_inference_state_config = MambaInferenceStateConfig.from_model(model)
# Inference context.
inference_context = cls._build_inference_context(
test_config=test_config,
transformer_config=transformer_config,
requests=requests,
mamba_inference_state_config=mamba_inference_state_config,
)
# Inference model wrapper.
inference_wrapped_model = GPTInferenceWrapper(model, inference_context)
# Note: the following is taken from AbstractModelInferenceWrapper.prep_model_for_inference().
inference_wrapped_model.model_is_pipeline_parallel = not (
parallel_state.is_pipeline_first_stage() and parallel_state.is_pipeline_last_stage()
)
# Text generation controller.
text_generation_controller = TextGenerationController(
inference_wrapped_model=inference_wrapped_model,
tokenizer=types.SimpleNamespace(
vocab_size=test_config.vocab_size, detokenize=lambda tokens: "tokenized_prompt"
),
)
# Reset global cuda graph state.
_CudagraphGlobalRecord.cudagraph_created = False
_CudagraphGlobalRecord.cudagraph_record = []
CudaGraphManager.global_mempool = None
# Inference engine.
engine = DynamicInferenceEngine(text_generation_controller, inference_context)
# Test env.
env = DynamicEngineTestEnv(config=test_config, requests=requests, engine=engine)
return env
@classmethod
@torch.inference_mode()
def _run_step(cls, env):
set_rounder(4)
# Step inference engine (i.e., generate one token per request).
# It's safe to use request 0's sampling params here because
# the only thing that differs between requests is num_tokens_to_generate,
# and engine.async_step() doesn't use this sampling param's
# num_tokens_to_generate.
result = env.engine.step_modern()
# Suspend + resume.
if (
env.config.suspend_resume_interval is not None
and env.engine.context.step_count % env.config.suspend_resume_interval == 0
):
suspend_resume_mems = {}
suspend_resume_mems["start"] = torch.cuda.memory_stats()
env.engine.suspend() # suspend.
suspend_resume_mems["mid"] = torch.cuda.memory_stats()
env.engine.resume() # resume.
suspend_resume_mems["end"] = torch.cuda.memory_stats()
env.mem_usage["suspend_resume"][env.engine.context.step_count] = suspend_resume_mems
# Nothing done?
finished_request_records = result["finished_request_records"]
if len(finished_request_records) == 0:
return
# Append output tokens.
for finished_request_record in finished_request_records:
finished_request = finished_request_record.merge()
request = env.requests[finished_request.request_id]
request.output = finished_request.generated_tokens
request.status = finished_request.status
@classmethod
@torch.inference_mode()
def _run_test(cls, **test_config_kwargs):
# Test environment.
test_config = DynamicEngineTestConfig(**test_config_kwargs)
env = cls._build_test_env(test_config)
# Add requests to engine.
env.mem_usage["start"] = torch.cuda.memory_stats()
for request in tqdm(env.requests, "add requests"):
# Add request.
env.engine._add_request(request)
request.state = "pending"
# Insert gap steps between adding requests.
for _ in range(test_config.num_gap_steps):
cls._run_step(env)
# Step engine until finished.
while True:
# Run at least one step to collect failed requests.
cls._run_step(env)
if not env.engine.has_unfinished_requests():
break
# Validate all requests finished.
for request in env.requests:
assert request.status in (
Status.COMPLETED,
Status.FAILED,
), f"request.status == '{request.status}'."
num_tokens_to_generate = request.sampling_params.num_tokens_to_generate
num_tokens_total = request.sampling_params.num_tokens_total
num_tokens_expected = (
num_tokens_to_generate
if num_tokens_total is None
else num_tokens_total - len(request.prompt_tokens)
)
# Validate the output length only if suspend_resume_interval is None.
# If it is not None, then the output length could be anything in the
# range [1, num_tokens_to_generate].
if test_config.suspend_resume_interval is None:
assert (
(num_tokens_to_generate is None and num_tokens_total is None)
or len(request.generated_tokens) <= num_tokens_expected
or request.status == Status.FAILED
), (
f"Request {request.request_id} expected to generate {num_tokens_to_generate} "
f"tokens but generated {len(request.generated_tokens)}"
)
env.mem_usage["end"] = torch.cuda.memory_stats()
return env
def teardown_method(self, method):
set_rounder(64)
Utils.destroy_model_parallel()
@pytest.mark.internal
@pytest.mark.skipif(
not is_fa_min_version("2.7.3"), reason="need latest flash attn for dynamic batching"
)
@pytest.mark.parametrize("model_provider", ["gpt", "mamba"])
@pytest.mark.parametrize("num_cuda_graphs", [None, 1, 4, -1])
@pytest.mark.parametrize("cuda_graph_scope", [[], [CudaGraphScope.full_iteration_inference]])
def test_simple(self, model_provider, num_cuda_graphs, cuda_graph_scope) -> None:
"""Simple test that runs without errors, and validates output."""
skip_if_mamba_sequence_packing_not_available(model_provider)
num_tokens_to_generate = 16
# Run test.
env = self._run_test(
num_tokens_to_generate=num_tokens_to_generate,
model_provider=model_provider,
num_cuda_graphs=num_cuda_graphs,
cuda_graph_scope=cuda_graph_scope,
force_build_cuda_graphs=True,
context_max_requests=128,
)
# Validate max_requests, max_tokens.
assert env.engine.context.max_tokens == DynamicInferenceContext.DEFAULT_MAX_TOKENS
if num_cuda_graphs is not None:
assert env.engine.context.cuda_graph_token_counts is not None
assert env.engine.context.cuda_graph_batch_dimensions_list
model = env.engine.controller.inference_wrapped_model.model
if cuda_graph_scope == [CudaGraphScope.full_iteration_inference]:
# check if cudagraph runners are created at the decoder level
assert model.decoder.cudagraph_manager.cudagraph_runners
else:
# check if cudagraph runners are created at the layer level
for layer in model.decoder.layers:
assert layer.cudagraph_manager.cudagraph_runners
# Validate generated tokens.
gpt_expected_generated_tokens = [
[69, 85, 55, 74, 56, 89, 64, 59, 55, 67, 15, 58, 6, 37, 54, 47],
[29, 54, 33, 72, 45, 76, 41, 56, 28, 25, 17, 2, 61, 6, 98, 76],
[35, 78, 54, 16, 79, 98, 22, 5, 60, 0, 1, 76, 77, 11, 25, 7],
[25, 75, 57, 85, 81, 37, 88, 17, 71, 15, 70, 64, 50, 0, 64, 45],
[32, 5, 85, 75, 30, 68, 23, 33, 20, 26, 89, 20, 92, 97, 38, 81],
[33, 69, 32, 49, 93, 24, 33, 6, 97, 36, 37, 99],
[82, 78, 78, 65, 22, 1, 87, 42, 36, 26, 27, 56, 82, 32, 8, 80],
[],
]
mamba_expected_generated_tokens = [
[74, 72, 9, 59, 1, 70, 15, 89, 30, 52, 82, 70, 64, 16, 83, 5],
[25, 54, 28, 14, 87, 27, 60, 92, 28, 74, 8, 63, 60, 68, 87, 82],
[31, 21, 87, 25, 96, 13, 32, 49, 40, 54, 55, 68, 73, 2, 64, 96],
[72, 80, 35, 72, 77, 85, 98, 36, 4, 97, 37, 46, 79, 95, 83, 25],
[8, 80, 56, 4, 87, 1, 43, 98, 85, 7, 50, 38, 24, 28, 18, 80],
[9, 94, 36, 16, 87, 57, 25, 76, 64, 92, 47, 86, 73, 72, 71, 97],
[17, 5, 62, 66, 15, 52, 32, 75, 66, 18, 90, 14, 67, 37, 94, 33],
[],
]
if model_provider == "gpt":
expected_generated_tokens_list = gpt_expected_generated_tokens
elif model_provider == "mamba":
expected_generated_tokens_list = mamba_expected_generated_tokens
else:
raise ValueError(f"Invalid model_provider {model_provider}")
print(f"Validating {len(env.requests)} requests.")
print(f"Expected generated tokens: {expected_generated_tokens_list}")
print(f"Actual generated tokens: {[request.generated_tokens for request in env.requests]}")
assert len(env.requests) == len(expected_generated_tokens_list)
for request, expected_generated_tokens in zip(env.requests, expected_generated_tokens_list):
assert request.generated_tokens == expected_generated_tokens, (
f"request {request.request_id}, "
f"result ({request.generated_tokens}) != "
f"expected ({expected_generated_tokens})."
)
@pytest.mark.skipif(
not is_fa_min_version("2.7.3"), reason="need latest flash attn for dynamic batching"
)
@torch.inference_mode()
def test_token_overflow_transient(self) -> None:
"""Test token overflow."""
test_config = DynamicEngineTestConfig(
num_requests=2,
min_prompt_length=512,
max_prompt_length=512,
num_tokens_to_generate=2,
context_max_tokens=900,
)
env = self._build_test_env(test_config)
env.engine._add_request(env.requests[0])
env.engine._add_request(env.requests[1])
env.engine.schedule_waiting_requests()
assert list(env.engine.waiting_request_ids) == [1]
@pytest.mark.internal
@pytest.mark.skipif(
not is_fa_min_version("2.7.3"), reason="need latest flash attn for dynamic batching"
)
@pytest.mark.skip(
reason="activate for `megatron-core >= 0.16`, after fixing "
"`raise TokenOverflowError(is_transient=False)` compatibility with "
"legacy tests."
)
def test_token_overflow_nontransient(self) -> None:
"""Test token overflow (non-transient)."""
test_config = DynamicEngineTestConfig(context_max_tokens=8)
env = self._build_test_env(test_config)
try:
env.engine._add_request(env.requests[0])
except TokenOverflowError as e:
assert e.is_transient == False
else:
raise Exception("should have raised TokenOverflowError(is_transient=False).")
@pytest.mark.internal
@pytest.mark.skipif(
not is_fa_min_version("2.7.3"), reason="need latest flash attn for dynamic batching"
)
@pytest.mark.parametrize("model_provider", ["gpt", "mamba"])
def test_block_overflow(self, model_provider: str) -> None:
"""Test block overflow."""
skip_if_mamba_sequence_packing_not_available(model_provider)
env = self._build_test_env(DynamicEngineTestConfig(model_provider=model_provider))
context = env.engine.context
block_size_bytes = context.block_size_bytes
buffer_size_gb = (block_size_bytes + 1) / 1024**3
test_config = DynamicEngineTestConfig(
context_buffer_size_gb=buffer_size_gb, model_provider=model_provider
)
env = self._build_test_env(test_config)
env.engine._add_request(env.requests[0])
assert list(env.engine.waiting_request_ids) == [0]
@pytest.mark.internal
@pytest.mark.skipif(
not is_fa_min_version("2.7.3"), reason="need latest flash attn for dynamic batching"
)
@pytest.mark.parametrize("model_provider", ["gpt", "mamba"])
def test_multi_add(self, model_provider: str) -> None:
"""Test adding multiple requests simultaneously."""
skip_if_mamba_sequence_packing_not_available(model_provider)
self._run_test(num_gap_steps=0, model_provider=model_provider)
@pytest.mark.internal
@pytest.mark.skipif(
not is_fa_min_version("2.7.3"), reason="need latest flash attn for dynamic batching"
)
@pytest.mark.parametrize("model_provider", ["gpt", "mamba"])
def test_fixed_output_lengths(self, model_provider: str) -> None:
"""Test generating a fixed number of output tokens."""
skip_if_mamba_sequence_packing_not_available(model_provider)
self._run_test(use_fixed_output_lengths=True, model_provider=model_provider)
@pytest.mark.internal
@pytest.mark.skipif(
not is_fa_min_version("2.7.3"), reason="need latest flash attn for dynamic batching"
)
def test_cuda_graph_token_counts(self) -> None:
"""Test initialization of `cuda_graph_token_counts` in dynamic context."""
# Test num_cuda_graphs.
for num_cuda_graphs, expected_cuda_graph_token_counts in [
(0, [80]),
(1, [80]),
(2, [80, 40]),
(4, [80, 72, 48, 24]),
(8, [80, 64, 48, 32, 16]),
(16, [80, 72, 64, 56, 48, 40, 32, 24, 16, 8]),
(32, [80, 72, 64, 56, 48, 40, 32, 24, 16, 8]),
]:
# Build cuda graphs (inside dynamic engine).
env = self._build_test_env(
DynamicEngineTestConfig(
context_buffer_size_gb=0.01, num_cuda_graphs=num_cuda_graphs
)
)
actual_cuda_graph_token_counts = env.engine.context.cuda_graph_token_counts
assert (
actual_cuda_graph_token_counts == expected_cuda_graph_token_counts
), "num_cuda_graphs %d ... cuda_graph_token_counts: expected %s, found %s." % (
num_cuda_graphs,
expected_cuda_graph_token_counts,
actual_cuda_graph_token_counts,
)
@pytest.mark.internal
@pytest.mark.skipif(
not is_fa_min_version("2.7.3"), reason="need latest flash attn for dynamic batching"
)
@pytest.mark.parametrize("model_provider", ["gpt", "mamba"])
@torch.inference_mode()
def test_generate_function(self, model_provider: str) -> None:
"""Test the generate function that processes multiple prompts at once."""
skip_if_mamba_sequence_packing_not_available(model_provider)
# Set up test environment
test_config = DynamicEngineTestConfig(
num_requests=4,
max_prompt_length=8,
num_tokens_to_generate=4,
model_provider=model_provider,
)
env = self._build_test_env(test_config)
# Create string prompts (just mock strings, since the test environment mocks the tokenizer)
prompts = ["prompt1", "prompt2", "prompt3", "prompt4"]
# Mock the tokenize_prompt method to return predictable token sequences
def mock_tokenize_prompt(prompt, add_BOS=False):
# Return a token sequence based on the prompt number
prompt_num = int(prompt[-1])
return [10 + i for i in range(prompt_num + 2)]
env.engine.controller.tokenize_prompt = mock_tokenize_prompt
# Call the generate function.
# It's safe to use request 0's sampling params here because all sampling
# params are identical as long as use_fixed_output_lengths == False.
finished_request_records = env.engine.generate(prompts, env.requests[0].sampling_params)
finished_requests = [r.merge() for r in finished_request_records]
# Verify results
assert len(finished_requests) == len(
prompts
), "Should return same number of finished requests as prompts"
request_ids = [r.request_id for r in finished_requests]
assert request_ids == sorted(
request_ids
), f"Request ids are not in sorted order: {request_ids}"
# Check each request was processed
for i, request in enumerate(finished_requests):
# Verify each request has generated tokens
assert len(request.generated_tokens) > 0, f"Request {i} should have generated tokens"
assert request.status == Status.COMPLETED, f"Request {i} should be completed"
@pytest.mark.internal
@pytest.mark.asyncio
@pytest.mark.skipif(
not is_fa_min_version("2.7.3"), reason="need latest flash attn for dynamic batching"
)
async def test_run_engine(self):
"""
Test asynchronously adding and waiting for requests while the engine is
running continuously.
"""
# Have to wrap inference mode in-line because async functions are not supported
with torch.inference_mode():
# Test environment.
test_config = DynamicEngineTestConfig(num_requests=8, use_fixed_output_lengths=True)
env = self._build_test_env(test_config)
engine_task = asyncio.create_task(env.engine.run_engine())
request_completion_futures: Dict[int, asyncio.Future[DynamicInferenceRequest]] = {}
# Add requests to engine.
for request in tqdm(env.requests, "add requests"):
request_completion_futures[request.request_id] = env.engine._add_request(request)
# Wait for all requests to complete.
await asyncio.gather(*request_completion_futures.values())
# Verify that all request outputs were set.
for request_id, fut in request_completion_futures.items():
num_tokens_to_generate = env.requests[
request_id
].sampling_params.num_tokens_to_generate
request_record = fut.result()
request = request_record.merge()
assert request.generated_length == num_tokens_to_generate, (
f"Request {request_id} expected to generate {num_tokens_to_generate} "
f"tokens but generated {request.generated_length}"
)
engine_task.cancel()
@pytest.mark.internal
@pytest.mark.skipif(
not is_fa_min_version("2.7.3"), reason="need latest flash attn for dynamic batching"
)
@pytest.mark.skipif(not is_te_min_version("2.2.0"), reason="TE 2.2.0 is required")
@pytest.mark.parametrize("model_provider", ["gpt", "mamba"])
def test_fp8_inference(self, model_provider: str):
skip_if_mamba_sequence_packing_not_available(model_provider)
fp8_available, reason_for_no_fp8 = check_fp8_support()
if not fp8_available:
pytest.skip(reason_for_no_fp8)
self._run_test(model_provider=model_provider, fp8=True)
@pytest.mark.skipif(
not is_fa_min_version("2.7.3"), reason="need latest flash attn for dynamic batching"
)
@torch.inference_mode()
def test_return_log_probs(self):
"""Verify that log probs are returned and computed correctly."""
# Returning log probs requires materializing the full prompt logits or
# explicitly disabling prompt logits.
with pytest.raises(AssertionError):
env = self._run_test(return_log_probs=True, materialize_only_last_token_logits=True)
# Test with full logits materialization
env = self._run_test(
return_log_probs=True,
materialize_only_last_token_logits=False,
num_tokens_to_generate=5,
)
# Validate log probs for each completed request
for request in env.requests:
if request.status != Status.COMPLETED:
continue
# Validate prompt log probs
if request.prompt_log_probs is not None and len(request.prompt_log_probs) > 0:
prompt_len = len(request.prompt_tokens)
# Should have log probs for all tokens except the first one
assert len(request.prompt_log_probs) == prompt_len - 1, (
f"Request {request.request_id}: Expected {prompt_len - 1} prompt log probs, "
f"got {len(request.prompt_log_probs)}"
)
# Validate each prompt log prob
for i, log_prob in enumerate(request.prompt_log_probs):
assert not math.isnan(
log_prob
), f"Request {request.request_id}, prompt token {i}: log_prob is NaN"
assert not math.isinf(
log_prob
), f"Request {request.request_id}, prompt token {i}: log_prob is inf"
assert log_prob <= 0.0, (
f"Request {request.request_id}, prompt token {i}: "
f"log_prob {log_prob} should be <= 0"
)
assert log_prob >= -50.0, (
f"Request {request.request_id}, prompt token {i}: "
f"log_prob {log_prob} is unreasonably small"
)
# Validate generated log probs
assert (
request.generated_log_probs is not None
), f"Request {request.request_id}: generated_log_probs should not be None"
assert len(request.generated_log_probs) == len(request.generated_tokens), (
f"Request {request.request_id}: Expected {len(request.generated_tokens)} "
f"generated log probs, got {len(request.generated_log_probs)}"
)
# Validate each generated log prob
for i, log_prob in enumerate(request.generated_log_probs):
assert not math.isnan(
log_prob
), f"Request {request.request_id}, generated token {i}: log_prob is NaN"
assert not math.isinf(
log_prob
), f"Request {request.request_id}, generated token {i}: log_prob is inf"
assert log_prob <= 0.0, (
f"Request {request.request_id}, generated token {i}: "
f"log_prob {log_prob} should be <= 0"
)
assert log_prob >= -50.0, (
f"Request {request.request_id}, generated token {i}: "
f"log_prob {log_prob} is unreasonably small"
)
# Validate that all generated tokens are valid
for i, token_id in enumerate(request.generated_tokens):
assert 0 <= token_id < env.config.vocab_size, (
f"Request {request.request_id}, token {i}: token_id {token_id} "
f"is out of valid range [0, {env.config.vocab_size})"
)
# Test with skipping prompt log probs
env = self._run_test(
return_log_probs=True,
materialize_only_last_token_logits=True,
skip_prompt_log_probs=True,
num_tokens_to_generate=5,
)
# Validate that prompt log probs are empty/None when skipped
for request in env.requests:
if request.status != Status.COMPLETED:
continue
# When skip_prompt_log_probs is True, prompt_log_probs should be empty
assert request.prompt_log_probs is None or len(request.prompt_log_probs) == 0, (
f"Request {request.request_id}: prompt_log_probs should be empty when "
f"skip_prompt_log_probs=True, but got {len(request.prompt_log_probs)} items"
)
# Generated log probs should still be present
assert (
request.generated_log_probs is not None and len(request.generated_log_probs) > 0
), f"Request {request.request_id}: generated_log_probs should be present"
# Validate generated log probs are still valid
for i, log_prob in enumerate(request.generated_log_probs):
assert not math.isnan(log_prob) and not math.isinf(log_prob), (
f"Request {request.request_id}, generated token {i}: "
f"log_prob {log_prob} is invalid"
)
assert -50.0 <= log_prob <= 0.0, (
f"Request {request.request_id}, generated token {i}: "
f"log_prob {log_prob} is out of expected range [-50.0, 0.0]"
)
@pytest.mark.skipif(
not is_fa_min_version("2.7.3"), reason="need latest flash attn for dynamic batching"
)
@torch.inference_mode()
def test_log_probs_token_correspondence(self):
"""
Verify that log probabilities correspond to the actual sampled tokens.
This test checks that the log probability reported for each token actually
corresponds to that token's probability in the distribution.
"""
# Run test with log probs enabled
env = self._run_test(