U yh>@sFddlZddlZddlmmmmZGdddejjZ dS)Nc@sjeZdZdZejjejdddZ e ddZ ddZ d d Z d d Zd dZdedddZddZdS)PostLocalSGDOptimizera Wraps an arbitrary :class:`torch.optim.Optimizer` and runs `post-local SGD `_, This optimizer runs local optimizer at every step. After the warm-up stage, it averages parameters periodically afer the local optimizer is applied. Args: optim: The local optimizer. averager: A model averager instance to run post-localSGD algorithm. Example:: >>> # xdoctest: +SKIP("undefined variables") >>> import torch >>> import torch.distributed as dist >>> import torch.distributed.algorithms.model_averaging.averagers as averagers >>> import torch.nn as nn >>> from torch.distributed.optim import PostLocalSGDOptimizer >>> from torch.distributed.algorithms.ddp_comm_hooks.post_localSGD_hook import ( >>> PostLocalSGDState, >>> post_localSGD_hook, >>> ) >>> >>> model = nn.parallel.DistributedDataParallel( >>> module, device_ids=[rank], output_device=rank >>> ) >>> >>> # Register a post-localSGD communication hook. >>> state = PostLocalSGDState(process_group=None, subgroup=None, start_localSGD_iter=100) >>> model.register_comm_hook(state, post_localSGD_hook) >>> >>> # Create a post-localSGD optimizer that wraps a local optimizer. >>> # Note that ``warmup_steps`` used in ``PostLocalSGDOptimizer`` must be the same as >>> # ``start_localSGD_iter`` used in ``PostLocalSGDState``. >>> local_optim = torch.optim.SGD(params=model.parameters(), lr=0.01) >>> opt = PostLocalSGDOptimizer( >>> optim=local_optim, >>> averager=averagers.PeriodicModelAverager(period=4, warmup_steps=100) >>> ) >>> >>> # In the first 100 steps, DDP runs global gradient averaging at every step. >>> # After 100 steps, DDP runs gradient averaging within each subgroup (intra-node by default), >>> # and post-localSGD optimizer runs global model averaging every 4 steps after applying the local optimizer. >>> for step in range(0, 200): >>> opt.zero_grad() >>> loss = loss_fn(output, labels) >>> loss.backward() >>> opt.step() )optimaveragercCs||_|jj|_||_dSN)r param_groupsr)selfrrra/var/www/html/venv/lib/python3.8/site-packages/torch/distributed/optim/post_localSGD_optimizer.py__init__:s zPostLocalSGDOptimizer.__init__cCs|jjSr)rstaterrrr r ?szPostLocalSGDOptimizer.statecCs |jSr)r__repr__r rrr r CszPostLocalSGDOptimizer.__repr__cCs|j}|jj|d<|S)z This is the same as :class:`torch.optim.Optimizer` :meth:`state_dict`, but adds an extra entry to record model averager's step to the checkpoint to ensure reload does not cause unnecessary warm up again. step)r state_dictrr)rZoptim_state_dictrrr rFs  z PostLocalSGDOptimizer.state_dictcCs8|j|d|kr"|d|j_ntdd|j_dS)aW This is the same as :class:`torch.optim.Optimizer` :meth:`load_state_dict`, but also restores model averager's step value to the one saved in the provided ``state_dict``. If there is no ``"step"`` entry in ``state_dict``, it will raise a warning and initialize the model averager's step to 0. rz]Loaded state dict does not contain a step counter for an averager. Setting step counter to 0.rN)rload_state_dictrrwarningswarn)rrrrr rPs z%PostLocalSGDOptimizer.load_state_dictcCs|j|jj|jddS)zI Performs a single optimization step (parameter update). )paramsN)rrrZaverage_parametersrr rrr rcs zPostLocalSGDOptimizer.stepT set_to_nonecCs|jj|ddS)Nr)r zero_grad)rrrrr rjszPostLocalSGDOptimizer.zero_gradcCs|j|dSr)radd_param_group)rZ param_grouprrr rmsz%PostLocalSGDOptimizer.add_param_groupN)T)__name__ __module__ __qualname____doc__torchr Optimizer averagersZ ModelAveragerr propertyr r rrrboolrrrrrr rs1  r) rrZ6torch.distributed.algorithms.model_averaging.averagers distributedZ algorithmsZmodel_averagingrrrrrrrr s