Coverage for  / home / jenkins / .local / lib / python3.10 / site-packages / hyper_parallel / trainer / config.py: 99%

317 statements  

« prev     ^ index     » next       coverage.py v7.13.1, created at 2026-08-04 05:18 +0800

1# Copyright 2026 Huawei Technologies Co., Ltd 

2# 

3# Licensed under the Apache License, Version 2.0 (the "License"); 

4# you may not use this file except in compliance with the License. 

5# You may obtain a copy of the License at 

6# 

7# http://www.apache.org/licenses/LICENSE-2.0 

8# 

9# Unless required by applicable law or agreed to in writing, software 

10# distributed under the License is distributed on an "AS IS" BASIS, 

11# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 

12# See the License for the specific language governing permissions and 

13# limitations under the License. 

14# ============================================================================ 

15"""Training configuration schema — strict three-tier (model/data/train). 

16 

17Top-level keys are exactly ``model``, ``data`` and ``train`` and nothing else; 

18anything outside this three-tier schema is rejected by the parser. 

19 

20YAML shape:: 

21 

22 model: 

23 name: qwen3_5 

24 weights_path: /path/to/weights 

25 data: 

26 type: hf_datasets 

27 train_path: /path/to/data 

28 train: 

29 max_steps: 100 

30 micro_batch_size: 1 

31 global_batch_size: 8 

32 seed: 42 

33 init_device: meta 

34 optimizer: 

35 type: adamw 

36 lr: 1.0e-4 

37 accelerator: 

38 dp_shard: 8 

39 tp: 1 

40 mixed_precision: 

41 enabled: true 

42 param_dtype: bfloat16 

43 checkpoint: 

44 output_dir: outputs/run1 

45 ... 

46""" 

47import argparse 

48import difflib 

49import logging 

50import os 

51from dataclasses import dataclass, field, fields, is_dataclass 

52from typing import Any, Dict, List, Optional, Type, TypeVar, Union, get_args, get_origin 

53 

54import yaml 

55 

56logger = logging.getLogger(__name__) 

57 

58T = TypeVar("T") 

59 

60_BOOL_TRUE_STRINGS = frozenset(("true", "yes", "y", "on", "1", "t")) 

61_BOOL_FALSE_STRINGS = frozenset(("false", "no", "n", "off", "0", "f")) 

62 

63# ============================================================================ 

64# model: 

65# ============================================================================ 

66 

67 

68@dataclass 

69class ModelConfig: 

70 """``model.*`` — model identity, weights, and architecture overrides. 

71 

72 Only universal transformer fields are typed here. Anything model- 

73 specific (mRoPE section split, MoE expert geometry, linear-attention 

74 head counts, ``layer_types`` ...) goes through ``config_overrides`` — 

75 a free-form ``dict`` that is merged into the underlying model 

76 constructor by the model's ``build_model_fn``. 

77 """ 

78 name: str = "qwen3_5" 

79 weights_path: Optional[str] = None 

80 tokenizer_path: Optional[str] = None 

81 freeze_modules: Optional[list] = None 

82 tp_plan: Optional[dict] = None 

83 cp_modules: Optional[list] = None 

84 ep_modules: Optional[list] = None 

85 # Universal transformer architecture overrides. 

86 num_hidden_layers: Optional[int] = None 

87 hidden_size: Optional[int] = None 

88 intermediate_size: Optional[int] = None 

89 num_attention_heads: Optional[int] = None 

90 num_key_value_heads: Optional[int] = None 

91 vocab_size: Optional[int] = None 

92 max_position_embeddings: Optional[int] = None 

93 # Free-form per-model overrides handed to ``build_model_fn``. 

94 config_overrides: Optional[dict] = None 

95 

96# ============================================================================ 

97# data: 

98# ============================================================================ 

99 

100 

101@dataclass 

102class DataConfig: 

103 """``data.*`` — dataset, tokenizer/processor, sampler, batch shape. 

104 

105 - ``streaming``: only ``False`` supported today. 

106 - ``num_workers``: keep ≥ 2 for real datasets. 

107 - ``shuffle``: when ``False``, sampler reads samples in dataset order. 

108 """ 

109 type: str = "dummy" 

110 train_path: Optional[Any] = None 

111 subset: Optional[str] = None 

112 max_seq_len: int = 2048 

113 text_key: str = "text" 

114 train_size: Optional[int] = None 

115 # multimodal / VL (synthetic vl_dummy path) 

116 template: str = "empty" 

117 image_key: str = "image" 

118 messages_key: str = "messages" 

119 image_token_id: int = 151655 

120 video_token_id: int = 151656 

121 vl_video: bool = False 

122 vl_grid_t: int = 2 

123 vl_grid_h: int = 2 

124 vl_grid_w: int = 2 

125 # loader perf 

126 streaming: bool = False 

127 num_workers: int = 0 

128 prefetch_factor: Optional[int] = None 

129 pin_memory: bool = True 

130 shuffle: bool = True 

131 # Megatron .bin/.idx options (data.type='megatron'). ``train_path`` is a 

132 # single path-prefix, or a blend spec ("w1 prefix1 w2 prefix2 ...") / 

133 # list-of-pairs. ``megatron_seed`` defaults to ``train.seed`` when None. 

134 megatron_seed: Optional[int] = None 

135 pad_token_id: int = 0 

136 eod_token_id: Optional[int] = None 

137 eod_mask_loss: bool = False 

138 mmap_bin_files: bool = True 

139 

140# ============================================================================ 

141# train.* — sub-configs 

142# ============================================================================ 

143 

144 

145@dataclass 

146class AcceleratorConfig: 

147 """``train.accelerator.*`` — parallelism topology. 

148 

149 Two ways to express data parallelism: 

150 

151 - **Legacy single field** (back-compat): ``dp`` only — maps to 

152 ``dp_shard`` for FSDP. 

153 - ** split**: ``dp_replicate`` (HSDP outer) and 

154 ``dp_shard`` (FSDP inner). Pass ``dp_shard=-1`` to auto-fill from 

155 ``world_size / (dp_replicate * cp * tp * pp)``. 

156 

157 For MoE: ``etp`` controls expert TP. Must equal ``tp`` or ``1``. 

158 ``moe_token_dispatcher_type`` selects the EP token exchange algorithm. 

159 ``npu_nums_per_device`` is the inner-EP degree for the deredundency 

160 dispatcher; ``oep`` is inferred as ``ep // npu_nums_per_device``. 

161 """ 

162 dp: Optional[int] = None 

163 dp_replicate: int = 1 

164 dp_shard: Optional[int] = None 

165 tp: int = 1 

166 cp: int = 1 

167 pp: int = 1 

168 # Number of pipeline micro-batches per optimizer step when ``pp > 1``. 

169 # The global batch is split into this many micro-batches along dim 0 and 

170 # streamed through the pipeline stages; ``global_batch_size`` must be 

171 # divisible by it. Defaults to 1 (no micro-batching). 

172 pp_micro_batch_num: int = 1 

173 # Pipeline schedule when ``pp > 1``: ``"gpipe"`` (all-forward then 

174 # all-backward) or ``"1f1b"`` (one-forward-one-backward steady state). 

175 # ``None`` keeps each model's default (dense → gpipe, MoE → 1f1b). 

176 pp_schedule: Optional[str] = None 

177 # Virtual-pipeline (VPP) degree: number of non-contiguous stage chunks each 

178 # PP rank owns. ``1`` (default) is the plain single-stage-per-rank pipeline. 

179 # ``>1`` builds ``pp * pp_vpp`` interleaved global stages (rank ``r`` owns 

180 # stages ``r, r+pp, r+2*pp, ...``) and drives them with interleaved 1F1B. 

181 pp_vpp: int = 1 

182 # Per-global-stage decoder-layer counts (length ``pp * pp_vpp``, summing to 

183 # ``num_hidden_layers``). ``None`` (default) keeps the even split with the 

184 # remainder on the later stages. Lets users rebalance stages whose extra 

185 # modules (embed / visual tower / lm_head) dominate memory or latency. 

186 pp_layer_split: Optional[List[int]] = None 

187 ep: int = 1 

188 etp: int = 1 

189 moe_token_dispatcher_type: str = "all_to_all" 

190 npu_nums_per_device: int = 8 

191 zero_stage: int = 0 

192 reshard_after_forward: bool = True 

193 async_cp: bool = False 

194 ulysses_degree: Optional[int] = None 

195 # Bucketed reduce-scatter: single fused RS per FSDP unit, stable fp32 

196 # reduction order across runs. 

197 comm_fusion: bool = True 

198 # Offload sharded params, grads, and optimizer states to CPU so large 

199 # checkpoints can fit without device-resident master weights and Adam state. 

200 cpu_offload: bool = False 

201 

202 

203@dataclass 

204class MixedPrecisionConfig: 

205 """``train.mixed_precision.*`` — mixed-precision forward configuration. 

206 

207 FSDP2 ``MixedPrecisionPolicy``: ``param_dtype`` is the all-gather'd 

208 forward dtype, ``reduce_dtype`` is the reduce-scatter dtype for grads, 

209 and ``output_dtype`` controls the forward-output dtype at FSDP wrap 

210 boundaries (leave ``None`` to inherit from ``param_dtype``). 

211 """ 

212 enabled: bool = False 

213 param_dtype: str = "bfloat16" 

214 reduce_dtype: str = "float32" 

215 output_dtype: Optional[str] = None 

216 

217 

218@dataclass 

219class GradientCheckpointingConfig: 

220 """``train.gradient_checkpointing.*`` — activation recomputation. 

221 

222 . Modes: ``"off"``, ``"full"``, or ``"selective"``. 

223 """ 

224 activation_checkpoint: str = "off" 

225 

226 

227@dataclass 

228class OptimizerConfig: 

229 """``train.optimizer.*`` — optimizer + LR schedule + grad clip. 

230 

231 ``loss_aggregation``: how the per-micro-batch loss is scaled before 

232 backward. ``"token_weighted"`` divides the summed loss by the global 

233 valid-token count; ``"rank_average"`` averages per-rank micro-batch 

234 means and is preferred when batches have variable valid-token counts 

235 across ranks. 

236 ``max_grad_norm``: values <= 0 disable gradient clipping. 

237 """ 

238 type: str = "adamw" 

239 lr: float = 1e-4 

240 lr_min: float = 1e-5 

241 lr_decay_style: str = "cosine" 

242 lr_warmup_ratio: float = 0.1 

243 loss_aggregation: str = "token_weighted" 

244 weight_decay: float = 0.01 

245 max_grad_norm: float = 1.0 

246 bsz_warmup_ratio: float = 0.0 

247 eps: float = 1e-8 

248 betas: tuple = (0.9, 0.999) 

249 # ``None`` lets torch pick the foreach kernel; set ``False`` in YAML when a 

250 # run must force the deterministic per-parameter loop. 

251 foreach: Optional[bool] = None 

252 

253 

254@dataclass 

255class CheckpointConfig: 

256 """``train.checkpoint.*`` — DCP save / load + HF export.""" 

257 output_dir: str = "outputs" 

258 save_steps: int = 500 

259 save_hf_weights: bool = True 

260 load_path: Optional[str] = None 

261 save_async: bool = False 

262 

263 

264@dataclass 

265class LoggingConfig: 

266 """``train.logging.*`` — console / metric output (consumed by LoggingCallback).""" 

267 report_to: str = "none" 

268 report_global_loss: bool = False 

269 log_steps: int = 10 

270 report_throughput: bool = True 

271 model_flops_per_token: Optional[int] = None 

272 peak_tflops: Optional[float] = None # e.g. 312.0 for A100 bf16 

273 

274 

275@dataclass 

276class TensorBoardConfig: 

277 """``train.tensorboard.*`` — TB SummaryWriter on rank 0.""" 

278 enabled: bool = False 

279 output_dir: str = "tb_traces" 

280 log_steps: int = 1 

281 

282 

283@dataclass 

284class WandbConfig: 

285 """``train.wandb.*`` — W&B run logging on rank 0.""" 

286 enabled: bool = False 

287 project: str = "hyper-parallel" 

288 run_name: Optional[str] = None 

289 log_steps: int = 1 

290 

291 

292@dataclass 

293class ProfileConfig: 

294 """``train.profile.*`` — torch.profiler schedule (). 

295 

296 Schedule semantics: wait → warmup → active.""" 

297 enabled: bool = False 

298 output_dir: str = "profiler_traces" 

299 wait_steps: int = 1 

300 warmup_steps: int = 1 

301 active_steps: int = 3 

302 

303 

304@dataclass 

305class MemoryMonitorConfig: 

306 """``train.memory_monitor.*`` — periodic device-memory snapshot.""" 

307 enabled: bool = False 

308 log_steps: int = 50 

309 reset_peak_each_step: bool = False 

310 

311 

312@dataclass 

313class MonitorConfig: 

314 """``train.monitor.*`` — training-state monitor for loss / gradient scalars.""" 

315 monitor_on: bool = False 

316 dump_path: str = "./dump" 

317 target: Optional[list] = None 

318 invert: bool = False 

319 step_interval: int = 1 

320 local_loss_format: Optional[list] = None 

321 device_local_loss_format: Optional[list] = None 

322 local_norm_format: Optional[list] = None 

323 device_local_norm_format: Optional[list] = None 

324 

325 

326@dataclass 

327class MoEMonitorConfig: 

328 """``train.moe_monitor.*`` — MoE routing / load-balance monitor. 

329 

330 When enabled, :class:`~hyper_parallel.core.moe_utils.MoEMonitorCallback` 

331 automatically syncs ``tokens_per_expert`` across distributed ranks and 

332 updates ``expert_bias`` after each optimizer step. The mean ``aux_loss`` 

333 across MoE layers is exposed via ``last_mean_aux_loss`` so that 

334 :class:`LoggingCallback` can print it alongside the main training loss. 

335 

336 DP/TP+SP/CP group information is automatically obtained from the trainer's 

337 device mesh — no manual group configuration needed. 

338 

339 Args: 

340 enabled: Whether to activate the MoE monitor callback. 

341 lr: Step size for expert bias updates. Defaults to ``1e-3``. 

342 num_recomputations: Number of forward executions per optimizer step. 

343 Default ``1``. Set to ``2`` when activation checkpoint is enabled. 

344 """ 

345 enabled: bool = False 

346 lr: float = 1e-3 

347 num_recomputations: int = 1 

348 

349 

350@dataclass 

351class EvalConfig: 

352 """``train.eval.*`` — eval cadence + dataset.""" 

353 eval_steps: int = 0 

354 eval_dataset: Optional[str] = None 

355 

356 

357@dataclass 

358class DebugConfig: 

359 """``train.debug.*`` — reproducibility and numerical-stability knobs. 

360 

361 All flags here are production-safe; they tune determinism (CI / paper 

362 reproducibility), guard against numerical blow-ups, and bound memory 

363 growth in long runs. 

364 """ 

365 deterministic: bool = False 

366 deterministic_warn_only: bool = False 

367 check_nan_inf: bool = False 

368 gc_steps: int = 0 

369 

370# ============================================================================ 

371# train: (top of the train section, holds the sub-configs) 

372# ============================================================================ 

373 

374 

375@dataclass 

376class TrainConfig: 

377 """``train.*`` — full training-section config. 

378 

379 Flat fields cover the basic loop knobs (steps, batch shape, init device, 

380 seed, comm backend); nested sub-configs cover everything else. 

381 """ 

382 # Loop shape 

383 max_steps: int = 100 

384 num_train_epochs: int = 1 

385 global_batch_size: int = 8 

386 micro_batch_size: int = 1 

387 seed: int = 42 

388 

389 # Runtime / device 

390 backend: str = "torch" 

391 init_device: str = "meta" 

392 comm_backend: Optional[str] = None 

393 local_rank: int = 0 # set from LOCAL_RANK env by parser 

394 

395 # Sub-configs 

396 accelerator: AcceleratorConfig = field(default_factory=AcceleratorConfig) 

397 mixed_precision: MixedPrecisionConfig = field(default_factory=MixedPrecisionConfig) 

398 gradient_checkpointing: GradientCheckpointingConfig = field( 

399 default_factory=GradientCheckpointingConfig 

400 ) 

401 optimizer: OptimizerConfig = field(default_factory=OptimizerConfig) 

402 checkpoint: CheckpointConfig = field(default_factory=CheckpointConfig) 

403 logging: LoggingConfig = field(default_factory=LoggingConfig) 

404 tensorboard: TensorBoardConfig = field(default_factory=TensorBoardConfig) 

405 wandb: WandbConfig = field(default_factory=WandbConfig) 

406 profile: ProfileConfig = field(default_factory=ProfileConfig) 

407 memory_monitor: MemoryMonitorConfig = field(default_factory=MemoryMonitorConfig) 

408 monitor: MonitorConfig = field(default_factory=MonitorConfig) 

409 moe_monitor: MoEMonitorConfig = field(default_factory=MoEMonitorConfig) 

410 eval: EvalConfig = field(default_factory=EvalConfig) 

411 debug: DebugConfig = field(default_factory=DebugConfig) 

412 

413# ============================================================================ 

414# Top-level: model / data / train (and only these three) 

415# ============================================================================ 

416 

417 

418@dataclass 

419class HyperTrainerConfig: 

420 """Top-level config — strict three-tier (). 

421 

422 Allowed top-level keys: ``model``, ``data``, ``train``. Anything else in 

423 the YAML is rejected by the parser with a typo-suggestion message. 

424 """ 

425 model: ModelConfig = field(default_factory=ModelConfig) 

426 data: DataConfig = field(default_factory=DataConfig) 

427 train: TrainConfig = field(default_factory=TrainConfig) 

428 

429 # Computed (no user input) 

430 train_steps: int = 0 

431 

432 def __post_init__(self): 

433 self.train_steps = self.train.max_steps 

434 

435# ============================================================================== 

436# CLI / YAML parser 

437# ============================================================================== 

438# Configuration parser: YAML file + CLI dot-path overrides. 

439# 

440# Supports: 

441# - Unknown YAML/CLI keys emit a warning with difflib closest-match suggestions. 

442# - Bool fields accept string aliases: ``true/yes/y/on/1/t`` -> ``True``, 

443# ``false/no/n/off/0/f`` -> ``False``. Only applied when the dataclass 

444# field type resolves to ``bool`` or ``Optional[bool]`` to avoid ambiguity. 

445 

446 

447def _string_to_bool(value: Any) -> bool: 

448 """Convert common string representations of booleans to ``bool``. 

449 

450 Accepts: ``true/yes/y/on/1/t`` → ``True``, 

451 ``false/no/n/off/0/f`` → ``False``. 

452 

453 Args: 

454 value: A string or bool value. 

455 

456 Returns: 

457 The corresponding ``bool``. 

458 

459 Raises: 

460 ValueError: When the string cannot be mapped to a bool. 

461 """ 

462 if isinstance(value, bool): 

463 return value 

464 if isinstance(value, str): 

465 lower = value.lower() 

466 if lower in _BOOL_TRUE_STRINGS: 

467 return True 

468 if lower in _BOOL_FALSE_STRINGS: 

469 return False 

470 raise ValueError( 

471 f"Cannot convert {value!r} to bool. " 

472 "Expected one of: true/false/yes/no/y/n/on/off/1/0/t/f" 

473 ) 

474 

475 

476def _resolve_field_type(cls: Type, dot_path: str) -> Optional[Type]: 

477 """Walk a dataclass hierarchy to find the resolved type of a dot-path field. 

478 

479 Args: 

480 cls: Root dataclass class. 

481 dot_path: Dot-separated field path, e.g. ``"debug.deterministic"``. 

482 

483 Returns: 

484 The resolved Python type, or ``None`` if the path cannot be resolved. 

485 """ 

486 parts = dot_path.split(".") 

487 current_cls = cls 

488 for part in parts: 

489 if not is_dataclass(current_cls): 

490 return None 

491 found = None 

492 for f in fields(current_cls): 

493 if f.name == part: 

494 found = f 

495 break 

496 if found is None: 

497 return None 

498 field_type = found.type 

499 # Unwrap Optional[X] → X 

500 origin = get_origin(field_type) 

501 if origin is Union: 

502 unwrapped = [a for a in get_args(field_type) if a is not type(None)] 

503 field_type = unwrapped[0] if len(unwrapped) == 1 else field_type 

504 current_cls = field_type 

505 return current_cls 

506 

507 

508def _coerce_cli_value(raw: str, dot_path: str, root_class: Type) -> Any: 

509 """Parse a CLI string value, coercing to the correct type for the field. 

510 

511 Bool fields accept an extended string set. For all other 

512 fields the existing int → float → str heuristic is used. 

513 

514 Args: 

515 raw: Raw string from the CLI. 

516 dot_path: Dot-separated field path used for type lookup. 

517 root_class: Root dataclass class for type resolution. 

518 

519 Returns: 

520 Coerced value. 

521 """ 

522 field_type = _resolve_field_type(root_class, dot_path) 

523 if field_type is bool: 

524 try: 

525 return _string_to_bool(raw) 

526 except ValueError: 

527 pass # fall through to heuristic below 

528 # Existing heuristic: int → float → bool-string → str 

529 try: 

530 return int(raw) 

531 except ValueError: 

532 pass 

533 try: 

534 return float(raw) 

535 except ValueError: 

536 pass 

537 if raw.lower() in ("true", "false"): 

538 return raw.lower() == "true" 

539 return raw 

540 

541 

542def _deep_update(source: Dict[str, Any], overrides: Dict[str, Any]) -> Dict[str, Any]: 

543 """Recursively update source dict with overrides dict.""" 

544 for key, value in overrides.items(): 

545 if isinstance(value, dict) and isinstance(source.get(key), dict): 

546 _deep_update(source[key], value) 

547 else: 

548 source[key] = value 

549 return source 

550 

551_ALLOWED_TOP_LEVEL_KEYS = frozenset({"model", "data", "train"}) 

552 

553 

554def _validate_top_level(config: Dict[str, Any]) -> None: 

555 """Reject any top-level key other than ``model`` / ``data`` / ``train``. 

556 

557 Strict three-tier YAML shape. Any flat-style legacy key 

558 (``parallel``, ``optim``, ``mixed_precision``, ``runtime``, ``debug`` ...) 

559 must be moved under ``train.*`` — see schema.py for the canonical layout. 

560 

561 Raises: 

562 ValueError: With migration hints when forbidden top-level keys are 

563 present in the YAML. 

564 """ 

565 forbidden = sorted(set(config) - _ALLOWED_TOP_LEVEL_KEYS) 

566 if not forbidden: 

567 return 

568 

569 legacy_to_train_path = { 

570 "parallel": "train.accelerator", 

571 "optim": "train.optimizer", 

572 "mixed_precision": "train.mixed_precision", 

573 "memory": "train.gradient_checkpointing", 

574 "checkpoint": "train.checkpoint", 

575 "logging": "train.logging", 

576 "tensorboard": "train.tensorboard", 

577 "wandb": "train.wandb", 

578 "profiler": "train.profile", 

579 "memory_monitor": "train.memory_monitor", 

580 "moe_monitor": "train.moe_monitor", 

581 "eval": "train.eval", 

582 "runtime": "train (flatten init_device / backend / comm_backend)", 

583 "debug": "train.debug", 

584 "seed": "train.seed", 

585 } 

586 hints = [] 

587 for key in forbidden: 

588 new_path = legacy_to_train_path.get(key) 

589 if new_path: 

590 hints.append(f" - top-level '{key}:' → move under {new_path}") 

591 else: 

592 hints.append(f" - top-level '{key}:' is not allowed") 

593 raise ValueError( 

594 "Forbidden top-level YAML keys: %s. The schema is strict three-tier " 

595 "(model / data / train) — see config/schema.py. Migrate as follows:\n%s" 

596 % (forbidden, "\n".join(hints)) 

597 ) 

598 

599 

600def _instantiate_recursive(cls: Type[T], config_dict: Dict[str, Any]) -> T: 

601 """Recursively convert a dict into nested dataclass instances. 

602 

603 Unknown keys in ``config_dict`` that have no corresponding field on 

604 ``cls`` emit a ``logger.warning`` with a closest-match suggestion from 

605 ``difflib``, helping users catch typos in YAML configs. 

606 """ 

607 if not is_dataclass(cls): 

608 return config_dict 

609 

610 known = {f.name for f in fields(cls)} 

611 unknown = set(config_dict) - known 

612 for name in sorted(unknown): 

613 matches = difflib.get_close_matches(name, known, n=1) 

614 suggestion = f" Did you mean '{matches[0]}'?" if matches else "" 

615 logger.warning( 

616 "Unknown config key '%s' for %s ignored.%s", 

617 name, cls.__name__, suggestion, 

618 ) 

619 

620 field_values = {} 

621 for field_info in fields(cls): 

622 if field_info.name not in config_dict: 

623 continue 

624 raw_value = config_dict[field_info.name] 

625 field_type = field_info.type 

626 

627 # Unwrap Optional[X] → X 

628 origin = get_origin(field_type) 

629 if origin is Union: 

630 unwrapped = [a for a in get_args(field_type) if a is not type(None)] 

631 if len(unwrapped) == 1: 

632 field_type = unwrapped[0] 

633 

634 if is_dataclass(field_type) and isinstance(raw_value, dict): 

635 field_values[field_info.name] = _instantiate_recursive(field_type, raw_value) 

636 elif field_type is bool and isinstance(raw_value, str): 

637 field_values[field_info.name] = _string_to_bool(raw_value) 

638 else: 

639 field_values[field_info.name] = raw_value 

640 

641 return cls(**field_values) 

642 

643 

644def parse_args(root_class: Type[T]) -> T: 

645 """Parse training config from YAML file + CLI overrides. 

646 

647 Usage:: 

648 

649 args = parse_args(HyperTrainerConfig) 

650 

651 The first positional argument is the YAML config file path. 

652 CLI arguments use dot-path notation under the strict three-tier schema: 

653 ``--train.accelerator.dp_shard=8 --train.optimizer.lr=3e-4`` 

654 

655 Bool fields accept extended string aliases (``yes/no/on/off/y/n/t/f/1/0``). 

656 Unknown YAML keys emit a warning with a closest-match suggestion. 

657 

658 Args: 

659 root_class: The root config dataclass type. 

660 

661 Returns: 

662 An instance of root_class populated from YAML + CLI. 

663 """ 

664 parser = argparse.ArgumentParser(description="HyperParallel Trainer") 

665 parser.add_argument("config_file", nargs="?", help="Path to YAML config file") 

666 args, remaining = parser.parse_known_args() 

667 

668 # Load YAML 

669 final_config: dict = {} 

670 if args.config_file: 

671 if not os.path.isfile(args.config_file): 

672 logger.warning( 

673 "Config file not found: %s (cwd=%s). Using all defaults.", 

674 args.config_file, os.getcwd(), 

675 ) 

676 else: 

677 with open(args.config_file, encoding="utf-8") as f: 

678 yaml_config = yaml.safe_load(f) 

679 if yaml_config: 

680 final_config = yaml_config 

681 

682 # Parse CLI dot-path overrides: --train.accelerator.dp=8 → nested dict 

683 cli_config: dict = {} 

684 for item in remaining: 

685 if item.startswith("--") and "=" in item: 

686 dot_key, raw_value = item[2:].split("=", 1) 

687 coerced = _coerce_cli_value(raw_value, dot_key, root_class) 

688 keys = dot_key.split(".") 

689 current = cli_config 

690 for k in keys[:-1]: 

691 current = current.setdefault(k, {}) 

692 current[keys[-1]] = coerced 

693 

694 # CLI overrides YAML 

695 final_config = _deep_update(final_config, cli_config) 

696 

697 # Strict three-tier validation — only model / data / train allowed. 

698 _validate_top_level(final_config) 

699 

700 # local_rank from environment (torchrun sets it). 

701 local_rank = int(os.environ.get("LOCAL_RANK", "0")) 

702 final_config.setdefault("train", {})["local_rank"] = local_rank 

703 

704 return _instantiate_recursive(root_class, final_config)