Repository navigation
Expand file tree
/
Copy pathtest_config.py
More file actions
5625 lines (4875 loc) · 244 KB
/
Copy pathtest_config.py
File metadata and controls
5625 lines (4875 loc) · 244 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. All rights reserved.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
import json
import os
import warnings
from dataclasses import dataclass, fields
from types import SimpleNamespace
from typing import Any, Optional, Union
from unittest.mock import MagicMock, patch
import pytest
import torch
from megatron.bridge.data.builders import (
DirectHFSFTDatasetConfig,
EnergonDatasetConfig,
GPTSFTDatasetConfig,
HFDatasetSourceConfig,
HFEnergonTaskEncoderConfig,
MockVLMSFTDatasetConfig,
QwenVLEnergonTaskEncoderConfig,
)
from megatron.bridge.models.gpt.model_config import BridgeGPTModelConfig
from megatron.bridge.models.gpt_provider import GPTModelProvider
from megatron.bridge.models.mla_provider import MLAModelProvider
from megatron.bridge.models.qwen_vl.qwen3_vl_provider import Qwen3VLModelProvider
from megatron.bridge.models.t5_provider import T5ModelProvider
from megatron.bridge.models.transformer_config import (
_HYBRIDEP_PADDING_FIELDS,
HeterogeneousTransformerConfig,
TransformerConfig,
)
from megatron.bridge.training.comm_overlap import CommOverlapConfig
from megatron.bridge.training.config import (
CheckpointConfig,
ConfigContainer,
DatasetProvider,
DistributedDataParallelConfig,
DistributedInitConfig,
GPTDatasetConfig,
GPTFIMDatasetConfig,
LoggerConfig,
MockGPTDatasetConfig,
NVRxStragglerDetectionConfig,
OptimizerConfig,
ProfilingConfig,
RerunStateMachineConfig,
RNGConfig,
SchedulerConfig,
TrainingConfig,
ValidationConfig,
_validate_and_sync_distributed_optimizer_settings,
_validate_mixed_precision_consistency,
apply_environment_variables,
megatron_mimo_runtime_config_update,
)
from megatron.bridge.training.mixed_precision import MixedPrecisionConfig
from megatron.bridge.training.tokenizers.config import TokenizerConfig
from megatron.bridge.utils.cuda_graph import (
cuda_graph_module_names,
set_cuda_graph_modules,
set_full_iteration_cuda_graph,
)
def mock_get_world_size_safe(world_size_to_return: int):
"""
Factory for a mock version of `get_world_size_safe`.
Args:
world_size_to_return: The integer value the mock function should return.
Returns:
A function that, when called, returns `world_size_to_return`.
"""
def _mock():
return world_size_to_return
return _mock
def create_test_gpt_config(**kwargs: Any) -> GPTModelProvider:
"""Creates an instance of GPTConfig for testing."""
defaults = {
"num_layers": 1,
"hidden_size": 128,
"num_attention_heads": 4,
"seq_length": 512,
"apply_rope_fusion": False,
}
defaults.update(kwargs)
return GPTModelProvider(**defaults)
def create_test_qwen3_vl_config(**kwargs: Any) -> Qwen3VLModelProvider:
"""Create a minimal Qwen3-VL provider for configuration validation."""
defaults = {
"num_layers": 1,
"hidden_size": 128,
"num_attention_heads": 4,
"seq_length": 512,
"apply_rope_fusion": False,
}
defaults.update(kwargs)
return Qwen3VLModelProvider(**defaults)
def create_test_deepseek_config(**kwargs: Any) -> MLAModelProvider:
"""Creates an instance of MLAModelProvider for testing."""
defaults = {
"num_layers": 1,
"hidden_size": 128,
"num_attention_heads": 4,
"seq_length": 512,
"apply_rope_fusion": False,
}
defaults.update(kwargs)
return MLAModelProvider(**defaults)
def create_test_t5_config(**kwargs: Any) -> T5ModelProvider:
"""Creates an instance of T5Config with sensible defaults for testing."""
defaults = {
"num_layers": 1,
"hidden_size": 128,
"num_attention_heads": 4,
"seq_length": 512,
"apply_rope_fusion": False,
}
defaults.update(kwargs)
return T5ModelProvider(**defaults)
def create_test_training_config(**kwargs: Any) -> TrainingConfig:
"""Creates an instance of TrainingConfig with defaults for testing."""
defaults = {
"global_batch_size": 32,
"micro_batch_size": 1,
"train_iters": 1000,
}
defaults.update(kwargs)
return TrainingConfig(**defaults)
def create_test_optimizer_config(**kwargs: Any) -> OptimizerConfig:
"""Creates an instance of OptimizerConfig with defaults for testing."""
defaults = {
"lr": 0.0001,
"use_distributed_optimizer": False,
}
defaults.update(kwargs)
return OptimizerConfig(**defaults)
def create_test_scheduler_config(**kwargs: Any) -> SchedulerConfig:
"""Creates an instance of SchedulerConfig with defaults for testing."""
defaults = {
"lr_decay_style": "linear",
"lr_warmup_iters": 0,
}
defaults.update(kwargs)
return SchedulerConfig(**defaults)
def create_test_gpt_dataset_config(sequence_length: int) -> GPTDatasetConfig:
"""Creates an instance of GPTDatasetConfig with defaults for testing."""
return GPTDatasetConfig(
random_seed=1234,
seq_length=sequence_length,
reset_position_ids=False,
reset_attention_mask=False,
eod_mask_loss=False,
)
def create_test_gpt_sft_dataset_config(sequence_length: int) -> GPTSFTDatasetConfig:
"""Create a GPTSFTDatasetConfig with defaults for testing."""
return GPTSFTDatasetConfig(seq_length=sequence_length, dataset_root="/tmp/dataset")
def create_test_direct_hf_sft_dataset_config(sequence_length: int) -> DirectHFSFTDatasetConfig:
"""Create a DirectHFSFTDatasetConfig with defaults for testing."""
return DirectHFSFTDatasetConfig(
seq_length=sequence_length,
source=HFDatasetSourceConfig(path_or_dataset="json"),
)
def create_test_energon_dataset_config(sequence_length: int, micro_batch_size: int = 1) -> EnergonDatasetConfig:
"""Create a serializable Energon config with generic HF task encoding."""
return EnergonDatasetConfig(
path="/tmp/energon",
seq_length=sequence_length,
micro_batch_size=micro_batch_size,
task_encoder=HFEnergonTaskEncoderConfig(hf_processor_path="org/model"),
)
def create_test_qwen_native_energon_dataset_config(sequence_length: int) -> EnergonDatasetConfig:
"""Create an Energon config using Qwen-VL native online packing."""
return EnergonDatasetConfig(
path="/tmp/energon",
seq_length=sequence_length,
micro_batch_size=1,
packing_buffer_size=32,
task_encoder=QwenVLEnergonTaskEncoderConfig(hf_processor_path="Qwen/model"),
)
def create_test_mock_vlm_dataset_config(sequence_length: int) -> MockVLMSFTDatasetConfig:
"""Create a synthetic VLM config with no runtime processor."""
return MockVLMSFTDatasetConfig(seq_length=sequence_length, hf_processor_path="org/model", num_images=0)
def create_test_logger_config(**kwargs: Any) -> LoggerConfig:
"""Creates an instance of LoggerConfig with defaults for testing."""
return LoggerConfig(**kwargs)
def create_test_tokenizer_config(**kwargs: Any) -> TokenizerConfig:
"""Creates an instance of TokenizerConfig with defaults for testing."""
return TokenizerConfig(**kwargs)
def create_test_checkpoint_config(**kwargs: Any) -> CheckpointConfig:
"""Creates an instance of CheckpointConfig with defaults for testing."""
defaults = {
"ckpt_format": "torch_dist",
}
defaults.update(kwargs)
return CheckpointConfig(**defaults)
def create_test_distributed_init_config(**kwargs: Any) -> DistributedInitConfig:
"""Creates an instance of DistributedInitConfig with defaults for testing."""
defaults = {
"use_gloo_process_groups": True,
"lazy_mpu_init": False,
}
defaults.update(kwargs)
return DistributedInitConfig(**defaults)
def create_test_ddp_config(**kwargs: Any) -> DistributedDataParallelConfig:
"""Creates an instance of DistributedDataParallelConfig with defaults for testing."""
return DistributedDataParallelConfig(**kwargs)
def create_test_profiling_config(**kwargs: Any) -> ProfilingConfig:
"""Creates an instance of ProfilingConfig with defaults for testing."""
defaults = {
"use_pytorch_profiler": False,
"use_nsys_profiler": False,
}
defaults.update(kwargs)
return ProfilingConfig(**defaults)
def create_test_nvrx_straggler_config(**kwargs: Any) -> NVRxStragglerDetectionConfig:
"""Creates an instance of NVRxStragglerDetectionConfig with defaults for testing."""
defaults = {
"calc_relative_gpu_perf": True,
"calc_individual_gpu_perf": True,
}
defaults.update(kwargs)
return NVRxStragglerDetectionConfig(**defaults)
def create_test_config_container(
world_size_override: int,
model_config: Union[GPTModelProvider, T5ModelProvider],
train_config: Optional[TrainingConfig] = None,
optimizer_config: Optional[OptimizerConfig] = None,
scheduler_config: Optional[SchedulerConfig] = None,
dataset_config_override: GPTDatasetConfig | DatasetProvider | None = None,
logger_config: Optional[LoggerConfig] = None,
tokenizer_config: Optional[TokenizerConfig] = None,
checkpoint_config: Optional[CheckpointConfig] = None,
dist_config: Optional[DistributedInitConfig] = None,
profiling_config: Optional[ProfilingConfig] = None,
ddp_config: Optional[DistributedDataParallelConfig] = None,
validation_config: Optional[ValidationConfig] = None,
):
"""
Helper to create a ConfigContainer with specified or default test configurations.
Monkeypatches `get_world_size_safe` for the duration of the test.
Args:
world_size_override: The world size for the mock `get_world_size_safe`.
model_config: The model configuration (GPTConfig or T5Config).
train_config: Optional override for training configuration.
optimizer_config: Optional override for optimizer configuration.
scheduler_config: Optional override for scheduler configuration.
dataset_config_override: Optional override for dataset configuration.
logger_config: Optional override for logger configuration.
tokenizer_config: Optional override for tokenizer configuration.
checkpoint_config: Optional override for checkpoint configuration.
dist_config: Optional override for distributed initialization configuration.
profiling_config: Optional override for profiling configuration.
Returns:
A tuple containing the ConfigContainer instance, the original
`get_world_size_safe` function, and the config module reference.
"""
final_dataset_config: GPTDatasetConfig | DatasetProvider
if dataset_config_override:
final_dataset_config = dataset_config_override
elif isinstance(model_config, (GPTModelProvider, T5ModelProvider)): # T5 also uses GPTDataset for these tests
final_dataset_config = create_test_gpt_dataset_config(sequence_length=model_config.seq_length)
else:
raise ValueError(f"Unsupported model_config type for default dataset_config: {type(model_config)}")
container = ConfigContainer(
train=train_config or create_test_training_config(),
model=model_config,
optimizer=optimizer_config or create_test_optimizer_config(),
scheduler=scheduler_config or create_test_scheduler_config(),
dataset=final_dataset_config,
logger=logger_config or create_test_logger_config(),
tokenizer=tokenizer_config or create_test_tokenizer_config(),
checkpoint=checkpoint_config or create_test_checkpoint_config(),
dist=dist_config or create_test_distributed_init_config(),
ddp=ddp_config or create_test_ddp_config(),
rng=RNGConfig(),
rerun_state_machine=RerunStateMachineConfig(),
profiling=profiling_config,
validation=validation_config or ValidationConfig(),
)
# Monkeypatch get_world_size_safe for this test
import megatron.bridge.training.config as config_module
original_get_world_size = getattr(config_module, "get_world_size_safe", None)
config_module.get_world_size_safe = mock_get_world_size_safe(world_size_override)
return container, original_get_world_size, config_module
def restore_get_world_size_safe(original_func, module_ref):
"""
Restores the original `get_world_size_safe` function in the given module.
Args:
original_func: The original function to restore.
module_ref: The module where the function was patched.
"""
if original_func is not None:
module_ref.get_world_size_safe = original_func
def create_test_cp_config_container(cp_size, calc_per_token_loss, avg_in_collective, dataset_type="finetuning"):
"""Helper to create config container for context parallel tests."""
gpt_model_cfg = create_test_gpt_config(
seq_length=512,
context_parallel_size=cp_size,
calculate_per_token_loss=calc_per_token_loss,
tensor_model_parallel_size=1,
pipeline_model_parallel_size=1,
)
if dataset_type == "finetuning":
dataset_cfg = create_test_gpt_sft_dataset_config(sequence_length=512)
elif dataset_type == "conversation":
dataset_cfg = create_test_direct_hf_sft_dataset_config(sequence_length=512)
elif dataset_type == "energon":
dataset_cfg = create_test_energon_dataset_config(sequence_length=512)
elif dataset_type == "mock_vlm":
dataset_cfg = create_test_mock_vlm_dataset_config(sequence_length=512)
else:
dataset_cfg = create_test_gpt_dataset_config(sequence_length=512)
ddp_cfg = DistributedDataParallelConfig(average_in_collective=avg_in_collective)
container, og_ws, cfg_mod = create_test_config_container(
world_size_override=cp_size,
model_config=gpt_model_cfg,
dataset_config_override=dataset_cfg,
)
container.ddp = ddp_cfg
return container, og_ws, cfg_mod
class TestGPTFIMDatasetConfig:
"""Tests desired behavior for GPTFIMDatasetConfig."""
def test_initialization(self):
config = GPTFIMDatasetConfig(
random_seed=1234,
seq_length=512,
fim_rate=0.1,
fim_no_prefix="test",
fim_extra_tokens={"middle": "<middle>"},
fim_split_sample="test sample",
reset_position_ids=False,
reset_attention_mask=False,
eod_mask_loss=False,
)
config.finalize()
# Should be an instance GPTFIMDatasetConfig
from megatron.core.datasets.blended_megatron_dataset_config import BlendedMegatronDatasetConfig
assert isinstance(config, GPTFIMDatasetConfig)
assert isinstance(config, GPTDatasetConfig)
assert isinstance(config, BlendedMegatronDatasetConfig)
# Should have all the expected fields from parent class
assert hasattr(config, "random_seed")
assert hasattr(config, "seq_length")
assert hasattr(config, "path_to_cache")
# Verify have all the expected fields were set proeprly
assert config.fim_data
assert config.fim_rate == 0.1
assert config.fim_no_prefix == "test"
assert config.fim_split_sample == "test sample"
assert config.fim_extra_tokens["middle"] == "<middle>"
class TestMockGPTDatasetConfig:
"""Tests desired behavior for MockGPTDatasetConfig."""
def test_initialization(self):
"""Test that blend and blend_per_split fields are always None in MockGPTDatasetConfig."""
config = MockGPTDatasetConfig(
random_seed=1234,
seq_length=512,
reset_position_ids=False,
reset_attention_mask=False,
eod_mask_loss=False,
)
config.finalize()
# Should be an instance of both MockGPTDatasetConfig and GPTDatasetConfig
from megatron.core.datasets.blended_megatron_dataset_config import BlendedMegatronDatasetConfig
from megatron.core.datasets.gpt_dataset import GPTDatasetConfig as MCoreGPTDatasetConfig
assert isinstance(config, MockGPTDatasetConfig)
assert isinstance(config, GPTDatasetConfig)
assert isinstance(config, MCoreGPTDatasetConfig)
assert isinstance(config, BlendedMegatronDatasetConfig)
# Should have all the expected fields from parent class
assert hasattr(config, "random_seed")
assert hasattr(config, "seq_length")
assert hasattr(config, "path_to_cache")
# Verify blend fields are None and cannot be accessed via __dict__
assert config.blend is None
assert config.blend_per_split is None
assert config.mock # should be set by BlendedMegatronDatasetConfig post-init
print(config.__dict__)
assert "blend" not in config.__dict__
assert "blend_per_split" not in config.__dict__
def test_cannot_set_blend_fields(self):
"""Test that blend and blend_per_split fields cannot be set during initialization."""
# These should raise a TypeError because blend and blend_per_split are marked as init=False
with pytest.raises(TypeError, match="got an unexpected keyword argument 'blend'"):
MockGPTDatasetConfig(
random_seed=1234,
seq_length=512,
reset_position_ids=False,
reset_attention_mask=False,
eod_mask_loss=False,
blend=(["some", "data", "paths"], None), # This should fail
).finalize()
with pytest.raises(TypeError, match="got an unexpected keyword argument 'blend_per_split'"):
MockGPTDatasetConfig(
random_seed=1234,
seq_length=512,
reset_position_ids=False,
reset_attention_mask=False,
eod_mask_loss=False,
blend_per_split=[
(["train", "paths"], None),
(["valid", "paths"], None),
(["test", "paths"], None),
], # This should fail
).finalize()
with pytest.raises(TypeError, match="got an unexpected keyword argument"):
MockGPTDatasetConfig(
random_seed=1234,
seq_length=512,
reset_position_ids=False,
reset_attention_mask=False,
eod_mask_loss=False,
blend=(["some", "data", "paths"], None),
blend_per_split=[(["train", "paths"], None), (["valid", "paths"], None), (["test", "paths"], None)],
).finalize()
_DETERMINISM_ENV_VARS = (
"NCCL_ALGO",
"NVTE_ALLOW_NONDETERMINISTIC_ALGO",
"CUBLAS_WORKSPACE_CONFIG",
"MAMBA_DETERMINISTIC",
"CAUSAL_CONV1D_DETERMINISTIC",
"TRITON_CACHE_AUTOTUNING",
)
@pytest.fixture
def isolated_determinism_state(monkeypatch):
"""Keep Megatron-Core's determinism setup from leaking env vars or torch global state."""
import torch.utils.deterministic
for name in _DETERMINISM_ENV_VARS:
monkeypatch.delenv(name, raising=False)
monkeypatch.setattr(
torch.utils.deterministic, "fill_uninitialized_memory", torch.utils.deterministic.fill_uninitialized_memory
)
calls = []
monkeypatch.setattr(torch, "use_deterministic_algorithms", lambda flag, **_kwargs: calls.append(flag))
return calls
class TestConfigContainerValidation:
def test_deterministic_mode_disallows_ce_fusion(self, isolated_determinism_state):
"""Test that deterministic mode disallows cross-entropy loss fusion."""
gpt_model_cfg = create_test_gpt_config(
deterministic_mode=True,
cross_entropy_loss_fusion=True,
)
container, og_ws, cfg_mod = create_test_config_container(world_size_override=1, model_config=gpt_model_cfg)
try:
with pytest.raises(AssertionError, match="cross_entropy_loss_fusion=False"):
container.validate()
finally:
restore_get_world_size_safe(og_ws, cfg_mod)
def test_deterministic_mode_rejects_moe_aux_loss_fusion(self, isolated_determinism_state):
"""Deterministic mode rejects the MoE aux-loss fusion but keeps fused TopK routing."""
gpt_model_cfg = create_test_gpt_config(deterministic_mode=True, cross_entropy_loss_fusion=False)
gpt_model_cfg.moe_router_fusion = True
gpt_model_cfg.moe_router_aux_loss_fusion = True
container, og_ws, cfg_mod = create_test_config_container(world_size_override=1, model_config=gpt_model_cfg)
try:
with pytest.raises(AssertionError, match="moe_router_aux_loss_fusion=False"):
container._validate_and_apply_deterministic_mode()
gpt_model_cfg.moe_router_aux_loss_fusion = False
container._validate_and_apply_deterministic_mode()
finally:
restore_get_world_size_safe(og_ws, cfg_mod)
def test_deterministic_mode_rejects_tp_comm_overlap(self, isolated_determinism_state):
"""TP communication overlap is not bit-exact and must be off."""
gpt_model_cfg = create_test_gpt_config(deterministic_mode=True, cross_entropy_loss_fusion=False)
container, og_ws, cfg_mod = create_test_config_container(world_size_override=1, model_config=gpt_model_cfg)
container.comm_overlap = SimpleNamespace(tp_comm_overlap=True)
try:
with pytest.raises(AssertionError, match="tp_comm_overlap=False"):
container._validate_and_apply_deterministic_mode()
finally:
restore_get_world_size_safe(og_ws, cfg_mod)
def test_deterministic_mode_env_matches_megatron_core(self, monkeypatch, isolated_determinism_state):
"""Env vars follow Megatron-Core's rules: defaults filled, non-deterministic values rejected."""
import torch.utils.deterministic
gpt_model_cfg = create_test_gpt_config(
deterministic_mode=True,
cross_entropy_loss_fusion=False,
transformer_impl="transformer_engine",
)
container, og_ws, cfg_mod = create_test_config_container(world_size_override=1, model_config=gpt_model_cfg)
try:
# Tree has no controllable reduction order and is rejected, as in Megatron-Core.
monkeypatch.setenv("NCCL_ALGO", "Tree")
with pytest.raises(AssertionError, match="NCCL_ALGO='Tree'"):
container._validate_and_apply_deterministic_mode()
monkeypatch.setenv("NCCL_ALGO", "Ring")
monkeypatch.setenv("NVTE_ALLOW_NONDETERMINISTIC_ALGO", "1")
with pytest.raises(AssertionError, match="NVTE_ALLOW_NONDETERMINISTIC_ALGO='1'"):
container._validate_and_apply_deterministic_mode()
# Unset values get the canonical defaults; torch deterministic mode is enabled.
monkeypatch.delenv("NCCL_ALGO")
monkeypatch.delenv("NVTE_ALLOW_NONDETERMINISTIC_ALGO")
container._validate_and_apply_deterministic_mode()
assert os.environ["NCCL_ALGO"] == "Ring"
assert os.environ["NVTE_ALLOW_NONDETERMINISTIC_ALGO"] == "0"
assert os.environ["CUBLAS_WORKSPACE_CONFIG"] == ":4096:8"
assert isolated_determinism_state == [True]
assert torch.utils.deterministic.fill_uninitialized_memory is False
finally:
restore_get_world_size_safe(og_ws, cfg_mod)
@pytest.mark.parametrize(
"world_size, expect_assertion_error",
[
(8, False),
(7, True),
],
)
def test_world_size_divisibility_gpt(self, monkeypatch, world_size, expect_assertion_error):
"""Test world size divisibility by model_size for GPT."""
gpt_model_cfg = create_test_gpt_config(
tensor_model_parallel_size=2,
pipeline_model_parallel_size=2,
context_parallel_size=1,
pipeline_dtype=torch.bfloat16,
)
container, og_ws, cfg_mod = create_test_config_container(
world_size_override=world_size, model_config=gpt_model_cfg
)
try:
if expect_assertion_error:
with pytest.raises(AssertionError, match="is not divisible by"):
container.validate()
else:
container.validate() # Should pass without error
finally:
restore_get_world_size_safe(og_ws, cfg_mod)
@pytest.mark.parametrize(
"world_size, expect_assertion_error",
[
(10, False),
(9, True),
],
)
def test_world_size_divisibility_t5(self, monkeypatch, world_size, expect_assertion_error):
"""Test world size divisibility by model_size for GPT."""
gpt_model_cfg = create_test_t5_config(
tensor_model_parallel_size=2,
pipeline_model_parallel_size=1,
encoder_pipeline_model_parallel_size=2,
context_parallel_size=1,
pipeline_dtype=torch.bfloat16,
)
container, og_ws, cfg_mod = create_test_config_container(
world_size_override=world_size,
model_config=gpt_model_cfg,
validation_config=ValidationConfig(eval_global_batch_size=10, eval_micro_batch_size=1),
)
try:
if expect_assertion_error:
with pytest.raises(AssertionError, match="is not divisible by"):
container.validate()
else:
container.validate() # Should pass without error
finally:
restore_get_world_size_safe(og_ws, cfg_mod)
def test_cpu_initialization_with_lazy_init(self, monkeypatch):
"""Test `use_cpu_initialization` is True if `lazy_mpu_init` is True."""
gpt_model_cfg = create_test_gpt_config(use_cpu_initialization=False)
dist_cfg = create_test_distributed_init_config(lazy_mpu_init=True)
container, og_ws, cfg_mod = create_test_config_container(
world_size_override=4, model_config=gpt_model_cfg, dist_config=dist_cfg
)
try:
container.validate()
assert container.model.use_cpu_initialization is True
finally:
restore_get_world_size_safe(og_ws, cfg_mod)
def test_cpu_initialization_persists_if_true(self, monkeypatch):
"""Test `use_cpu_initialization` remains True if initially True."""
gpt_model_cfg_true = create_test_gpt_config(use_cpu_initialization=True)
# Case 1: lazy_mpu_init is False
dist_cfg_lazy_false = create_test_distributed_init_config(lazy_mpu_init=False)
container1, og1, mod1 = create_test_config_container(
world_size_override=4, model_config=gpt_model_cfg_true, dist_config=dist_cfg_lazy_false
)
try:
container1.validate()
assert container1.model.use_cpu_initialization is True
finally:
restore_get_world_size_safe(og1, mod1)
# Case 2: lazy_mpu_init is True
dist_cfg_lazy_true = create_test_distributed_init_config(lazy_mpu_init=True)
gpt_model_cfg_true_case2 = create_test_gpt_config(use_cpu_initialization=True)
container2, og2, mod2 = create_test_config_container(
world_size_override=4, model_config=gpt_model_cfg_true_case2, dist_config=dist_cfg_lazy_true
)
try:
container2.validate()
assert container2.model.use_cpu_initialization is True
finally:
restore_get_world_size_safe(og2, mod2)
def test_distributed_optimizer_with_torch_dist_checkpointing_passes(self, monkeypatch):
"""Test validation passes: distributed optimizer, no gloo, torch_dist checkpoint."""
gpt_model_cfg = create_test_gpt_config()
dist_cfg = create_test_distributed_init_config(use_gloo_process_groups=False)
opt_cfg = create_test_optimizer_config(use_distributed_optimizer=True)
chkpt_cfg = create_test_checkpoint_config(ckpt_format="torch_dist")
ddp_cfg = create_test_ddp_config(use_distributed_optimizer=True)
container, og_ws, cfg_mod = create_test_config_container(
world_size_override=4,
model_config=gpt_model_cfg,
dist_config=dist_cfg,
optimizer_config=opt_cfg,
checkpoint_config=chkpt_cfg,
ddp_config=ddp_cfg,
)
try:
container.validate()
finally:
restore_get_world_size_safe(og_ws, cfg_mod)
@pytest.mark.parametrize(
"use_gloo_process_groups, expect_assertion_error",
[(False, True), (True, False)],
)
def test_memory_efficient_fully_reshardable_checkpoint_requires_gloo(
self, monkeypatch, use_gloo_process_groups, expect_assertion_error
):
"""Require Gloo only when memory-efficient fully reshardable checkpoints are enabled."""
gpt_model_cfg = create_test_gpt_config()
dist_cfg = create_test_distributed_init_config(use_gloo_process_groups=use_gloo_process_groups)
opt_cfg = create_test_optimizer_config(use_distributed_optimizer=True)
chkpt_cfg = create_test_checkpoint_config(
dist_ckpt_optim_fully_reshardable=True,
distrib_optim_fully_reshardable_mem_efficient=True,
)
ddp_cfg = create_test_ddp_config(use_distributed_optimizer=True)
container, og_ws, cfg_mod = create_test_config_container(
world_size_override=4,
model_config=gpt_model_cfg,
dist_config=dist_cfg,
optimizer_config=opt_cfg,
checkpoint_config=chkpt_cfg,
ddp_config=ddp_cfg,
)
try:
if expect_assertion_error:
with pytest.raises(AssertionError, match="requires dist.use_gloo_process_groups=True"):
container.validate()
else:
container.validate()
finally:
restore_get_world_size_safe(og_ws, cfg_mod)
@pytest.mark.parametrize("expert_gtp", [False, True])
@pytest.mark.parametrize("fully_reshardable,memory_efficient", [(True, True), (True, False), (False, True)])
def test_gtp_rejects_memory_efficient_fully_reshardable_optimizer_checkpoint(
self, expert_gtp, fully_reshardable, memory_efficient
):
model = create_test_gpt_config(
tensor_parallel_num_weight_shards=1 if expert_gtp else 2,
expert_tensor_parallel_size=1,
expert_tensor_parallel_num_weight_shards=2 if expert_gtp else 1,
num_moe_experts=4 if expert_gtp else None,
)
container, original_world_size, config_module = create_test_config_container(
world_size_override=2,
model_config=model,
dist_config=create_test_distributed_init_config(use_gloo_process_groups=True),
optimizer_config=create_test_optimizer_config(use_distributed_optimizer=True),
ddp_config=create_test_ddp_config(use_distributed_optimizer=True),
checkpoint_config=create_test_checkpoint_config(
dist_ckpt_optim_fully_reshardable=fully_reshardable,
distrib_optim_fully_reshardable_mem_efficient=memory_efficient,
),
)
try:
if fully_reshardable and memory_efficient:
with pytest.raises(ValueError, match="GTP does not support memory-efficient fully reshardable"):
container.validate()
else:
container.validate()
finally:
restore_get_world_size_safe(original_world_size, config_module)
def test_scheduler_lr_decay_iters_default(self, monkeypatch):
"""Test `lr_decay_iters` defaults to `train_iters` and `lr_decay_steps` calculation."""
gpt_model_cfg = create_test_gpt_config()
train_cfg = create_test_training_config(train_iters=2000, global_batch_size=32)
sched_cfg = create_test_scheduler_config(lr_decay_iters=None)
container, og_ws, cfg_mod = create_test_config_container(
world_size_override=1, model_config=gpt_model_cfg, train_config=train_cfg, scheduler_config=sched_cfg
)
try:
container.validate()
assert container.scheduler.lr_decay_iters == train_cfg.train_iters
assert container.scheduler.lr_decay_steps == train_cfg.train_iters * train_cfg.global_batch_size
finally:
restore_get_world_size_safe(og_ws, cfg_mod)
def test_scheduler_lr_decay_iters_custom(self, monkeypatch):
"""Test custom `lr_decay_iters` and `lr_decay_steps` calculation."""
gpt_model_cfg = create_test_gpt_config()
train_cfg = create_test_training_config(train_iters=2000, global_batch_size=32)
custom_lr_decay_iters = 1500
sched_cfg = create_test_scheduler_config(lr_decay_iters=custom_lr_decay_iters)
container, og_ws, cfg_mod = create_test_config_container(
world_size_override=1, model_config=gpt_model_cfg, train_config=train_cfg, scheduler_config=sched_cfg
)
try:
container.validate()
assert container.scheduler.lr_decay_iters == custom_lr_decay_iters
assert container.scheduler.lr_decay_steps == custom_lr_decay_iters * train_cfg.global_batch_size
finally:
restore_get_world_size_safe(og_ws, cfg_mod)
def test_scheduler_max_steps_preserves_full_run_schedules(self, monkeypatch):
"""A short test run can use the schedules from the full training run."""
gpt_model_cfg = create_test_gpt_config()
train_cfg = create_test_training_config(train_iters=1000, global_batch_size=32)
sched_cfg = create_test_scheduler_config(max_steps=48000)
container, og_ws, cfg_mod = create_test_config_container(
world_size_override=1, model_config=gpt_model_cfg, train_config=train_cfg, scheduler_config=sched_cfg
)
try:
container.validate()
assert container.train.train_iters == 1000
assert container.scheduler.max_steps == 48000
assert container.scheduler.lr_decay_iters == 48000
assert container.scheduler.lr_decay_steps == 48000 * train_cfg.global_batch_size
assert container.scheduler.wd_incr_steps == 48000 * train_cfg.global_batch_size
finally:
restore_get_world_size_safe(og_ws, cfg_mod)
def test_scheduler_max_steps_rejects_value_shorter_than_training(self, monkeypatch):
gpt_model_cfg = create_test_gpt_config()
train_cfg = create_test_training_config(train_iters=1000)
sched_cfg = create_test_scheduler_config(max_steps=999)
container, og_ws, cfg_mod = create_test_config_container(
world_size_override=1, model_config=gpt_model_cfg, train_config=train_cfg, scheduler_config=sched_cfg
)
try:
with pytest.raises(ValueError, match="must be greater than or equal to train.train_iters"):
container.validate()
finally:
restore_get_world_size_safe(og_ws, cfg_mod)
def test_scheduler_wd_incr_steps(self, monkeypatch):
"""Test `wd_incr_steps` calculation."""
gpt_model_cfg = create_test_gpt_config()
train_cfg = create_test_training_config(train_iters=500, global_batch_size=16)
sched_cfg = create_test_scheduler_config()
container, og_ws, cfg_mod = create_test_config_container(
world_size_override=1, model_config=gpt_model_cfg, train_config=train_cfg, scheduler_config=sched_cfg
)
try:
container.validate()
expected_wd_incr_steps = train_cfg.train_iters * train_cfg.global_batch_size
assert container.scheduler.wd_incr_steps == expected_wd_incr_steps
finally:
restore_get_world_size_safe(og_ws, cfg_mod)
def test_scheduler_wsd_decay_steps(self, monkeypatch):
"""Test `wsd_decay_steps` calculation when `lr_wsd_decay_iters` is set."""
gpt_model_cfg = create_test_gpt_config()
# train_iters is needed for lr_decay_iters default in scheduler validation if not set
train_cfg = create_test_training_config(global_batch_size=8, train_iters=100)
lr_wsd_decay_iters = 100
sched_cfg = create_test_scheduler_config(lr_wsd_decay_iters=lr_wsd_decay_iters)
container, og_ws, cfg_mod = create_test_config_container(
world_size_override=1, model_config=gpt_model_cfg, train_config=train_cfg, scheduler_config=sched_cfg
)
try:
container.validate()
expected_wsd_decay_steps = lr_wsd_decay_iters * train_cfg.global_batch_size
assert container.scheduler.wsd_decay_steps == expected_wsd_decay_steps
finally:
restore_get_world_size_safe(og_ws, cfg_mod)
def test_scheduler_wsd_decay_steps_none(self, monkeypatch):
"""Test `wsd_decay_steps` is None when `lr_wsd_decay_iters` is None."""
gpt_model_cfg = create_test_gpt_config()
train_cfg = create_test_training_config()
sched_cfg = create_test_scheduler_config(lr_wsd_decay_iters=None)
container, og_ws, cfg_mod = create_test_config_container(
world_size_override=1, model_config=gpt_model_cfg, train_config=train_cfg, scheduler_config=sched_cfg
)
try:
container.validate()
assert container.scheduler.wsd_decay_steps is None
finally:
restore_get_world_size_safe(og_ws, cfg_mod)
def test_scheduler_lr_warmup_steps_from_fraction(self, monkeypatch):
"""Test `lr_warmup_steps` calculation from `lr_warmup_fraction`."""
gpt_model_cfg = create_test_gpt_config()
train_cfg = create_test_training_config(train_iters=1000, global_batch_size=32)
lr_warmup_fraction = 0.1
sched_cfg = create_test_scheduler_config(
lr_warmup_fraction=lr_warmup_fraction, lr_warmup_iters=0
) # lr_decay_iters defaults to train_iters
container, og_ws, cfg_mod = create_test_config_container(
world_size_override=1, model_config=gpt_model_cfg, train_config=train_cfg, scheduler_config=sched_cfg
)
try:
container.validate()
expected_lr_warmup_steps = lr_warmup_fraction * (train_cfg.train_iters * train_cfg.global_batch_size)
assert container.scheduler.lr_warmup_steps == expected_lr_warmup_steps
finally:
restore_get_world_size_safe(og_ws, cfg_mod)
def test_scheduler_lr_warmup_steps_from_iters(self, monkeypatch):
"""Test `lr_warmup_steps` calculation from `lr_warmup_iters`."""
gpt_model_cfg = create_test_gpt_config()
train_cfg = create_test_training_config(global_batch_size=10)
lr_warmup_iters = 50
sched_cfg = create_test_scheduler_config(lr_warmup_fraction=None, lr_warmup_iters=lr_warmup_iters)
container, og_ws, cfg_mod = create_test_config_container(
world_size_override=1, model_config=gpt_model_cfg, train_config=train_cfg, scheduler_config=sched_cfg
)
try:
container.validate()
expected_lr_warmup_steps = lr_warmup_iters * train_cfg.global_batch_size
assert container.scheduler.lr_warmup_steps == expected_lr_warmup_steps
finally:
restore_get_world_size_safe(og_ws, cfg_mod)
def test_scheduler_lr_warmup_steps_capped_when_exceeds_lr_decay_steps(self, monkeypatch):
"""Test lr_warmup_steps is capped to lr_decay_steps - 1 with a warning when it would exceed lr_decay_steps."""
gpt_model_cfg = create_test_gpt_config()
# train_iters=10 gives lr_decay_steps=10*32=320; lr_warmup_iters=2000 gives lr_warmup_steps=2000*32=64000
train_cfg = create_test_training_config(train_iters=10, global_batch_size=32)
sched_cfg = create_test_scheduler_config(lr_warmup_fraction=None, lr_warmup_iters=2000)
container, og_ws, cfg_mod = create_test_config_container(
world_size_override=1, model_config=gpt_model_cfg, train_config=train_cfg, scheduler_config=sched_cfg
)
try:
with pytest.warns(UserWarning, match="capping lr_warmup_steps"):
container.validate()
assert container.scheduler.lr_warmup_steps == container.scheduler.lr_decay_steps - 1
finally:
restore_get_world_size_safe(og_ws, cfg_mod)
def test_scheduler_lr_decay_steps_zero_raises_value_error(self, monkeypatch):
"""Test that lr_decay_steps <= 0 raises ValueError."""
gpt_model_cfg = create_test_gpt_config()
# train_iters=0 gives lr_decay_steps=0*32=0, which must be rejected
train_cfg = create_test_training_config(train_iters=0, global_batch_size=32)
sched_cfg = create_test_scheduler_config(lr_warmup_fraction=None, lr_warmup_iters=0)
container, og_ws, cfg_mod = create_test_config_container(
world_size_override=1, model_config=gpt_model_cfg, train_config=train_cfg, scheduler_config=sched_cfg
)
try:
with pytest.raises(ValueError, match="lr_decay_steps must be > 0"):
container.validate()
finally:
restore_get_world_size_safe(og_ws, cfg_mod)
def test_scheduler_lr_warmup_fraction_and_iters_mutual_exclusivity(self, monkeypatch):
"""Test that lr_warmup_fraction and lr_warmup_iters cannot both be specified."""
gpt_model_cfg = create_test_gpt_config()
train_cfg = create_test_training_config(train_iters=1000, global_batch_size=10)
lr_warmup_fraction = 0.05
lr_warmup_iters = 50 # This should not be allowed with lr_warmup_fraction
sched_cfg = create_test_scheduler_config(
lr_warmup_fraction=lr_warmup_fraction, lr_warmup_iters=lr_warmup_iters
)
container, og_ws, cfg_mod = create_test_config_container(
world_size_override=1, model_config=gpt_model_cfg, train_config=train_cfg, scheduler_config=sched_cfg
)
try:
# This should fail validation due to mutual exclusivity at scheduler finalize level
with pytest.raises(AssertionError, match="Cannot specify lr_warmup_fraction=0.05 with lr_warmup_iters=50"):
container.validate()