#!/usr/bin/env python3 # coding=utf-8 """DFlash Training Script.""" import argparse import logging import math import os import shutil import time import warnings from typing import Optional, Tuple import torch import torch.distributed as dist from accelerate.utils import set_seed from torch.distributed.fsdp import FullyShardedDataParallel as FSDP from torch.distributed.fsdp import MixedPrecision, ShardingStrategy, StateDictType from torch.utils.data import DataLoader from tqdm import tqdm from transformers import AutoConfig, AutoTokenizer from datasets import load_dataset from specforge.args import SGLangBackendArgs, TrackerArgs from specforge.core.dflash import OnlineDFlashModel from specforge.data import build_eagle3_dataset, prepare_dp_dataloaders from specforge.distributed import destroy_distributed, get_dp_group, get_tp_group, init_distributed from specforge.modeling.draft.dflash import DFlashDraftModel from specforge.modeling.target.dflash_target_model import ( DFlashTargetModel, get_dflash_target_model, ) from specforge.modeling.target.target_utils import TargetEmbeddingsAndHead from specforge.optimizer import BF16Optimizer from specforge.tracker import create_tracker from specforge.utils import get_last_checkpoint, print_on_rank0, print_with_rank # ──────────────────────────────────────────────────────────────── # Memory profiling utilities # ──────────────────────────────────────────────────────────────── def _mb(bytes_val: int) -> float: return bytes_val / 1024 ** 2 def log_cuda_memory(tag: str, rank_only: int = 0) -> None: """Print current / peak CUDA memory at a labelled checkpoint (rank 0 only).""" if not torch.cuda.is_available(): return if dist.is_available() and dist.is_initialized() and dist.get_rank() != rank_only: return allocated = _mb(torch.cuda.memory_allocated()) reserved = _mb(torch.cuda.memory_reserved()) peak_alloc = _mb(torch.cuda.max_memory_allocated()) peak_res = _mb(torch.cuda.max_memory_reserved()) logging.getLogger(__name__).info( f"[VRAM | {tag}] " f"allocated={allocated:.1f} MB reserved={reserved:.1f} MB " f"peak_alloc={peak_alloc:.1f} MB peak_res={peak_res:.1f} MB" ) def log_model_memory(name: str, model: torch.nn.Module, rank_only: int = 0) -> None: """Print parameter + gradient memory for a given model (rank 0 only).""" if dist.is_available() and dist.is_initialized() and dist.get_rank() != rank_only: return param_bytes = sum(p.numel() * p.element_size() for p in model.parameters()) grad_bytes = sum( p.grad.numel() * p.grad.element_size() for p in model.parameters() if p.grad is not None ) logging.getLogger(__name__).info( f"[MODEL MEM | {name}] " f"params={_mb(param_bytes):.1f} MB " f"grads={_mb(grad_bytes):.1f} MB " f"total={_mb(param_bytes + grad_bytes):.1f} MB" ) def log_optimizer_memory(name: str, optimizer, rank_only: int = 0) -> None: """Estimate optimizer state memory (rank 0 only).""" if dist.is_available() and dist.is_initialized() and dist.get_rank() != rank_only: return state_bytes = 0 for state in optimizer.optimizer.state.values(): for v in state.values(): if isinstance(v, torch.Tensor): state_bytes += v.numel() * v.element_size() logging.getLogger(__name__).info( f"[OPT MEM | {name}] optimizer_states={_mb(state_bytes):.1f} MB" ) def log_tensor_memory(name: str, tensor: torch.Tensor, rank_only: int = 0) -> None: """Print memory of a single tensor (rank 0 only).""" if dist.is_available() and dist.is_initialized() and dist.get_rank() != rank_only: return mb = _mb(tensor.numel() * tensor.element_size()) logging.getLogger(__name__).info( f"[TENSOR | {name}] shape={tuple(tensor.shape)} dtype={tensor.dtype} size={mb:.1f} MB" ) def reset_peak_memory() -> None: """Reset CUDA peak memory stats.""" if torch.cuda.is_available(): torch.cuda.reset_peak_memory_stats() # ──────────────────────────────────────────────────────────────── def parse_args(): parser = argparse.ArgumentParser(description="Train DFlash Draft Model") model_group = parser.add_argument_group("model") model_group.add_argument("--target-model-path", type=str, required=True) model_group.add_argument( "--target-model-backend", type=str, default="hf", choices=["sglang", "hf"], help="Backend for target model: 'sglang' (service) or 'hf' (local)", ) model_group.add_argument("--draft-config-path", type=str, default=None) model_group.add_argument("--block-size", type=int, default=16) model_group.add_argument("--num-draft-layers", type=int, default=1) model_group.add_argument( "--mask-token-id", type=int, default=None, help="MASK token ID. If not provided, auto-detect from tokenizer.", ) model_group.add_argument( "--attention-backend", type=str, default="flex_attention", choices=["eager", "sdpa", "flex_attention"], help="Attention backend for draft model.", ) model_group.add_argument( "--trust-remote-code", action="store_true", help="Trust remote code" ) model_group.add_argument( "--random-anchor", action="store_true", help="Enable random anchor sampling for block construction (paper Sec 4.2).", ) model_group.add_argument( "--num-anchors", type=int, default=512, help="Number of anchor positions per sequence when --random-anchor is set.", ) model_group.add_argument( "--loss-decay-gamma", type=float, default=None, help="Gamma for exponential loss decay weighting (paper Eq.4). " "Suggested: 7 for block_size=16, 5 for 10, 4 for 8. None disables.", ) dataset_group = parser.add_argument_group("dataset") dataset_group.add_argument("--train-data-path", type=str, required=True) dataset_group.add_argument("--eval-data-path", type=str, default=None) dataset_group.add_argument("--chat-template", type=str, default="qwen") dataset_group.add_argument("--is-preformatted", action="store_true") dataset_group.add_argument("--dataloader-num-workers", type=int, default=8) dataset_group.add_argument( "--build-dataset-num-proc", type=int, default=int(os.environ.get("SPECFORGE_DATA_NUM_PROC", 8)), ) training_group = parser.add_argument_group("training") training_group.add_argument("--num-epochs", type=int, default=6) training_group.add_argument("--batch-size", type=int, default=1) training_group.add_argument("--learning-rate", type=float, default=6e-4) training_group.add_argument("--max-length", type=int, default=3072) training_group.add_argument("--warmup-ratio", type=float, default=0.04) training_group.add_argument("--max-grad-norm", type=float, default=1.0) training_group.add_argument("--accumulation-steps", type=int, default=1) training_group.add_argument( "--optimizer-type", type=str, default="adamw", choices=["adamw", "adamw_8bit", "apollo"], help="Optimizer type (default: adamw)", ) training_group.add_argument( "--optimizer-config", type=str, default=None, help="Path to optimizer config JSON file (required for apollo)", ) training_group.add_argument( "--no-fp32-params", action="store_true", help="Disable FP32 master copy of parameters to save memory", ) training_group.add_argument( "--gradient-checkpointing", action="store_true", help="Enable gradient checkpointing to save memory (trades compute for memory)", ) training_group.add_argument("--seed", type=int, default=42) training_group.add_argument("--resume", action="store_true") training_group.add_argument( "--ckpt-dir", type=str, default=None, help="Directory of the checkpoint to resume training from", ) output_group = parser.add_argument_group("output") output_group.add_argument("--output-dir", type=str, required=True) output_group.add_argument("--cache-dir", type=str, default="./cache") output_group.add_argument("--log-interval", type=int, default=50) output_group.add_argument("--eval-interval", type=int, default=1000) output_group.add_argument("--save-interval", type=int, default=1000) optimization_group = parser.add_argument_group("optimization") optimization_group.add_argument( "--tp-size", type=int, default=1, help="The size of the tensor parallel for the target model", ) optimization_group.add_argument( "--lm-head-chunk-size", type=int, default=0, help="Chunk size for lm_head + CE loss computation. " "When > 0, processes sequence in chunks to avoid materializing " "full [bsz, seq_len, vocab_size] logits tensor. " "Recommended: 256-1024 for large vocab models. 0 disables chunking.", ) tracker_group = parser.add_argument_group("tracker") TrackerArgs.add_args(tracker_group) dist_group = parser.add_argument_group("distributed") dist_group.add_argument("--dist-timeout", type=int, default=30) # SGLang specific args sglang_group = parser.add_argument_group("sglang backend") SGLangBackendArgs.add_args(sglang_group) return parser.parse_args() def build_models(args) -> Tuple[DFlashTargetModel, DFlashDraftModel]: """Build target model (backend wrapper) and draft model.""" print_on_rank0( f"Loading target model from {args.target_model_path} using {args.target_model_backend} backend" ) # 1. Build Target Model Wrapper target_model_kwargs = {} if args.target_model_backend == "sglang": target_model_kwargs = SGLangBackendArgs.from_args(args).to_kwargs() target_model = get_dflash_target_model( pretrained_model_name_or_path=args.target_model_path, backend=args.target_model_backend, torch_dtype=torch.bfloat16, device="cuda" if args.target_model_backend == "hf" else None, trust_remote_code=args.trust_remote_code, **target_model_kwargs, ) # 2. Build Draft Model if args.draft_config_path: draft_config = AutoConfig.from_pretrained(args.draft_config_path) print_on_rank0(f"Loaded draft config from {args.draft_config_path}") else: target_config = AutoConfig.from_pretrained(args.target_model_path) draft_config = AutoConfig.from_pretrained(args.target_model_path) draft_config.num_hidden_layers = args.num_draft_layers draft_config.block_size = args.block_size draft_config.num_target_layers = target_config.num_hidden_layers print_on_rank0("Auto-generated draft config from target model") if not hasattr(draft_config, "dflash_config") or draft_config.dflash_config is None: draft_config.dflash_config = {} draft_config._attn_implementation = args.attention_backend print_on_rank0(f"Using attention backend: {args.attention_backend}") draft_model = DFlashDraftModel(draft_config).cuda().to(torch.bfloat16) target_model.set_capture_layers(draft_model.target_layer_ids) print_on_rank0( f"Draft config: block_size={draft_config.block_size}, " f"num_hidden_layers={draft_config.num_hidden_layers}, " f"num_target_layers={draft_config.num_target_layers}" ) print_on_rank0( f"Draft model parameters: {sum(p.numel() for p in draft_model.parameters()):,}" ) # ── Memory checkpoint: after model loading ── log_cuda_memory("after build_models") if hasattr(target_model, "model"): log_model_memory("target_model", target_model.model) log_model_memory("draft_model", draft_model) return target_model, draft_model def build_dataloader(args, tokenizer) -> Tuple[DataLoader, Optional[DataLoader]]: """Build train and eval dataloaders.""" import hashlib cache_params_string = ( f"{args.train_data_path}-" f"{args.max_length}-" f"{args.chat_template}-" f"{args.target_model_path}" ) cache_key = hashlib.md5(cache_params_string.encode()).hexdigest() train_dataset = load_dataset("json", data_files=args.train_data_path)["train"] train_eagle3_dataset = build_eagle3_dataset( dataset=train_dataset, tokenizer=tokenizer, chat_template=args.chat_template, max_length=args.max_length, is_preformatted=args.is_preformatted, cache_dir=os.path.join(args.cache_dir, "processed_dataset"), cache_key=cache_key, num_proc=args.build_dataset_num_proc, ) min_loss_tokens = 2 * args.block_size original_size = len(train_eagle3_dataset) train_eagle3_dataset = train_eagle3_dataset.filter( lambda x: x["loss_mask"].sum() >= min_loss_tokens ) print_on_rank0( f"Filtered train dataset: {original_size} -> {len(train_eagle3_dataset)} samples" ) train_dataloader = prepare_dp_dataloaders( train_eagle3_dataset, args.batch_size, num_workers=args.dataloader_num_workers, shuffle=True, process_group=get_dp_group(), ) eval_dataloader = None if args.eval_data_path: eval_dataset = load_dataset("json", data_files=args.eval_data_path)["train"] eval_eagle3_dataset = build_eagle3_dataset( dataset=eval_dataset, tokenizer=tokenizer, chat_template=args.chat_template, max_length=args.max_length, is_preformatted=args.is_preformatted, ) eval_dataloader = prepare_dp_dataloaders( eval_eagle3_dataset, args.batch_size, num_workers=args.dataloader_num_workers, shuffle=False, process_group=get_dp_group(), ) return train_dataloader, eval_dataloader def save_checkpoint(args, epoch, step, dflash_model, draft_model, optimizer): """Save checkpoint.""" save_dir = os.path.join(args.output_dir, f"epoch_{epoch}_step_{step}") if dist.get_rank() == 0: os.makedirs(save_dir, exist_ok=True) dist.barrier() with FSDP.state_dict_type(dflash_model, StateDictType.FULL_STATE_DICT): state_dict = dflash_model.state_dict() draft_state_dict = { k.replace("draft_model.", ""): v for k, v in state_dict.items() if "draft_model." in k } if dist.get_rank() == 0: torch.save( { "epoch": epoch, "global_step": step, "args": args, **optimizer.state_dict(), }, os.path.join(save_dir, "training_state.pt"), ) draft_model.save_pretrained(save_dir, state_dict=draft_state_dict) modeling_src = os.path.join( os.path.dirname(__file__), "..", "specforge", "modeling", "draft", "dflash.py", ) modeling_dst = os.path.join(save_dir, "dflash.py") if os.path.exists(modeling_src): shutil.copy(modeling_src, modeling_dst) print_on_rank0(f"Saved checkpoint to {save_dir}") dist.barrier() def record_metrics( args, loss: float, accuracy: float, global_step: int, tracker, optimizer, train_dataloader=None, mode: str = "train", ) -> None: logdict = {} if mode == "train" and optimizer is not None: logdict["train/lr"] = optimizer.get_learning_rate() logdict[f"{mode}/loss"] = loss logdict[f"{mode}/accuracy"] = accuracy print_on_rank0( f"{mode.capitalize()} - Step {global_step} [{global_step}/{args.num_epochs * len(train_dataloader) // args.accumulation_steps}?], Loss: {loss:.4f}, Acc: {accuracy:.4f}" ) tracker.log(logdict, step=global_step) def get_dp_data_shard_from_tp(tensor: torch.Tensor) -> torch.Tensor: """Shard batch data across TP ranks so each rank processes a unique portion.""" tp_size = dist.get_world_size(get_tp_group()) tp_rank = dist.get_rank(get_tp_group()) return tensor.chunk(tp_size, dim=0)[tp_rank] def main(): logging.basicConfig( format="%(asctime)s - %(levelname)s - %(name)s - %(message)s", datefmt="%m/%d/%Y %H:%M:%S", level=logging.INFO, ) logging.getLogger().setLevel(logging.INFO) warnings.filterwarnings( "ignore", "The .grad attribute of a Tensor that is not a leaf Tensor is being accessed", ) args = parse_args() set_seed(args.seed) init_distributed(timeout=args.dist_timeout, tp_size=args.tp_size) print_with_rank("Initialized distributed") target_model, draft_model = build_models(args) draft_model_last_checkpoint = None # ── Memory checkpoint 1: right after models are on GPU ── log_cuda_memory("checkpoint-1: after build_models") if args.ckpt_dir is not None: if os.path.isdir(args.ckpt_dir): draft_model_last_checkpoint = args.ckpt_dir print_on_rank0(f"Using checkpoint: {draft_model_last_checkpoint}") else: raise ValueError( f"Provided ckpt dir {args.ckpt_dir} is not a valid directory." ) if args.resume and os.path.isdir(args.output_dir): draft_model_last_checkpoint = get_last_checkpoint( args.output_dir, prefix=r"epoch_\d+_step" ) print_on_rank0(f"Last checkpoint detected: {draft_model_last_checkpoint}") resume_state = None if draft_model_last_checkpoint: loaded_model = DFlashDraftModel.from_pretrained( draft_model_last_checkpoint, torch_dtype=torch.bfloat16 ) draft_model.load_state_dict(loaded_model.state_dict()) del loaded_model print_on_rank0("Loaded draft model weights from checkpoint") training_state_path = os.path.join( draft_model_last_checkpoint, "training_state.pt" ) if os.path.exists(training_state_path): resume_state = torch.load( training_state_path, map_location="cpu", weights_only=False ) print_on_rank0( f"Will resume from epoch {resume_state['epoch']}, " f"step {resume_state['global_step']}" ) tokenizer = AutoTokenizer.from_pretrained(args.target_model_path) if args.mask_token_id is not None: mask_token_id = args.mask_token_id elif tokenizer.mask_token_id is not None: mask_token_id = tokenizer.mask_token_id else: tokenizer.add_special_tokens({"mask_token": "<|MASK|>"}) mask_token_id = tokenizer.mask_token_id print_on_rank0(f"Using mask_token_id: {mask_token_id}") draft_model.mask_token_id = mask_token_id draft_model.config.dflash_config["mask_token_id"] = mask_token_id draft_model.config.dflash_config["target_layer_ids"] = draft_model.target_layer_ids if args.gradient_checkpointing: draft_model.gradient_checkpointing_enable() print_on_rank0("Gradient checkpointing enabled for draft model") print_on_rank0(f"dflash_config: {draft_model.config.dflash_config}") train_dataloader, eval_dataloader = build_dataloader(args, tokenizer) steps_per_epoch = math.ceil(len(train_dataloader) / args.accumulation_steps) total_steps = args.num_epochs * steps_per_epoch print_on_rank0(f"Total training steps: {total_steps}") print_on_rank0("Loading target embeddings and head...") target_components = TargetEmbeddingsAndHead.from_pretrained( args.target_model_path, embed_key="model.embed_tokens.weight", # Adjust if Qwen/Llama differs lm_head_key="lm_head.weight", device="cuda", trust_remote_code=args.trust_remote_code, ) # ── Memory checkpoint 2: after loading embed + lm_head ── log_cuda_memory("checkpoint-2: after TargetEmbeddingsAndHead") log_model_memory("embed_tokens", target_components.embed_tokens) log_model_memory("lm_head", target_components.lm_head) dflash_model = OnlineDFlashModel( draft_model=draft_model, target_lm_head=target_components.lm_head, target_embed_tokens=target_components.embed_tokens, block_size=draft_model.block_size, mask_token_id=mask_token_id, attention_backend=args.attention_backend, random_anchor=args.random_anchor, num_anchors=args.num_anchors, loss_decay_gamma=args.loss_decay_gamma, lm_head_chunk_size=args.lm_head_chunk_size, ) dflash_model = FSDP( dflash_model, use_orig_params=True, mixed_precision=MixedPrecision( param_dtype=torch.bfloat16, buffer_dtype=torch.bfloat16, ), sharding_strategy=ShardingStrategy.SHARD_GRAD_OP, ) print_with_rank("Initialized FSDP") # ── Memory checkpoint 3: after FSDP wrapping ── log_cuda_memory("checkpoint-3: after FSDP wrap") optimizer = BF16Optimizer( draft_model, lr=args.learning_rate, max_grad_norm=args.max_grad_norm, warmup_ratio=args.warmup_ratio, total_steps=total_steps, use_fp32_params=not args.no_fp32_params, optimizer_type=args.optimizer_type, optimizer_config=args.optimizer_config, ) # ── Memory checkpoint 4: after optimizer init ── log_cuda_memory("checkpoint-4: after optimizer init") log_optimizer_memory("BF16Optimizer", optimizer) start_epoch = 0 global_step = 0 if resume_state is not None: optimizer.scheduler.load_state_dict(resume_state["scheduler_state_dict"]) start_epoch = resume_state["epoch"] global_step = resume_state["global_step"] del resume_state print_on_rank0(f"Restored scheduler, lr={optimizer.get_learning_rate():.6f}") skip_steps = global_step - start_epoch * len(train_dataloader) print_on_rank0(f"Initializing tracker (report_to={args.report_to})...") tracker = create_tracker(args, args.output_dir) print_on_rank0("Tracker initialized successfully.") last_time = time.time() print_on_rank0(f"Starting training from epoch {start_epoch}, step {global_step}") for epoch in range(start_epoch, args.num_epochs): train_dataloader.sampler.set_epoch(epoch) draft_model.train() if dist.get_rank() == 0: progress_bar = tqdm( train_dataloader, desc=f"Training Epoch {epoch}", leave=True ) else: progress_bar = train_dataloader for step_in_epoch, data in enumerate(progress_bar): if epoch == start_epoch and step_in_epoch < skip_steps: continue global_step += 1 # ── Memory checkpoint 5: start of step (only first step) ── _is_first_step = (global_step == (start_epoch * len(train_dataloader) + skip_steps + 1)) if _is_first_step: reset_peak_memory() log_cuda_memory("step-start (first step)") input_ids = data["input_ids"].cuda() attention_mask = data["attention_mask"].cuda() loss_mask = data["loss_mask"].cuda() if _is_first_step: log_tensor_memory("input_ids", input_ids) log_tensor_memory("attention_mask", attention_mask) log_tensor_memory("loss_mask", loss_mask) log_cuda_memory("after data-to-GPU") target_output = target_model.generate_dflash_data( input_ids, attention_mask, loss_mask ) hidden_states = target_output.hidden_states.cuda().clone() # Ensure on GPU if _is_first_step: log_tensor_memory("hidden_states", hidden_states) log_cuda_memory("after target_model.generate_dflash_data") loss, accuracy = dflash_model( input_ids=input_ids, attention_mask=attention_mask, hidden_states=hidden_states, loss_mask=loss_mask, ) if _is_first_step: log_cuda_memory("after dflash_model forward") (loss / args.accumulation_steps).backward() if _is_first_step: log_cuda_memory("after backward") log_model_memory("draft_model (with grads)", draft_model) if global_step % args.accumulation_steps == 0: optimizer.step() if _is_first_step: log_cuda_memory("after optimizer.step") log_optimizer_memory("BF16Optimizer (after first step)", optimizer) if global_step % args.log_interval == 0: loss_log = loss.clone() acc_log = accuracy.clone() dist.all_reduce(loss_log) dist.all_reduce(acc_log) loss_log = loss_log / dist.get_world_size() acc_log = acc_log / dist.get_world_size() record_metrics( args, loss_log.item(), acc_log.item(), global_step, tracker, optimizer, train_dataloader, mode="train", ) if dist.get_rank() == 0: elapsed = time.time() - last_time last_time = time.time() progress_bar.set_postfix( { "loss": f"{loss.item():.4f}", "acc": f"{accuracy.item():.4f}", "iter_time": f"{elapsed:.2f}s", } ) if global_step % args.save_interval == 0: save_checkpoint( args, epoch, global_step, dflash_model, draft_model, optimizer ) save_checkpoint( args, args.num_epochs, global_step, dflash_model, draft_model, optimizer ) tracker.close() destroy_distributed() if __name__ == "__main__": main()