a 8Sicn6@sddlZddlZddlmZddlmZmZmZddlm Z m Z ddl Z ddl Z ddl Z ddlZddlZddlmZddlZddlmZddlmZmZddlmZmZmZddlmZmZd Z e!rdd l"m#Z#m$Z$m%Z%dd l&m'Z'm(Z(ejj)!r d Z dd l*m+Z+ddl,m-Z-ddl.m/Z/ddl0m1Z1ddl2m3Z3m4Z4m5Z5e 6e7Z8ddZ9ddZ:ddZ;ddZGd d!d!eZ?Gd"d#d#eZ@Gd$d%d%e/eZAdS)&N) dataclass)CallableAnyType)Enumauto)contextmanager)FunctionVariable)JoinJoinableJoinHook) tree_flattentree_unflattenF)$_verify_param_shape_across_processes_sync_module_states _to_kwargs)ReduceOp_get_default_groupT)RRef_get_device_index)Module)#_ddp_with_replicated_tensor_enabled)gather is_namedtuplescatter_kwargscCs:to t|t}|r$t|\}}n t|\}}|||fSN) RPC_AVAILABLE isinstancerr local_value)outputoutput_is_rrefoutput_tensor_listtreespecr'Y/var/www/html/django/DPS/env/lib/python3.9/site-packages/torch/nn/parallel/distributed.py_tree_flatten_with_rref-s  r)cCst||}|rt|}|Sr)rr)r#r&r$r'r'r(_tree_unflatten_with_rref8s r*cCsttr"t|tr"|r"t|St|tjr4|gSt|tt frRt j t t|St|t rpt j t t|SgS)zI Recursively find all tensors contained in the specified object. )r r!ris_owner _find_tensorsr"torchTensorlisttuple itertoolschainmapdictvalues)objr'r'r(r,?s   r,cCsJgd}d}|D],}|tjvr(tj|nd}|d||f7}qt|dS)N)/RANKZ LOCAL_RANK WORLD_SIZE MASTER_PORT MASTER_ADDRZCUDA_VISIBLE_DEVICESZGLOO_SOCKET_IFNAMEZGLOO_DEVICE_TRANSPORTZNCCL_SOCKET_IFNAMEZNCCL_BLOCKING_WAITZ NCCL_DEBUGZNCCL_DEBUG_SUBSYSZNCCL_IB_DISABLEZNCCL_P2P_DISABLEZNCCL_P2P_LEVELZNCCL_SHM_DISABLEZNCCL_SOCKET_NTHREADSZNCCL_NSOCKS_PERTHREADZ NCCL_BUFFSIZEZ NCCL_NTHREADSZ NCCL_RINGSZNCCL_MAX_NCHANNELSZNCCL_MIN_NCHANNELSZNCCL_CHECKS_DISABLEZNCCL_CHECK_POINTERSZNCCL_LAUNCH_MODEZ NCCL_IB_HCAZNCCL_IB_TIMEOUTZNCCL_IB_RETRY_CNTZNCCL_IB_GID_INDEXZ NCCL_IB_SLZ NCCL_IB_TCZNCCL_IB_AR_THRESHOLDZNCCL_IB_CUDA_SUPPORTZNCCL_NET_GDR_LEVELZNCCL_NET_GDR_READZNCCL_SINGLE_RING_THRESHOLDZNCCL_LL_THRESHOLDZNCCL_TREE_THRESHOLDZ NCCL_ALGOZ NCCL_PROTOZNCCL_IGNORE_CPU_AFFINITYZNCCL_DEBUG_FILEZNCCL_COLLNET_ENABLEZNCCL_TOPO_FILEZNCCL_TOPO_DUMP_FILEZNCCL_ASYNC_ERROR_HANDLINGzN/Az env:%s=%s )osenvironprint)Zrelevant_env_varsZformatted_outputvarvaluer'r'r(_dump_DDP_relevant_env_varsRs 2rAc@seZdZeZeZdS)_BufferCommHookLocationN)__name__ __module__ __qualname__r PRE_FORWARD POST_FORWARDr'r'r'r(rBsrBc@s&eZdZUeed<eed<eed<dS)_BufferCommHookbuffer_comm_hookbuffer_comm_hook_statebuffer_comm_hook_locationN)rCrDrEr__annotations__rrBr'r'r'r(rHs rHc@s$eZdZeddZeddZdS)_DDPSinkcGs,|d||_||_tdd|D}|S)NFcss&|]}t|tjr|n|VqdSr)r!r-r.clone).0inpr'r'r( s z#_DDPSink.forward..)set_materialize_gradsreducer state_dictr0)ctxrSrTinputsretr'r'r(forwards z_DDPSink.forwardcGs<|j}|jdr.|jddkr.tj|jjddg|RS)N static_graphnum_iterationsr)rTr _execution_enginequeue_callbackrS_delay_all_reduce)rU grad_outputsrTr'r'r(backwardsz_DDPSink.backwardN)rCrDrE staticmethodrXr_r'r'r'r(rMs rMcs2eZdZfddZddZedddZZS) _DDPJoinHookcs8t|tsJd|j||_||j_tdS)z; Sets config variables for internal usage. zQDDP join hook requires passing in a DistributedDataParallel instance as the stateN)r!DistributedDataParallellogger_set_uneven_input_joinddp_divide_by_initial_world_sizesuper__init__)selfredivide_by_initial_world_size __class__r'r(rhs  z_DDPJoinHook.__init__cCsr|j}|j||jdd}||ddk}||_|sNdS| |j rd| |j dS)zq Shadows the DDP collective communication operations in the forward and backward passes. Tis_joined_rankrN) rerS_rebuild_buckets_check_and_sync_module_buffers)_check_global_requires_backward_grad_syncwaitresultitemrequire_forward_param_sync_match_all_reduce_for_bwd_passfind_unused_parameters_match_unused_params_allreduce_push_all_rebuilt_params)rireworkZshould_sync_backwardsr'r'r( main_hooks  z_DDPJoinHook.main_hook)is_last_joinercCs|j|dS)zj Syncs the final model to ensure that the model is the same across all processes. N)re_sync_final_modelrir|r'r'r( post_hooksz_DDPJoinHook.post_hook)rCrDrErhr{boolr __classcell__r'r'rkr(ras %rac seZdZdZdhfdd Zd d Zd d Zd dZddZfddZ ddZ ddZ ddZ diddZ ddZeddZdd Zd!d"Zd#d$Zd%d&Zd'd(Zdjfd)d* Zd+d,Zd-d.Zd/d0Zd1d2Zd3d4Zdkeeed5d6d7Zd8d9Zed:d;Z edd?d@Z%e&e$dAdBdCZ'dDdEZ(ddFe)dGdHdIZ*dldJdKZ+dLdMZ,dNdOZ-dPdQZ.dRdSZ/dTdUZ0dVdWZ1dmdXdYZ2dZd[Z3d\d]Z4ed^d_Z5e6d`daZ7dbdcZ8dddeZ9dfdgZ:Z;S)nrba=Implements distributed data parallelism that is based on ``torch.distributed`` package at the module level. This container parallelizes the application of the given module by splitting the input across the specified devices by chunking in the batch dimension. The module is replicated on each machine and each device, and each such replica handles a portion of the input. During the backwards pass, gradients from each node are averaged. The batch size should be larger than the number of GPUs used locally. See also: :ref:`distributed-basics` and :ref:`cuda-nn-ddp-instead`. The same constraints on input as in :class:`torch.nn.DataParallel` apply. Creation of this class requires that ``torch.distributed`` to be already initialized, by calling :func:`torch.distributed.init_process_group`. ``DistributedDataParallel`` is proven to be significantly faster than :class:`torch.nn.DataParallel` for single-node multi-GPU data parallel training. To use ``DistributedDataParallel`` on a host with N GPUs, you should spawn up ``N`` processes, ensuring that each process exclusively works on a single GPU from 0 to N-1. This can be done by either setting ``CUDA_VISIBLE_DEVICES`` for every process or by calling: >>> torch.cuda.set_device(i) where i is from 0 to N-1. In each process, you should refer the following to construct this module: >>> torch.distributed.init_process_group( >>> backend='nccl', world_size=N, init_method='...' >>> ) >>> model = DistributedDataParallel(model, device_ids=[i], output_device=i) In order to spawn up multiple processes per node, you can use either ``torch.distributed.launch`` or ``torch.multiprocessing.spawn``. .. note:: Please refer to `PyTorch Distributed Overview `__ for a brief introduction to all features related to distributed training. .. note:: ``DistributedDataParallel`` can be used in conjunction with :class:`torch.distributed.optim.ZeroRedundancyOptimizer` to reduce per-rank optimizer states memory footprint. Please refer to `ZeroRedundancyOptimizer recipe `__ for more details. .. note:: ``nccl`` backend is currently the fastest and highly recommended backend when using GPUs. This applies to both single-node and multi-node distributed training. .. note:: This module also supports mixed-precision distributed training. This means that your model can have different types of parameters such as mixed types of ``fp16`` and ``fp32``, the gradient reduction on these mixed types of parameters will just work fine. .. note:: If you use ``torch.save`` on one process to checkpoint the module, and ``torch.load`` on some other processes to recover it, make sure that ``map_location`` is configured properly for every process. Without ``map_location``, ``torch.load`` would recover the module to devices where the module was saved from. .. note:: When a model is trained on ``M`` nodes with ``batch=N``, the gradient will be ``M`` times smaller when compared to the same model trained on a single node with ``batch=M*N`` if the loss is summed (NOT averaged as usual) across instances in a batch (because the gradients between different nodes are averaged). You should take this into consideration when you want to obtain a mathematically equivalent training process compared to the local training counterpart. But in most cases, you can just treat a DistributedDataParallel wrapped model, a DataParallel wrapped model and an ordinary model on a single GPU as the same (E.g. using the same learning rate for equivalent batch size). .. note:: Parameters are never broadcast between processes. The module performs an all-reduce step on gradients and assumes that they will be modified by the optimizer in all processes in the same way. Buffers (e.g. BatchNorm stats) are broadcast from the module in process of rank 0, to all other replicas in the system in every iteration. .. note:: If you are using DistributedDataParallel in conjunction with the :ref:`distributed-rpc-framework`, you should always use :meth:`torch.distributed.autograd.backward` to compute gradients and :class:`torch.distributed.optim.DistributedOptimizer` for optimizing parameters. .. note:: DistributedDataParallel currently offers limited support for gradient checkpointing with :meth:`torch.utils.checkpoint`. DDP will work as expected when there are no unused parameters in the model and each layer is checkpointed at most once (make sure you are not passing `find_unused_parameters=True` to DDP). We currently do not support the case where a layer is checkpointed multiple times, or when there unused parameters in the checkpointed model. Example:: >>> import torch.distributed.autograd as dist_autograd >>> from torch.nn.parallel import DistributedDataParallel as DDP >>> import torch >>> from torch import optim >>> from torch.distributed.optim import DistributedOptimizer >>> import torch.distributed.rpc as rpc >>> from torch.distributed.rpc import RRef >>> >>> t1 = torch.rand((3, 3), requires_grad=True) >>> t2 = torch.rand((3, 3), requires_grad=True) >>> rref = rpc.remote("worker1", torch.add, args=(t1, t2)) >>> ddp_model = DDP(my_model) >>> >>> # Setup optimizer >>> optimizer_params = [rref] >>> for param in ddp_model.parameters(): >>> optimizer_params.append(RRef(param)) >>> >>> dist_optim = DistributedOptimizer( >>> optim.SGD, >>> optimizer_params, >>> lr=0.05, >>> ) >>> >>> with dist_autograd.context() as context_id: >>> pred = ddp_model(rref.to_here()) >>> loss = loss_func(pred, target) >>> dist_autograd.backward(context_id, [loss]) >>> dist_optim.step(context_id) .. note:: To let a non-DDP model load a state dict from a DDP model, :meth:`~torch.nn.modules.utils.consume_prefix_in_state_dict_if_present` needs to be applied to strip the prefix "module." in the DDP state dict before loading. .. warning:: Constructor, forward method, and differentiation of the output (or a function of the output of this module) are distributed synchronization points. Take that into account in case different processes might be executing different code. .. warning:: This module assumes all parameters are registered in the model by the time it is created. No parameters should be added nor removed later. Same applies to buffers. .. warning:: This module assumes all parameters are registered in the model of each distributed processes are in the same order. The module itself will conduct gradient ``allreduce`` following the reverse order of the registered parameters of the model. In other words, it is users' responsibility to ensure that each distributed process has the exact same model and thus the exact same parameter registration order. .. warning:: This module allows parameters with non-rowmajor-contiguous strides. For example, your model may contain some parameters whose :class:`torch.memory_format` is ``torch.contiguous_format`` and others whose format is ``torch.channels_last``. However, corresponding parameters in different processes must have the same strides. .. warning:: This module doesn't work with :func:`torch.autograd.grad` (i.e. it will only work if gradients are to be accumulated in ``.grad`` attributes of parameters). .. warning:: If you plan on using this module with a ``nccl`` backend or a ``gloo`` backend (that uses Infiniband), together with a DataLoader that uses multiple workers, please change the multiprocessing start method to ``forkserver`` (Python 3 only) or ``spawn``. Unfortunately Gloo (that uses Infiniband) and NCCL2 are not fork safe, and you will likely experience deadlocks if you don't change this setting. .. warning:: You should never try to change your model's parameters after wrapping up your model with ``DistributedDataParallel``. Because, when wrapping up your model with ``DistributedDataParallel``, the constructor of ``DistributedDataParallel`` will register the additional gradient reduction functions on all the parameters of the model itself at the time of construction. If you change the model's parameters afterwards, gradient redunction functions no longer match the correct set of parameters. .. warning:: Using ``DistributedDataParallel`` in conjunction with the :ref:`distributed-rpc-framework` is experimental and subject to change. Args: module (Module): module to be parallelized device_ids (list of int or torch.device): CUDA devices. 1) For single-device modules, ``device_ids`` can contain exactly one device id, which represents the only CUDA device where the input module corresponding to this process resides. Alternatively, ``device_ids`` can also be ``None``. 2) For multi-device modules and CPU modules, ``device_ids`` must be ``None``. When ``device_ids`` is ``None`` for both cases, both the input data for the forward pass and the actual module must be placed on the correct device. (default: ``None``) output_device (int or torch.device): Device location of output for single-device CUDA modules. For multi-device modules and CPU modules, it must be ``None``, and the module itself dictates the output location. (default: ``device_ids[0]`` for single-device modules) broadcast_buffers (bool): Flag that enables syncing (broadcasting) buffers of the module at beginning of the ``forward`` function. (default: ``True``) process_group: The process group to be used for distributed data all-reduction. If ``None``, the default process group, which is created by :func:`torch.distributed.init_process_group`, will be used. (default: ``None``) bucket_cap_mb: ``DistributedDataParallel`` will bucket parameters into multiple buckets so that gradient reduction of each bucket can potentially overlap with backward computation. :attr:`bucket_cap_mb` controls the bucket size in MegaBytes (MB). (default: 25) find_unused_parameters (bool): Traverse the autograd graph from all tensors contained in the return value of the wrapped module's ``forward`` function. Parameters that don't receive gradients as part of this graph are preemptively marked as being ready to be reduced. In addition, parameters that may have been used in the wrapped module's ``forward`` function but were not part of loss computation and thus would also not receive gradients are preemptively marked as ready to be reduced. (default: ``False``) check_reduction: This argument is deprecated. gradient_as_bucket_view (bool): When set to ``True``, gradients will be views pointing to different offsets of ``allreduce`` communication buckets. This can reduce peak memory usage, where the saved memory size will be equal to the total gradients size. Moreover, it avoids the overhead of copying between gradients and ``allreduce`` communication buckets. When gradients are views, ``detach_()`` cannot be called on the gradients. If hitting such errors, please fix it by referring to the :meth:`~torch.optim.Optimizer.zero_grad` function in ``torch/optim/optimizer.py`` as a solution. Note that gradients will be views after first iteration, so the peak memory saving should be checked after first iteration. static_graph (bool): When set to ``True``, DDP knows the trained graph is static. Static graph means 1) The set of used and unused parameters will not change during the whole training loop; in this case, it does not matter whether users set ``find_unused_parameters = True`` or not. 2) How the graph is trained will not change during the whole training loop (meaning there is no control flow depending on iterations). When static_graph is set to be ``True``, DDP will support cases that can not be supported in the past: 1) Reentrant backwards. 2) Activation checkpointing multiple times. 3) Activation checkpointing when model has unused parameters. 4) There are model parameters that are outside of forward function. 5) Potentially improve performance when there are unused parameters, as DDP will not search graph in each iteraton to detect unused parameters when static_graph is set to be ``True``. To check whether you can set static_graph to be ``True``, one way is to check ddp logging data at the end of your previous model training, if ``ddp_logging_data.get("can_set_static_graph") == True``, mostly you can set ``static_graph = True`` as well. Example:: >>> model_DDP = torch.nn.parallel.DistributedDataParallel(model) >>> # Training loop >>> ..... >>> ddp_logging_data = model_DDP._get_ddp_logging_data() >>> static_graph = ddp_logging_data.get("can_set_static_graph") Attributes: module (Module): the module to be parallelized. Example:: >>> torch.distributed.init_process_group(backend='nccl', world_size=4, init_method='...') >>> net = torch.nn.parallel.DistributedDataParallel(model, pg) NrTFc  stt|t|d|_tdd|Ds@|td|dur`t |dkr`|t dt dd|Ddk|_ dd|D} t | dkr|t d | t | d |_|dust |d ks|jd ks|j r|s|r|t d ||d d|Dd|_d|_n.dd|D|_|dur>|d }t|d|_|dur^t|_n||_d|_||_||_t |jd j|_||_||_d|_d|_| |_t|dr|j|_ng|_t |_!|"| rt#$d|D]$} t%| t&j'j(j)r|tdqt*d|_+t*|dd|_,t-j./dddk|_0|1\}}t2|j|t3|j|j|j+d |jd|4|}|5|||| d|_6| r|7dS)Ncss|] }|jVqdSr) requires_gradrOpr'r'r(rQz3DistributedDataParallel.__init__..zhDistributedDataParallel is not needed when a module doesn't have any parameter that requires a gradient.rz8device_ids can only be None or contain a single element.cSsh|] }|jqSr'devicerr'r'r( )rz3DistributedDataParallel.__init__..cSsh|] }|jjqSr')rtyperr'r'r(r*rzuDistributedDataParallel's input module must be on the same type of devices, but input module parameters locate in {}.rcpuzDistributedDataParallel device_ids and output_device arguments only work with single-device/multiple-device GPU modules or CPU modules, but got device_ids {}, output_device {}, and module parameters {}.cSsh|] }|jqSr'rrr'r'r(rDrcSsg|]}t|dqS)Tr)rOxr'r'r( Krz4DistributedDataParallel.__init__..TF!_ddp_params_and_buffers_to_ignorezhThe `check_reduction` argument in `DistributedDataParallel` module is deprecated. Please avoid using it.zModules with uninitialized parameters can't be used with `DistributedDataParallel`. Run a dummy forward pass to correctly initialize the modulesiiZPYTORCH_DDP_USE_SIDE_STREAM1module process_groupbroadcast_bucket_sizesrcparams_and_buffers_to_ignore)8rgrbrhr rcany parameters_log_and_throw RuntimeErrorlen ValueErrorZis_multi_device_moduleformatr/ device_type device_ids output_devicerrrrYdimrrbroadcast_buffersrwrequire_backward_grad_syncrugradient_as_bucket_viewhasattrrparameters_to_ignorer_use_replicated_tensor_module_build_replicated_tensor_modulewarningswarnr!r-nn parameterUninitializedParameterintrbucket_bytes_capr<r=get!use_side_stream_for_tensor_copies_build_params_for_reducerrr"_build_debug_param_to_name_mapping_ddp_init_helper_has_rebuilt_buckets_set_static_graph)rirrrrrrZ bucket_cap_mbrwZcheck_reductionrrYZdistinct_device_typesparamrexpect_sparse_gradientparam_to_name_mappingrkr'r(rh s                z DistributedDataParallel.__init__cCs*|jr&ddlm}||j|j|jd<dS)Nr)_replicate_module_replicated_tensor_module)rZ_replicated_tensor_ddp_interoprrr__dict__)rirr'r'r(rs z7DistributedDataParallel._build_replicated_tensor_modulecCs0|jdur$|jt|d|||dS)Nz: )rcset_error_and_logstr)riZerr_typeerr_msgr'r'r(rs z&DistributedDataParallel._log_and_throwc Cs d|_|dus|jdur"tjg}n tj|jg}t|||\}}t|t t |t t ||j ||j|j|j |tj |_ t|j |_|j |jd}|jD]} t| tjjrd}qq|j|jjj|jdurgn|j|jdurdn|j|j||||jdS)aA Initialization helper function that does the following: (1) bucketing the parameters for reductions (2) resetting the bucketing states (3) registering the grad hooks (4) Logging construction-time DDP logging data (5) passing a handle of DDP to SyncBatchNorm Layer rTFN)rZrwsysmaxsizedist_DEFAULT_FIRST_BUCKET_BYTESr"_compute_bucket_assignment_by_sizeReducerr/reversedrrrSLoggerrc set_loggerrmodulesr!r-r SyncBatchNormset_construction_data_and_logrlrCrrr_passing_sync_batchnorm_handle) rirrrrYZbucket_size_limitsZbucket_indicesZper_bucket_size_limitsZ has_sync_bnZ submoduler'r'r(rsJ       z(DistributedDataParallel._ddp_init_helpercCs6|t|j}|d=|d=|d=|jr2|d=|S)NrrSrcr)_check_default_groupcopyrr)riattrsr'r'r( __getstate__s z$DistributedDataParallel.__getstate__cst|_tt||||jdd|jdd|\}}| |}| ||||j |j r~|j |j dS)NruTr)rrrgrb __setstate__rr setdefaultrrrrYrSrrc)ristaterrrrkr'r(r s    z$DistributedDataParallel.__setstate__cspfddjD}tfdd|D}tdd|D}ddtfdd|D}||fS) Ncs:g|]2\}fdd|jddDD] }||fq(qS)cs.g|]&\}}|jrd|jvr|qS).)rr)rO param_namer) module_namerir'r(r!szPDistributedDataParallel._build_params_for_reducer...Frecurse)named_parameters)rOrrri)rr(rs   zEDistributedDataParallel._build_params_for_reducer..cs*g|]"\}}|vr|s||fqSr')add)rOmr)memor'r(r/scss|]\}}|VqdSrr')rO_rr'r'r(rQ7rzDDistributedDataParallel._build_params_for_reducer..cSs&t|tjjst|tjjr"|jSdSNF)r!r-r Embedding EmbeddingBagsparse)rr'r'r(produces_sparse_gradient:s zSDistributedDataParallel._build_params_for_reducer..produces_sparse_gradientc3s|]\}}|VqdSrr')rOrr)rr'r(rQCr)r named_modulessetr/_assign_modules_buffers)riZmodules_and_parametersrrr')rrrir(rs   z1DistributedDataParallel._build_params_for_reducercs<fddjD}dd|D_dd|D_dS)aU Assigns module buffers to self.modules_buffers which are then used to broadcast across ranks when broadcast_buffers=True. Note that this must be called every time buffers need to be synced because buffers can be reassigned by user module, see https://github.com/pytorch/pytorch/issues/63916. cs"g|]\}}|jvr||fqSr')r)rO buffer_namebufferrr'r(rRs zCDistributedDataParallel._assign_modules_buffers..cSsg|] \}}|qSr'r'rOrrr'r'r(rWscSsi|]\}}||qSr'r'rr'r'r( \szCDistributedDataParallel._assign_modules_buffers..N)r named_buffersmodules_buffersnamed_module_buffers)rirr'rr(rIs z/DistributedDataParallel._assign_modules_buffersc sttjjkriSfddttD}t}i}|jD]h\}}|j ddD]R\}}|d|} | |j vrX|j rX||vr| t d| d||} | || <qXqDt|t|kr| t dt|d t|d |S) Ncsi|]}||qSr'r')rOirr'r(rdrzNDistributedDataParallel._build_debug_param_to_name_mapping..FrrzParam with name zt found in module parameters, but not DDP parameters. This indicates a bug in DDP, please report an issue to PyTorch.zUExpected param to name mapping to cover all parameters, but got conflicting lengths: z vs zA. This indicates a bug in DDP, please report an issue to PyTorch.)rget_debug_level DebugLevelOFFrangerrrrrrrrr) rirZparam_to_param_indexZ param_setZparam_index_to_param_fqnrrrrZfqnZ param_indexr'rr(r`s4   z:DistributedDataParallel._build_debug_param_to_name_mappingccs8dd}|r|n|gD]}||D] }|Vq&qdS)z: Returns a generator of module parameters css4t|dr|jn |jdd}|D] }|Vq$dS)N_former_parametersFr)rrr5r)rZpsrr'r'r(model_parameterss   zADistributedDataParallel._get_parameters..model_parametersN)r)rirrrrr'r'r(_get_parameterss  z'DistributedDataParallel._get_parameterscCsDd}z|jtkrd}Wnty.d}Yn0|r@|tddS)NFTzDDP Pickling/Unpickling are only supported when using DDP with the default process group. That is, when you have called init_process_group and have not passed process_group argument to DDP constructor)rrrr)riZpickle_not_supportedr'r'r(rs   z,DistributedDataParallel._check_default_groupccs*|j}d|_zdVW||_n||_0dS)aV A context manager to disable gradient synchronizations across DDP processes. Within this context, gradients will be accumulated on module variables, which will later be synchronized in the first forward-backward pass exiting the context. Example:: >>> ddp = torch.nn.parallel.DistributedDataParallel(model, pg) >>> with ddp.no_sync(): >>> for input in inputs: >>> ddp(input).backward() # no synchronization, accumulate grads >>> ddp(another_input).backward() # synchronize grads FN)r)riZold_require_backward_grad_syncr'r'r(no_syncs zDistributedDataParallel.no_synccOsZ|jr |jn|j}|jrHt|||jd|j\}}||di|dS||i|SdSNr)rrrrrr)rirVkwargsZ module_to_runr'r'r(_run_ddp_forwardsz(DistributedDataParallel._run_ddp_forwardc Os tjjd trB|jrB|j|jd7_|j t |}|r`|j ||jtr|j rtdd|_t|d}|r||jjr|jdd|j|i|}|r|tr|jrd|_|jr|js|j tt|n |j gnd|_Wdn1s80Y|jrR|jrf|jr|jdkr|j|jd}t |\}}} d d t!t"|D} t#|D]*\} }t$|r|j%dur|| | <qt&j'|j |g|R} t!t"| D] } | | dur| | | | <qt(| || }|S) NDistributedDataParallel.forwardrz4Reducer buckets have been rebuilt in this iteration.T buffer_hookFrm)rYrZcSsg|]}dqSrr')rOrr'r'r(rrz3DistributedDataParallel.forward..))r-autogradprofilerrecord_functionis_grad_enabledrrcset_runtime_stats_and_logrZrSprepare_for_forwardr Znotify_join_context_set_forward_pass_work_handlerfroinforr_check_sync_bufs_pre_fwd _sync_buffers _join_configenablerqr_check_sync_bufs_post_fwdrurwrYprepare_for_backwardr/r,r)rr enumerate is_tensorgrad_fnrMapplyr*) rirVrrzZbuffer_hook_registeredr#rTr%r&r$Zoutput_placeholdersrZpassthrough_tensor_listr'r'r(rXsn       &  rcCst||||jdSN)r)rr)rirVrrr'r'r(scatter.szDistributedDataParallel.scattercCst||||jSr)rr)rirVrZ device_idr'r'r( to_kwargs1s z!DistributedDataParallel.to_kwargscCst|||jdSr)rr)rioutputsrr'r'r(r7szDistributedDataParallel.gathercs&tt|||jr"|j||Sr)rgrbtrainrr)rimoderkr'r(r:s zDistributedDataParallel.traincCsB|s|jrtjd|jd}ntjd|jd}tj||jdd}|S)NrrT)groupasync_op)rr-onesrzerosr all_reducer)rirnZrequires_sync_tensorrzr'r'r(rqBs zADistributedDataParallel._check_global_requires_backward_grad_synccCs$|r ||jd}||dSr)r_find_common_rank_distributed_rank_sync_module_buffersriauthoritative_rankr'r'r(rpOsz6DistributedDataParallel._check_and_sync_module_bufferscCs0||j||_t|j|j|j|j|jddS)Nr)rrZ_authoritative_rankrrrrrr~r'r'r(r}Vsz)DistributedDataParallel._sync_final_modelcCsDg}|j}|D]}|j|}||q|D] }|q2dSr)rS_get_zeros_like_grad_buckets_run_comm_hookappendrr)riZ comm_workZ grad_bucketsZ grad_bucketrzr'r'r(rvgs   z6DistributedDataParallel._match_all_reduce_for_bwd_passcCs|j}|j|dSr)rS_get_local_used_mapr allreduce)riZlocally_used_param_mapr'r'r(rx|s z6DistributedDataParallel._match_unused_params_allreduce)rjrthrow_on_early_terminationcCst|g|||dS)a1 A context manager to be used in conjunction with an instance of :class:`torch.nn.parallel.DistributedDataParallel` to be able to train with uneven inputs across participating processes. This context manager will keep track of already-joined DDP processes, and "shadow" the forward and backward passes by inserting collective communication operations to match with the ones created by non-joined DDP processes. This will ensure each collective call has a corresponding call by already-joined DDP processes, preventing hangs or errors that would otherwise happen when training with uneven inputs across processes. Alternatively, if the flag ``throw_on_early_termination`` is specified to be ``True``, all trainers will throw an error once one rank runs out of inputs, allowing these errors to be caught and handled according to application logic. Once all DDP processes have joined, the context manager will broadcast the model corresponding to the last joined process to all processes to ensure the model is the same across all processes (which is guaranteed by DDP). To use this to enable training with uneven inputs across processes, simply wrap this context manager around your training loop. No further modifications to the model or data loading is required. .. warning:: If the model or training loop this context manager is wrapped around has additional distributed collective operations, such as ``SyncBatchNorm`` in the model's forward pass, then the flag ``throw_on_early_termination`` must be enabled. This is because this context manager is not aware of non-DDP collective communication. This flag will cause all ranks to throw when any one rank exhausts inputs, allowing these errors to be caught and recovered from across all ranks. Args: divide_by_initial_world_size (bool): If ``True``, will divide gradients by the initial ``world_size`` DDP training was launched with. If ``False``, will compute the effective world size (number of ranks that have not depleted their inputs yet) and divide gradients by that during allreduce. Set ``divide_by_initial_world_size=True`` to ensure every input sample including the uneven inputs have equal weight in terms of how much they contribute to the global gradient. This is achieved by always dividing the gradient by the initial ``world_size`` even when we encounter uneven inputs. If you set this to ``False``, we divide the gradient by the remaining number of nodes. This ensures parity with training on a smaller ``world_size`` although it also means the uneven inputs would contribute more towards the global gradient. Typically, you would want to set this to ``True`` for cases where the last few inputs of your training job are uneven. In extreme cases, where there is a large discrepancy in the number of inputs, setting this to ``False`` might provide better results. enable (bool): Whether to enable uneven input detection or not. Pass in ``enable=False`` to disable in cases where you know that inputs are even across participating processes. Default is ``True``. throw_on_early_termination (bool): Whether to throw an error or continue training when at least one rank has exhausted inputs. If ``True``, will throw upon the first rank reaching end of data. If ``False``, will continue training with a smaller effective world size until all ranks are joined. Note that if this flag is specified, then the flag ``divide_by_initial_world_size`` would be ignored. Default is ``False``. Example:: >>> import torch >>> import torch.distributed as dist >>> import os >>> import torch.multiprocessing as mp >>> import torch.nn as nn >>> # On each spawned worker >>> def worker(rank): >>> dist.init_process_group("nccl", rank=rank, world_size=2) >>> torch.cuda.set_device(rank) >>> model = nn.Linear(1, 1, bias=False).to(rank) >>> model = torch.nn.parallel.DistributedDataParallel( >>> model, device_ids=[rank], output_device=rank >>> ) >>> # Rank 1 gets one more input than rank 0. >>> inputs = [torch.tensor([1]).float() for _ in range(10 + rank)] >>> with model.join(): >>> for _ in range(5): >>> for inp in inputs: >>> loss = model(inp).sum() >>> loss.backward() >>> # Without the join() API, the below synchronization will hang >>> # blocking for rank 1's allreduce to complete. >>> torch.cuda.synchronize(device=rank) rj)r )rirjrr$r'r'r(joins dzDistributedDataParallel.joincKs|dd}t||dS)a Returns the DDP join hook, which enables training on uneven inputs by shadowing the collective communications in the forward and backward passes. Arguments: kwargs (dict): a :class:`dict` containing any keyword arguments to modify the behavior of the join hook at run time; all :class:`Joinable` instances sharing the same join context manager are forwarded the same value for ``kwargs``. The hook supports the following keyword arguments: divide_by_initial_world_size (bool, optional): If ``True``, then gradients are divided by the initial world size that DDP was launched with. If ``False``, then gradients are divided by the effective world size (i.e. the number of non-joined processes), meaning that the uneven inputs contribute more toward the global gradient. Typically, this should be set to ``True`` if the degree of unevenness is small but can be set to ``False`` in extreme cases for possibly better results. Default is ``True``. rjTr%)rra)rirrjr'r'r( join_hooks z!DistributedDataParallel.join_hookcCs|jSrrrr'r'r( join_device sz#DistributedDataParallel.join_devicecCs|jSr)rrr'r'r(join_process_groupsz*DistributedDataParallel.join_process_group)hookcCs t|s Jt|||d|_dS)a Allows custom registration of hooks that define how buffer are synchronized across ranks. The hook takes in an optional state and is passed in a Dict[str, Tensor] corresponding to buffer names and the buffers, and can run arbitrary reductions on buffers as opposed to DDP's default broadcast from rank 0. This is useful for example if a counter needs to be summed or averaged across ranks every iteration. Args: state (Any): Optional state that is passed to the hook. hook (Callable): Callable with the following signature: ``hook(state: object, buffers: Dict[str, torch.Tensor]) -> Optional[List[torch.futures.Future[torch.Tensor]]]`` comm_hook_location (_BufferCommHookLocation): Enum value indicating where to run the hook. _BufferCommHookLocation.PRE_FORWARD means that the hook will run _before_ the forward pass, and _BufferCommHookLocation.POST_FORWARD means that the hook will run _after_ the forward pass. hook (callable): Callable with the following signature: ``hook(state: object, bucket: dist.GradBucket) -> torch.futures.Future[torch.Tensor]``: NOTE: To maximize performance, users can return a List[torch.futures.Future] from their hook, and DDP will install and await these hooks appropriately at the end of the backward pass. This will ensure all buffers are synchronized by the end of the backward pass. If this setting is used, it is recommended to pass comm_hook_location=_BufferCommHookLocation.POST_FORWARD, which will trigger the hook after the forward pass. If _BufferCommHookLocation.PRE_FORWARD is used, users must ensure appropriate synchronization when manipulating GPU buffers in the forward pass. )rIrJrKN)callablerHr)rirr*Zcomm_hook_locationr'r'r(_register_buffer_comm_hooks * z2DistributedDataParallel._register_buffer_comm_hook)rr*cCs,|||j|jt|j||dS)a Registers a communication hook which is an enhancement that provides a flexible hook to users where they can specify how DDP aggregates gradients across multiple workers. This hook would be very useful for researchers to try out new ideas. For example, this hook can be used to implement several algorithms like GossipGrad and gradient compression which involve different communication strategies for parameter syncs while running Distributed DataParallel training. Args: state (object): Passed to the hook to maintain any state information during the training process. Examples include error feedback in gradient compression, peers to communicate with next in GossipGrad, etc. It is locally stored by each worker and shared by all the gradient tensors on the worker. hook (callable): Callable with the following signature: ``hook(state: object, bucket: dist.GradBucket) -> torch.futures.Future[torch.Tensor]``: This function is called once the bucket is ready. The hook can perform whatever processing is needed and return a Future indicating completion of any async work (ex: allreduce). If the hook doesn't perform any communication, it still must return a completed Future. The Future should hold the new value of grad bucket's tensors. Once a bucket is ready, c10d reducer would call this hook and use the tensors returned by the Future and copy grads to individual parameters. Note that the future's return type must be a single tensor. We also provide an API called ``get_future`` to retrieve a Future associated with the completion of ``c10d.ProcessGroup.Work``. ``get_future`` is currently supported for NCCL and also supported for most operations on GLOO and MPI, except for peer to peer operations (send/recv). .. warning :: Grad bucket's tensors will not be predivided by world_size. User is responsible to divide by the world_size in case of operations like allreduce. .. warning :: DDP communication hook can only be registered once and should be registered before calling backward. .. warning :: The Future object that hook returns should contain a single tensor that has the same shape with the tensors inside grad bucket. .. warning :: ``get_future`` API supports NCCL, and partially GLOO and MPI backends (no support for peer-to-peer operations like send/recv) and will return a ``torch.futures.Future``. Example:: Below is an example of a noop hook that returns the same tensor. >>> def noop(state: object, bucket: dist.GradBucket): -> torch.futures.Future[torch.Tensor] >>> fut = torch.futures.Future() >>> fut.set_result(bucket.buffer()) >>> return fut >>> ddp.register_comm_hook(state=None, hook=noop) Example:: Below is an example of a Parallel SGD algorithm where gradients are encoded before allreduce, and then decoded after allreduce. >>> def encode_and_decode(state: object, bucket: dist.GradBucket): -> torch.futures.Future[torch.Tensor] >>> encoded_tensor = encode(bucket.buffer()) # encode gradients >>> fut = torch.distributed.all_reduce(encoded_tensor).get_future() >>> # Define the then callback to decode. >>> def decode(fut): >>> decoded_tensor = decode(fut.value()[0]) # decode gradients >>> return decoded_tensor >>> return fut.then(decode) >>> ddp.register_comm_hook(state=None, hook=encode_and_decode) N)_check_comm_hookrc_set_comm_hook_namerEr_register_comm_hookrS)rirr*r'r'r(register_comm_hookDsM z*DistributedDataParallel.register_comm_hookcCs"|jt|t|j|dS)a Registers a built-in communication hook that specifies how DDP aggregates gradients across multiple workers. The built-in hooks aim to provide efficient C++ implementations for certain hooks, which might not be as efficient if implemented in Python using a Python communication hook. Args: comm_hook_type (dist.BuiltinCommHookType): type of communication hook, such as ALLREDUCE, FP16_COMPRESS, etc. .. warning :: DDP communication hook can only be registered once and should be registered before calling backward. Example:: Below is an example of a FP16 compression where gradients are compressed into 16-bit floating-point numbers before allreduce, and then decompressed after allreduce. >>> ddp._register_builtin_comm_hook(dist.BuiltinCommHookType.FP16_COMPRESS) N)rcr.rr_register_builtin_comm_hookrS)riZcomm_hook_typer'r'r(r1sz3DistributedDataParallel._register_builtin_comm_hook) optim_params)optimcOs^ddlm}|||g|Ri|}z||Wn&tyXt|d|dYn0dS)a Registers an optimizer with DDP such that the optimization for a parameter will run immediately when that parameter's gradient is finished with reduction, instead of waiting for all parameters' gradients to finish reduction. This can result in a training speedup depending on your workload since the optimizer can run while gradient reduction for other parameters are still ongoing. In addition, this has the potential to reduce peak memory consumption during training, as it only needs to load the per-parameter optimizer states of a single parameter at a time, instead of loading all per-parameter optimizer states at once. Args: optim_cls (Type): a ``torch.optim.Optimizer`` class to be registered as a fused optimizer. *args (Sequence[Any]): Arguments to forward to `optim_cls`. optim_params (Optional[Iterable[torch.Tensor]]): Set of parameters to optimize, similar to `params` argument of traditional `torch.optim` Optimizers. If this is omitted, all DDP model parameters will be optimized. **kwargs: (Dict[str, Any]): Keyword arguments to forward to `optim_cls`. .. warning :: _register_fused_optim should only be called once on a DDP instance, and registering multiple fused optimizers for the same DDP model is not currently supported. Please ping https://github.com/pytorch/pytorch/issues/71595 if this is necessary for your use case. .. warning :: _register_fused_optim and register_comm_hook currently do not compose together, meaning that custom DDP communication hooks are not supported with overlapped optimizers. Please ping https://github.com/pytorch/pytorch/issues/71595 if this is necessary for your use case. .. warning :: Gradient accumulation and DDP `no_sync` are currently not supported with overlapped optimizer. Please ping https://github.com/pytorch/pytorch/issues/71595 if this is necessary for your use case. Example:: >>> torch.distributed.init_process_group(backend='nccl', world_size=4, init_method='...') >>> net = torch.nn.parallel.DistributedDataParallel(model, pg) >>> lr = 1e-2 >>> betas = (0.9, 0.99) >>> eps = 1e-6 >>> net._register_fused_optim(torch.optim.Adam, lr, betas=betas, eps=eps) >>> # Example with subset of parameters >>> params_to_opt = [list(net.parameters())[0]] >>> net._register_fused_optim( torch.optim.Adam, lr, optim_params=params_to_opt, betas=betas, eps=eps ) r)_as_overlapped_optimz] does not support overlapped DDP. Please file an issue to PyTorch or the respective owner of rN)Z/torch.distributed.algorithms._optimizer_overlapr4Z register_ddpNotImplementedErrorr)rir3r2argsrr4Zoverlapped_optimr'r'r(_register_fused_optims;  z-DistributedDataParallel._register_fused_optimcCst|j|||dSr)r_broadcast_coalescedr)ritensors buffer_sizerr'r'r( _distributed_broadcast_coalesceds z8DistributedDataParallel._distributed_broadcast_coalescedcCs |ot|do|jjtjkSNr)will_sync_module_buffersrrrKrBrGrr'r'r(r sz1DistributedDataParallel._check_sync_bufs_post_fwdcCs"|o t|d p |jjtjkSr<)r=rrrKrBrFrr'r'r(rs  z0DistributedDataParallel._check_sync_bufs_pre_fwdcCs|jo|jot|jdkSr)rurrrrr'r'r(r= s  z0DistributedDataParallel.will_sync_module_bufferscCsNtj|r |ndg|jd}tj|tj|jd|dkrF| t d|S)Nrr)oprzuBUG! Expected rank_cond to be true for at least one process. This indicates a bug in PyTorch, please report an issue.) r-tensorrrrrMAXrrtrr)riZ input_rankZ rank_condZ rank_to_user'r'r(rs  z)DistributedDataParallel._find_common_rankcCsZt>|jjr"||jd}nd}|||Wdn1sL0YdS)NTr)r-no_gradrrrrrrrr'r'r(r s z%DistributedDataParallel._sync_bufferscCsLt|ds|j|dn0|jj}|jj}|||j}|durH|j|dS)Nr)r)r_default_broadcast_coalescedrrIrJrrS_install_post_backward_futures)rirr*rZfutsr'r'r(r3s  z,DistributedDataParallel._sync_module_bufferscCs.|dur|j}|dur|j}||||dS)z Broadcasts buffers from rank 0 to rest of workers. If bufs, bucket_size are None, default values self.modules_buffers and self.broadcast_bucket_size are used instead. N)rrr;)riZbufsZ bucket_sizerr'r'r(rB=sz4DistributedDataParallel._default_broadcast_coalescedcCs8|D]*}t|tjjjr|jdkr|tdqdS)Nrz/SyncBatchNorm layers only work with GPU modules)rr!r-rrrrr)rirlayerr'r'r(rPs   z6DistributedDataParallel._passing_sync_batchnorm_handlecCst|s|tdt|}|jdjtjkrN|jdjtj krN|t d|j tjkrz|j t j jt jkrz|t d|jdvrt jjdustt jjdddkstrtrt jjd kr|td dS) Nz$Communication hook must be callable.bucketz@Communication hook: bucket annotation should be dist.GradBucket.zSCommunication hook: return annotation should be torch.futures.Future[torch.Tensor].)Zbf16_compress_hookZbf16_compress_wrapper_hookrr )r zDBF16 all reduce communication hook required CUDA 11+ and NCCL 2.10+.)r+r TypeErrorinspect signaturer annotation_emptyr GradBucketrreturn_annotationr-futuresFuturer.rCversioncudarsplit is_availableis_nccl_availablenccl)rir*sigr'r'r(r-Xs@     z(DistributedDataParallel._check_comm_hookcCs t|jSr)rget_rankrrr'r'r(r|sz)DistributedDataParallel._distributed_rankcCs ||_dS)a; Sets parameters and buffers to be ignored by DDP. Expected format for parameters is the fully qualified name: {module_name}.{param_name}, and similarly, {module_name}.{buffer_name} for buffers. For example: params_to_ignore = [] # NB: model here is vanilla PyTorch module, not yet wrapped with DDP. for module_name, module in model.named_modules(): for param_name, param in module.named_parameters(recurse=False): if should_ignore(param): # Create expected format fqn = f"{module_name}.{param_name}" params_to_ignore.append(fqn) torch.nn.parallel.DistributedDataParallel._set_params_and_buffers_to_ignore_for_model( model, params_to_ignore ) N)r)rrr'r'r(+_set_params_and_buffers_to_ignore_for_modelszCDistributedDataParallel._set_params_and_buffers_to_ignore_for_modelcCs|j}i|j|jS)a This interface can be called after DistributedDataParallel() is constructed. It returns a dictionary of logging data. It could help for debugging and analysis. The loggind data includes DistributedDataParallel constructor input parameters, some internal states of DistributedDataParallel and performance metrics. Simply print the dictorinary and see what these metrics are. This is a prototype interface and subject to change in the future. )rc_get_ddp_logging_datastrs_mapints_map)riZddp_logging_datar'r'r(rZs z-DistributedDataParallel._get_ddp_logging_datacCs$|dkr|td|j|dS)a. This interface allows users to set sample_rate of collecting runtime stats. The runtime stats will be recorded for the first 10 iterations, after 10 iteratons runtime stats will be recorded once every "sample_rate" training iterations. In default, runtime stats are recorded for the first 10 iterations, after 10 iterations runtime stats are recorded once every "kDDPRuntimeLoggingSampleRate=100" training iterations. This is a prototype interface and subject to change in the future. rzADDP runtime logging sample rate should be equal or greater than 1N)rrrS$_set_ddp_runtime_logging_sample_rate)riZ sample_rater'r'r(r]s ztddS)z It is recommended to set static graph in the DDP constructor, which will call this private API internally. zsJ         : :