o ZhJ4@sddlZddlmZmZddlmZddlmZmZm Z ddl Z ddl m Z gdZGdddZGdd d eZGd d d eZGd d d ZdS)N)ABCabstractmethod) TracebackType)Any NamedTupleOptional)JoinHookJoinableJoinc@s,eZdZdZd ddZdeddfddZdS) ra This defines a join hook, which provides two entry points in the join context manager. Entry points : a main hook, which is called repeatedly while there exists a non-joined process, and a post-hook, which is called once all processes have joined. To implement a join hook for the generic join context manager, define a class that inherits from :class:`JoinHook` and override ``main_hook()`` and ``post_hook()`` as appropriate. returnNcCdS)zCall this hook while there exists a non-joined process to shadow collective communications in a training iteration. Training iteration i.e., in one forward pass, backward pass, and optimizer step. Nselfr r P/var/www/auris/lib/python3.10/site-packages/torch/distributed/algorithms/join.py main_hookzJoinHook.main_hookis_last_joinercCr )aK Call hook after all processes have joined. It is passed an additional ``bool`` argument ``is_last_joiner``, which indicates if the rank is one of the last to join. Arguments: is_last_joiner (bool): ``True`` if the rank is one of the last to join; ``False`` otherwise. Nr )rrr r r post_hook rzJoinHook.post_hookr N)__name__ __module__ __qualname____doc__rboolrr r r rrs rcsfeZdZdZed fdd ZedefddZeede j fdd Z eede fd d Z ZS) r a_ This defines an abstract base class for joinable classes. A joinable class (inheriting from :class:`Joinable`) should implement :meth:`join_hook`, which returns a :class:`JoinHook` instance, in addition to :meth:`join_device` and :meth:`join_process_group` that return device and process group information, respectively. r Ncstt|_dSN)super__init__ _JoinConfigconstruct_disabled_join_config _join_configr __class__r rr7s zJoinable.__init__cKr )a Return a :class:`JoinHook` instance for the given :class:`Joinable`. 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``. Nr )rkwargsr r r join_hook<s zJoinable.join_hookcCr )zeReturn the device from which to perform collective communications needed by the join context manager.Nr rr r r join_deviceIzJoinable.join_devicecCr )zfReturns the process group for the collective communications needed by the join context manager itself.Nr rr r rjoin_process_groupOr&zJoinable.join_process_groupr)rrrrrrrr$propertytorchdevicer%rr' __classcell__r r r!rr ,s  r c@s6eZdZUdZeed<eed<eed<eddZdS)rzdThis includes all fields needed from a :class:`Joinable` instance for the join context manager side.enablethrow_on_early_terminationis_first_joinablecCstddddS)zReturn a :class:`_JoinConfig` instance indicating that join-related logic should be disabled. e.g. if the caller is not in a join context manager. Fr,r-r.)rr r r rr]sz*_JoinConfig.construct_disabled_join_configN)rrrrr__annotations__ staticmethodrr r r rrVs rc@seZdZdZ  ddeededefddZdd d Zdd dZ ddZ de e e de e de efddZddZddZedefddZd S)r a This class defines the generic join context manager, which allows custom hooks to be called after a process joins. These hooks should shadow the collective communications of non-joined processes to prevent hanging and erroring and to ensure algorithmic correctness. Refer to :class:`JoinHook` for details about the hook definition. .. warning:: The context manager requires each participating :class:`Joinable` to call the method :meth:`notify_join_context()` before its own per- iteration collective communications to ensure correctness. .. warning:: The context manager requires that all ``process_group`` attributes in the :class:`JoinHook` objects are the same. If there are multiple :class:`JoinHook` objects, then the ``device`` of the first is used. The process group and device information is used for checking for non- joined processes and for notifying processes to throw an exception if ``throw_on_early_termination`` is enabled, both of which using an all- reduce. Arguments: joinables (List[Joinable]): a list of the participating :class:`Joinable` s; their hooks are iterated over in the given order. enable (bool): a flag enabling uneven input detection; setting to ``False`` disables the context manager's functionality and should only be set when the user knows the inputs will not be uneven (default: ``True``). throw_on_early_termination (bool): a flag controlling whether to throw an exception upon detecting uneven inputs (default: ``False``). Example:: >>> import os >>> import torch >>> import torch.distributed as dist >>> import torch.multiprocessing as mp >>> # xdoctest: +SKIP >>> import torch.nn.parallel.DistributedDataParallel as DDP >>> import torch.distributed.optim.ZeroRedundancyOptimizer as ZeRO >>> from torch.distributed.algorithms.join import Join >>> >>> # On each spawned worker >>> def worker(rank): >>> dist.init_process_group("nccl", rank=rank, world_size=2) >>> model = DDP(torch.nn.Linear(1, 1).to(rank), device_ids=[rank]) >>> optim = ZeRO(model.parameters(), torch.optim.Adam, lr=0.01) >>> # Rank 1 gets one more input than rank 0 >>> inputs = [torch.tensor([1.]).to(rank) for _ in range(10 + rank)] >>> with Join([model, optim]): >>> for input in inputs: >>> loss = model(input).sum() >>> loss.backward() >>> optim.step() >>> # All ranks reach here without hanging/erroring TF joinablesr,r-c sPt|dkr td||_fdd|jD|_||_||_||dS)Nrz7The join context manager requires at least one joinablecsg|] }|jdiqS)r )r$).0joinabler#r r sz!Join.__init__..)len ValueError _joinables _join_hooks_enable_throw_on_early_termination_set_joinable_configs_extract_dist_info)rr2r,r-r#r r5rrs   z Join.__init__r NcCs>t|jdks Jd}|jD]}t|j|j|d|_d}qdS)zESet the :class:`_JoinConfig` of each participating :class:`Joinable`.rTr/FN)r7r9rr;r<r )rr.r4r r rr=s zJoin._set_joinable_configscCsbd}d}|jD]}|dur|j}n ||jkrtd|dur!|j}q||_t|j|_||_dS)a Extract the process group and device information from the joinables. If there are multiple joinables, then the context manager uses the first specified device. Preconditions: ``self._joinables`` is not ``None`` and is non-empty. Raises: ValueError If there are multiple conflicting ``process_group`` attributes among the ``Joinable`` objects. Nz7Using join context manager with multiple process groups) r9r'r8r%_process_groupdistZget_rank_rank_device)r process_groupr*r4r r rr>s   zJoin._extract_dist_infocCsdSrr rr r r __enter__rzJoin.__enter__typevalue tracebackc Cs|jr|rdSd}d}d}d}td|sN||kr*td|d|jd |d |}|dkr5d}n|jr<||jD]} | q?d}|d 7}|r|jD]} | |qQdS) z Repeatedly runs the main hooks until all processes join; then, runs the post-hooks. Raises: RuntimeError If ``throw_on_early_termination=True``. NFTrioncez+Detected uneven input skew of greater than z. This means that rank z has at least zz fewer inputs than other currently-active ranks. This level of skew could lead to performance degradation during training.) r;warnings simplefilterwarnrA_get_num_nonjoined_procsr<_notify_procs_to_terminater:rr) rrErFrGZall_procs_joinedriZWARN_THRESHOLDnum_nonjoined_procsr$r r r__exit__s>       z Join.__exit__cCs(tjd|jd}tj||jd|S)zaReturn the number of non-joined processes by shadowing an all-reduce in the non-joined processes.rIr*group)r)zerosrBr@ all_reducer?item)rrPr r rrMszJoin._get_num_nonjoined_procscCs2tjd|jd}tj||jdtd|jd)zSchedule an all-reduce to notify non-joined processes to terminate. Also raise a ``RuntimeError`` indicating that the current process has exhausted its inputs. rIrRrSzRank z exhausted all inputs.)r)onesrBr@rVr? RuntimeErrorrA)rrXr r rrNszJoin._notify_procs_to_terminater4cCst|dsJdt|d|j}|jr|jsdS|j}|j}tjd|d}t j ||dd}|j rJtj d|d}t j ||d | }|rJtd |S) aH Notifies the join context manager that the calling process has not yet joined. Then, if ``throw_on_early_termination=True``, checks if uneven inputs have been detected (i.e. if one process has already joined) and throws an exception if so. This method should be called from a :class:`Joinable` object before its per-iteration collective communications. For example, this should be called at the beginning of the forward pass in :class:`DistributedDataParallel`. Only the first :class:`Joinable` object passed into the context manager performs the collective communications in this method, and for the others, this method is vacuous. Arguments: joinable (Joinable): the :class:`Joinable` object calling this method. Returns: An async work handle for the all-reduce meant to notify the context manager that the process has not yet joined if ``joinable`` is the first one passed into the context manager; ``None`` otherwise. r zCheck that the z/ constructor calls the ``Joinable`` constructorNrIrRT)rTZasync_oprSzLDetected at least one rank that exhausted inputs. Throwing across all ranks.)hasattrrEr r.r,r%r'r)rXr@rVr-rUrWrY)r4Z join_configr*rCrXZworkrUZ should_throwr r rnotify_join_context's&  zJoin.notify_join_context)TFr)rrrrlistr rrr=r>rDrrE BaseExceptionrrQrMrNr1r[r r r rr hs2@    4 r )rJabcrrtypesrtypingrrrr)Ztorch.distributed distributedr@__all__rr rr r r r rs  *