import glob import logging import os import re import subprocess import sys import random from datetime import datetime import numpy as np import torch from torch import optim from torch.cuda.amp import GradScaler from open_clip import create_model_and_transforms, get_tokenizer, create_model from training.data import get_data from training.distributed import is_master, init_distributed_device, broadcast_object from training.logger import setup_logging from training.params import parse_args from training.scheduler import cosine_lr, const_lr, const_lr_cooldown from training.train import train_one_epoch, evaluate, student_teacher_ensemble from training.file_utils import pt_load from training.region_clip import RegionCLIP from training.densevlm import DenseVLM from src.training.clipself import CLIPSelf # Name for the most recent checkpoint file LATEST_CHECKPOINT_NAME = "epoch_latest.pt" def random_seed(seed=42, rank=0): """Sets the random seed for reproducibility.""" torch.manual_seed(seed + rank) np.random.seed(seed + rank) random.seed(seed + rank) def natural_key(string_): """ Sorts strings containing numbers in a natural order (e.g., file_9.pt, file_10.pt). See http://www.codinghorror.com/blog/archives/001018.html """ return [int(s) if s.isdigit() else s for s in re.split(r'(\d+)', string_.lower())] def get_latest_checkpoint(path: str, remote: bool): """ Finds the path to the latest checkpoint file in a given directory. Supports local and remote (AWS S3) paths. """ if remote: result = subprocess.run(["aws", "s3", "ls", path + "/"], stdout=subprocess.PIPE, stderr=subprocess.PIPE) if result.returncode == 1: return None checkpoints = [os.path.join(path, x.split(' ')[-1]) for x in result.stdout.decode().split('\n')[:-1]] else: checkpoints = glob.glob(path + '**/*.pt', recursive=True) if checkpoints: checkpoints = sorted(checkpoints, key=natural_key) return checkpoints[-1] return None def main(args): """ Main function to orchestrate model training and evaluation. """ args = parse_args(args) # Configure CUDA settings for performance if torch.cuda.is_available(): torch.backends.cuda.matmul.allow_tf32 = True torch.backends.cudnn.benchmark = True torch.backends.cudnn.deterministic = False # Initialize distributed device environment device = init_distributed_device(args) # This might include torch.distributed.init_process_group # get the name of the experiments if args.name is None: # sanitize model name for filesystem / uri use, easier if we don't use / in name as a rule? model_name_safe = args.model.replace('/', '-') date_str = datetime.now().strftime("%Y_%m_%d-%H_%M_%S") if args.distributed: # sync date_str from master to all ranks date_str = broadcast_object(args, date_str) args.name = '-'.join([ date_str, f"model_{model_name_safe}", f"lr_{args.lr}", f"b_{args.batch_size}", f"j_{args.workers}", f"p_{args.precision}", ]) log_base_path = os.path.join(args.logs, args.name) args.log_path = None should_exit = False if is_master(args, local=args.log_local): os.makedirs(log_base_path, exist_ok=True) log_filename = f'out-{args.rank}' if args.log_local else 'out.log' args.log_path = os.path.join(log_base_path, log_filename) if os.path.exists(args.log_path): print(f"Error. Log directory/path for experiment '{args.name}' already exists. Use --name to specify a new path name.") should_exit = True # Broadcast exit signal to all ranks if args.distributed: should_exit = broadcast_object(args, should_exit) # Ensure all ranks get the exit signal # if should_exit: # if args.distributed: # # If distributed, ensure all processes are terminated # # This might require some form of collective communication or simply exit # # after all ranks have received the signal. # # A common pattern is to use sys.exit() immediately after this check. # pass # We'll call sys.exit() directly below to be safe. # sys.exit(1) # Force exit for all processes if should_exit is True # Setup text logger args.log_level = logging.DEBUG if args.debug else logging.INFO setup_logging(args.log_path, args.log_level) # This might still be None for non-master ranks, handle in setup_logging if needed args.checkpoint_path = os.path.join(log_base_path, "checkpoints") if args.precision == 'fp16': logging.warning( 'It is recommended to use AMP mixed-precision instead of FP16. ' 'FP16 support needs further verification and tuning, especially for train.') elif args.distributed: logging.info( f'Running in distributed mode with multiple processes. Device: {args.device}.' f'Process (global: {args.rank}, local {args.local_rank}), total {args.world_size}.') else: logging.info(f'Running with a single process. Device {args.device}.') if isinstance(args.force_image_size, (tuple, list)) and len(args.force_image_size) == 1: # arg is nargs, single (square) image size list -> int args.force_image_size = args.force_image_size[0] random_seed(args.seed, args.rank) model, preprocess_train, preprocess_val = create_model_and_transforms( args.model, args.pretrained, precision=args.precision, device=device, jit=args.torchscript, force_quick_gelu=args.force_quick_gelu, force_custom_text=args.force_custom_text, force_patch_dropout=args.force_patch_dropout, force_image_size=args.force_image_size, pretrained_image=args.pretrained_image, image_mean=args.image_mean, image_std=args.image_std, aug_cfg=args.aug_cfg, output_dict=True, cache_dir=args.cache_dir, det_image_size=args.det_image_size, dataset_type=args.dataset_type, ) args.input_size = model.visual.image_size dist_model = None dist_P_VLM = None if args.train_data: if args.method_type == 'region_clip': logging.info(f"{args.dataset_type}, set dist_model and dist_P_VLM as None") method = RegionCLIP(args=args).to(device) elif args.method_type == 'clipself': logging.info(f"{args.dataset_type}, use dist_mode") dist_model = create_model( args.model, args.pretrained, device=device, precision=args.precision, output_dict=True, cache_dir=args.cache_dir ) method = CLIPSelf().to(device) elif args.method_type == 'densevlm': logging.info(f"{args.dataset_type}, use dist_P_VLM") dist_P_VLM = create_model( 'EVA02-CLIP-L-14-336', 'eva', device=device, precision=args.precision, output_dict=True, cache_dir='checkpoints/clipself_coco_6_save6_512_eva_vitl14_24layers.pt' # cache dir of pre-trained models ) method = DenseVLM(args=args).to(device) else: raise NotImplementedError if args.lock_image: # lock image tower as per LiT - https://arxiv.org/abs/2111.07991 model.lock_image_tower( unlocked_groups=args.lock_image_unlocked_groups, freeze_bn_stats=args.lock_image_freeze_bn_stats, ) if args.grad_checkpointing: model.set_grad_checkpointing() if is_master(args): logging.info("Model:") logging.info(f"{str(model)}") logging.info("Params:") params_file = os.path.join(args.logs, args.name, "params.txt") with open(params_file, "w") as f: for name in sorted(vars(args)): val = getattr(args, name) logging.info(f" {name}: {val}") f.write(f"{name}: {val}\n") if args.distributed: if args.use_bn_sync: model = torch.nn.SyncBatchNorm.convert_sync_batchnorm(model) ddp_args = {} # {"find_unused_parameters": True} if args.ddp_static_graph: # this doesn't exist in older PyTorch, arg only added if enabled ddp_args['static_graph'] = True model = torch.nn.parallel.DistributedDataParallel(model, device_ids=[device], **ddp_args) if args.dataset_type == 'region_clip': method = torch.nn.parallel.DistributedDataParallel(method, device_ids=[device], **ddp_args) if dist_model is not None: dist_model = torch.nn.parallel.DistributedDataParallel(dist_model, device_ids=[device], **ddp_args) if dist_P_VLM is not None: dist_P_VLM = torch.nn.parallel.DistributedDataParallel(dist_P_VLM, device_ids=[device], **ddp_args) # create optimizer and scaler optimizer = None scaler = None if args.train_data: exclude = lambda n, p: p.ndim < 2 or "bn" in n or "ln" in n or "bias" in n or 'logit_scale' in n include = lambda n, p: not exclude(n, p) named_parameters = list(model.named_parameters()) gain_or_bias_params = [p for n, p in named_parameters if exclude(n, p) and p.requires_grad] rest_params = [p for n, p in named_parameters if include(n, p) and p.requires_grad] optimizer = optim.AdamW( [ {"params": gain_or_bias_params, "weight_decay": 0.}, {"params": rest_params, "weight_decay": args.wd}, ], lr=args.lr, betas=(args.beta1, args.beta2), eps=args.eps, ) scaler = GradScaler() if args.precision == "amp" else None # optionally resume from a checkpoint start_epoch = 0 if args.resume is not None: checkpoint = pt_load(args.resume, map_location='cpu') if 'epoch' in checkpoint: # resuming a train checkpoint w/ epoch and optimizer state start_epoch = checkpoint["epoch"] sd = checkpoint["state_dict"] # if not args.distributed and next(iter(sd.items()))[0].startswith('module'): # sd = {k[len('module.'):]: v for k, v in sd.items()} sd = {f'module.{k}': v for k, v in sd.items()} model.load_state_dict(sd) if optimizer is not None: optimizer.load_state_dict(checkpoint["optimizer"]) if scaler is not None and 'scaler' in checkpoint: scaler.load_state_dict(checkpoint['scaler']) logging.info(f"=> resuming checkpoint '{args.resume}' (epoch {start_epoch})") else: # loading a bare (model only) checkpoint for fine-tune or evaluation model.load_state_dict(checkpoint) logging.info(f"=> loaded checkpoint '{args.resume}' (epoch {start_epoch})") # initialize datasets data = get_data(args, (preprocess_train, preprocess_val), epoch=start_epoch, tokenizer=get_tokenizer(args.model)) assert len(data), 'At least one train or eval dataset must be specified.' # create scheduler if train scheduler = None if 'train' in data and optimizer is not None: total_steps = (data["train"].dataloader.num_batches // args.accum_freq) * args.epochs if args.lr_scheduler == "cosine": scheduler = cosine_lr(optimizer, args.lr, args.warmup, total_steps) elif args.lr_scheduler == "const": scheduler = const_lr(optimizer, args.lr, args.warmup, total_steps) elif args.lr_scheduler == "const-cooldown": assert args.epochs_cooldown is not None,\ "Please specify the number of cooldown epochs for this lr schedule." cooldown_steps = (data["train"].dataloader.num_batches // args.accum_freq) * args.epochs_cooldown scheduler = const_lr_cooldown( optimizer, args.lr, args.warmup, total_steps, cooldown_steps, args.lr_cooldown_power, args.lr_cooldown_end) else: logging.error( f'Unknown scheduler, {args.lr_scheduler}. Available options are: cosine, const, const-cooldown.') exit(1) # determine if this worker should save logs and checkpoints. only do so if it is rank == 0 args.save_logs = args.logs and args.logs.lower() != 'none' and is_master(args) logging.info('Evaluate before training') # This log might be misleading if no train data os.makedirs(args.checkpoint_path, exist_ok=True) if 'train' not in data: if args.alpha < 1.0: # Ensure dist_model exists for ensemble if alpha < 1.0 if dist_model is None: dist_model = create_model( args.model, args.pretrained, device=device, precision=args.precision, output_dict=True, cache_dir='checkpoints/EVA02_CLIP_B_psz16_s8B.pt' ) teacher_state_dict = dist_model.state_dict() student_state_dict = model.module.state_dict() target_state_dict = student_teacher_ensemble(student_state_dict, teacher_state_dict, args.alpha) test_model = create_model( args.model, args.pretrained, device=device, precision=args.precision, output_dict=True, cache_dir=args.cache_dir) test_model.load_state_dict(target_state_dict) if args.distributed: test_model = torch.nn.parallel.DistributedDataParallel(test_model, device_ids=[device], **ddp_args) evaluate(test_model, data, start_epoch, args) if dist_model is not None: # Clean up after use del dist_model else: evaluate(model, data, start_epoch, args) return # Main Training Loop loss = None # Initialize loss, though it's typically computed within train_one_epoch for epoch in range(start_epoch, args.epochs): if is_master(args): logging.info(f'Start epoch {epoch}') train_one_epoch(model, method, data, loss, epoch, optimizer, scaler, scheduler, dist_P_VLM, dist_model, args) completed_epoch = epoch + 1 student_state_dict = model.module.state_dict() \ if args.distributed else model.state_dict() if args.alpha < 1.0: if dist_model is not None: teacher_state_dict = dist_model.module.state_dict() \ if args.distributed else dist_model.state_dict() else: logging.info("Creating dist_model for ensemble as it was None.") dist_model = create_model( args.model, args.pretrained, device=device, precision=args.precision, output_dict=True, cache_dir=args.cache_dir) teacher_state_dict = dist_model.state_dict() if dist_model is not None: dist_model = torch.nn.parallel.DistributedDataParallel(dist_model, device_ids=[device], **ddp_args) # Do NOT set dist_model to None immediately here, as it might be used again. # It will be cleaned up by Python's GC if not referenced. target_state_dict = student_teacher_ensemble(student_state_dict, teacher_state_dict, args.alpha) else: target_state_dict = student_state_dict if is_master(args): # Saving checkpoints. checkpoint_dict = { "epoch": completed_epoch, "name": args.name, "state_dict": target_state_dict, "optimizer": optimizer.state_dict(), } if scaler is not None: checkpoint_dict["scaler"] = scaler.state_dict() if completed_epoch == args.epochs or ( args.save_frequency > 0 and (completed_epoch % args.save_frequency) == 0 ): torch.save( checkpoint_dict, os.path.join(args.checkpoint_path, f"epoch_{completed_epoch}.pt"), ) if args.delete_previous_checkpoint: previous_checkpoint = os.path.join(args.checkpoint_path, f"epoch_{completed_epoch - 1}.pt") if os.path.exists(previous_checkpoint): os.remove(previous_checkpoint) if args.save_most_recent: # try not to corrupt the latest checkpoint if save fails tmp_save_path = os.path.join(args.checkpoint_path, "tmp.pt") latest_save_path = os.path.join(args.checkpoint_path, LATEST_CHECKPOINT_NAME) torch.save(checkpoint_dict, tmp_save_path) os.replace(tmp_save_path, latest_save_path) if completed_epoch % args.zeroshot_frequency == 0: test_model = create_model( args.model, args.pretrained, device=device, precision=args.precision, output_dict=True, cache_dir=args.cache_dir) test_model.load_state_dict(target_state_dict) if args.distributed: test_model = torch.nn.parallel.DistributedDataParallel(test_model, device_ids=[device], **ddp_args) evaluate(test_model, data, completed_epoch, args) del test_model if __name__ == "__main__": main(sys.argv[1:])