o +ѹgLX@sddlZddlZddlmZmZddlmZmZmZm Z m Z m Z m Z m Z mZmZmZmZddlmZgdZdejdeejge ejffddZdejd e eje eeffd ed eejge ejffd d Zdejde eejdeejde eefd e eje eefff ddZd efddZGdddeZdejdededeeejd ef ddZGdddeZGdddeZ dejdeded ed ef d!d"Z!dejdeded#eeejd ef d$d%Z"dejde e#defd&d'Z$dejdeded efd(d)Z%ed*ddfdejdeded+ed,e eeejd-e eeejd efd.d/Z&ej'ej(he&_)ej*he&_+ej,d0ed1ed e d2fd3d4Z-dejd5ed ejfd6d7Z.dejd0ed ejfd8d9Z/ :dCdejd;ed0edeejded eejeffd?d@Z1GdAdBdBZ2dS)DN)ABCabstractmethod) AnyCallablecastDict GeneratorIterableOptionalSequenceSetTupleTypeUnion)always_wrap_policylambda_auto_wrap_policytransformer_auto_wrap_policysize_based_auto_wrap_policy enable_wrapwrap CustomPolicyModuleWrapPolicy root_modulefncs<|hdtjdtdttjffdd |dddS)aQ This applies ``fn`` to every module in the module tree of ``root_module`` following a post-order traversal. If ``fn`` returns an :class:`nn.Module`, then this replaces the original module with the newly returned one in the tree. Otherwise, ``fn`` should return ``None``, in which case the module is not changed. module module_name parent_modulecs|D]\}}|vr||||q|}|durNt|tjs0Jd|d||s9Jd|t|tjsFJd|t|||dSdS)Nz=Non-root modules should have their parent module set but got z for zTNon-root modules should have their module name set but got an empty module name for z.fn should return None or an nn.Module but got )named_childrenadd isinstancennModulesetattr)rrrZchild_module_nameZ child_moduleZoptional_module_post_order_apply_innerrZvisited_modules_/Users/admin/.pyenv/versions/3.10.0/lib/python3.10/site-packages/torch/distributed/fsdp/wrap.pyr$7s4  z2_post_order_apply.._post_order_apply_innerN)r r!strr )rrr%r#r&_post_order_apply)s r)target_module_to_kwargsfsdp_fnreturncs&dtjdttjffdd }|S)z This constructs the "wrap" function to pass to :func:`_post_order_apply` based on ``target_module_to_kwargs``, which should be constructed from the wrapping policy. rr,cs,|vr|ur|}|fi|SdSNr%)rkwargsr+rr*r%r&r]sz_construct_wrap_fn..fnN)r r!r )rr*r+rr%r/r&_construct_wrap_fnRs" r0module_classesignored_modules root_kwargscCsNtt|}|D]}||vrq t||r$||vr|||<d||d<q |S)NZmixed_precision)tuplesetmodulesr)rr1r2r3r*Zmodule_classes_tuplerr%r%r&$_run_mixed_precision_override_policyhs    r7cOdS)z A simple recursive wrap policy that always returns ``True``. This means that every submodule is wrapped by the wrapper class in :func:`_recursive_wrap`. TNr%)argsr.r%r%r&r|src @sPeZdZdZedejdeejdee e fdeejee e fffddZ dS) _Policyzk This defines an abstract base class that represents a policy for applying a module-level API. rr2r3r,cCr8)z This should return a dict ``target_module_to_kwargs`` that maps from each target module to wrap to its kwargs. Nr%)selfrr2r3r%r%r& _run_policys z_Policy._run_policyN) __name__ __module__ __qualname____doc__rr r!r rr(rr<r%r%r%r&r:s r:rrecursenonwrapped_numelcCs|rdSt|t|S)a This auto wrap policy wraps every module that is an instance of any type in ``module_classes`` as its own FSDP instance. The root module given by ``module`` is always wrapped as an FSDP instance regardless. Since the wrapping proceeds bottom up, each FSDP instance manages the parameters in its subtree excluding any already managed by a child FSDP instance. Args: module (nn.Module): Current module being considered. recurse (bool): If ``False``, then this function must decide whether ``module`` should be wrapped as an FSDP instance or not. If ``True``, then the function is still recursing down the module tree as a part of the DFS. nonwrapped_numel (int): Parameter numel not yet wrapped. module_classes (Set[Type[nn.Module]]): Set of module classes that are wrapped as FSDP instances. Returns: ``True`` if ``recurse=True``, and whether ``module`` should be wrapped if ``recurse=False``. TNrr4)rrArBr1r%r%r&_module_wrap_policysrDc seZdZdZdeeejfddZdejde ejde e e fde eje e e fffd d Z d d Zde ffd d ZZS)rz{ This policy applies to every module of the specified module classes, passing in the kwargs given to the root. r1cCst|}||_t||_dSr-)r5_module_classesr(_module_classes_str)r;r1Zmodule_classes_setr%r%r&__init__szModuleWrapPolicy.__init__rr2r3r,cCsBt|j}i}|D]}||vrq t||rt|||<q |Sr-)r4rEr6rcopy)r;rr2r3r1r*rr%r%r&r<s   zModuleWrapPolicy._run_policycOst||d|jdS)N)rBr1)rDrE)r;rrAr9r.r%r%r&__call__s zModuleWrapPolicy.__call__cstd|jdS)N())super__repr__rFr; __class__r%r&rNszModuleWrapPolicy.__repr__)r=r>r?r@r rr r!rGr rr(rr<rJrN __classcell__r%r%rPr&rs  rc @sveZdZdZdeejgeee e e ffffddZ dejde ejde e e fde eje e e fffd d Zd S) ra This policy takes in a lambda function that maps a given ``nn.Module`` to either ``False``, ``True``, or a kwarg dictionary. - If the function returns ``False`` or an empty dictionary, then the module does not have the API applied. - If the function returns ``True``, then the module has the API applied with the root's kwargs. - If the function returns a non-empty dictionary, then the module has the API applied, and the dictionary overrides the root's kwargs. Example:: >>> # xdoctest: +SKIP("undefined variables") >>> model = init_transformer_model(...) >>> def lambda_fn(module: nn.Module): >>> if module is model.lm_head: >>> return {"sharding_strategy": ShardingStrategy.SHARD_GRAD_OP} >>> elif isinstance(module, TransformerBlock): >>> return True >>> return False >>> policy = CustomPolicy(lambda_fn) >>> fsdp_model = FSDP(model, auto_wrap_policy=policy) lambda_fncC ||_dSr-) _lambda_fn)r;rSr%r%r&rG zCustomPolicy.__init__rr2r3r,cCsri}|D]0}||vr q||}t|ttfs td||s#qt|}t|tr2|||||<q|S)Nz_The lambda_fn passed to CustomPolicy should return False/True or a kwarg dict, but it returned )r6rUrdictbool ValueErrorrHupdate)r;rr2r3r*rresr.r%r%r&r<s$      zCustomPolicy._run_policyN)r=r>r?r@rr r!rrXrr(rrGr r<r%r%r%r&rs* rrScCs|rdS||S)aU A convenient auto wrap policy to wrap submodules based on an arbitrary user function. If `lambda_fn(submodule) == True``, the submodule will be wrapped as a `wrapper_cls` unit. Return if a module should be wrapped during auto wrapping. The first three parameters are required by :func:`_recursive_wrap`. Args: module (nn.Module): Current module being considered. recurse (bool): If ``False``, then this function must decide whether ``module`` should be wrapped as an FSDP instance or not. If ``True``, then the function is still recursing down the module tree as a part of the DFS. nonwrapped_numel (int): Parameter numel not yet wrapped. lambda_fn (Callable[[nn.Module], bool]): If this returns ``True``, then this module will be wrapped. TNr%)rrArBrSr%r%r&rsrtransformer_layer_clscCst||||S)a- See :func:`_module_wrap_policy`, where ``transformer_layer_cls`` is the same as ``module_classes``. Note that shared parameters must be wrapped in the same FSDP instance, so this auto wrap policy can help wrap shared embeddings into the same FSDP instance for transformer models. N)rD)rrArBr\r%r%r&r1s rcOs|rdSt|t|S)NTrC)rr1rAr9r.r%r%r&_wrap_module_cls_individually@sr]cstfdd|DS)zv A policy that wraps ``module`` if any policy in the passed in iterable of ``policies`` returns ``True``. c3s|] }|dVqdS)rrArBNr%).0policyrrBrAr%r& Vs  z_or_policy..N)any)rrArBZpoliciesr%rar& _or_policyLs rdgחAmin_num_paramsforce_leaf_modulesexclude_wrap_modulescCs\|durtjn|}|durtjn|}|}||k}|r$|o#t|t| S|o-t|t| S)a A size-based auto wrap policy. Args: module (nn.Module): Current module being considered. recurse (bool): If ``False``, then this function must decide whether ``module`` should be wrapped as an FSDP instance or not. If ``True``, then the function is still recursing down the module tree as a part of the DFS. nonwrapped_numel (int): Parameter numel not yet wrapped. min_num_params (int): Customizable policy input that controls the size threshold over which a module is ready to be wrapped. This is in units of numel. force_leaf_modules (Set[Type[nn.Module]]): Set of module types to keep as leaves, i.e. their children will never be wrapped. exclude_wrap_modules (Set[Type[nn.Module]]): Set of module types to be excluded in wrapping. Returns: Whether ``module`` should be wrapped. N)rFORCE_LEAF_MODULESEXCLUDE_WRAP_MODULESrr4)rrArBrerfrgZmin_nonwrapped_numelZis_larger%r%r&r\s!r wrapper_clswrapper_kwargs)NNNcksHd|i|}tdi| dVWddS1swYdS)a Context manager to wrap modules using a wrapper. Useful for when you'd like to apply the same configuration arguments to all child modules that you wrap. A particularly important use case is wrapping large layers so that they get sharded (in-place) during initialization, to avoid running out of system memory. Large layers can indicate that they should be sharded via the ``wrap`` annotation and this context manager can provide the exact configuration for these nested instances. Usage:: with enable_wrap(wrapper_cls, **params): # Wraps layer in FSDP by default if within context self.l1 = wrap(torch.nn.Linear(5, 5)) Args: wrapper_cls: Class that `wrap` annotation will `wrap` modules with, such as `FullyShardedDataParallel`. **wrapper_kwargs: Configuration settings that will be passed to all ``wrap`` instances inside the context rjNr%)_ConfigAutoWrap)rjrkr.r%r%r&rs"rwrap_overridescKs:tjrtjdus Jitj|}t|tjfi|S|S)a Annotate that a module should be wrapped. Annotated modules will only be wrapped if inside of an :func:`enable_wrap` context manager. This allows a module to be initialized both with and without a wrapper without code change. The class that this function wraps the passed in ``nn.Module`` with is the passed in ``wrapper_cls`` argument into ``enable_wrap``. Both ``enable_wrap`` and ``wrap`` can take in kwargs specifying how to construct the ``wrapper_cls`` instance. In the case of duplicate kwargs in ``enable_wrap`` and ``wrap``, the argument passed into ``wrap`` will be respected. Usage:: with enable_wrap(wrapper_cls=FSDP, **fsdp_config): # Wraps layer in FSDP by default if within context self.l1 = wrap(torch.nn.Linear(5, 5)) Args: module (nn.Module): module to wrap (if in :func:`enable_wrap` context) **wrap_overrides: configuration overrides that will take priority over the values provided by the :func:`enable_wrap` context N)rlin_autowrap_contextrjr._wrap)rrmr%r%r&rsrcKsD|dusJt|dri||j}||fi|S||fi|S)N_wrap_overrides)hasattrrp)rrjr.Z overridesr%r%r&ros  roFauto_wrap_policyignored_paramsonly_wrap_childrenr.c s,|dusJd|dusJd|D]\}}||vrqz t|tt|r(JWqty2Yqwtfdd|D} |dusFJ||d| drd} |D]"\} }||vr\qStd ||||d |\} } t || | | | 7} qS| | }|s||d |drt ||fi|| fS|| fS|dfS) a Wraps submodules of ``module`` for which ``auto_wrap_policy`` returns ``True`` with ``wrapper_cls``. Args: module (nn.Module): Module to recursively wrap. auto_wrap_policy (Callable): A callable representing a policy that determines which modules to recursively wrap with ``wrapper_cls``. ignored_modules (Set[torch.nn.Module]): Modules to ignore when wrapping. ignored_params (Set[torch.nn.Parameter]): Parameters to ignore when wrapping; these should be the parameters contained in the modules in ``ignored_modules``. Returns: (nn.Module, int): ``module`` after wrapping and the numel recursively wrapped. NzMust specify auto_wrap_policy.zMust specify wrapper_clsc3s |] }|vr|VqdSr-)Znumel)r_prsr%r&rbs  z"_recursive_wrap..Tr^r)rrrrjr2rsFr%) Z named_modulesrrtype TypeErrorsum parametersr_recursive_wrapr"ro)rrrrjr2rsrtr._childrBZtotal_wrapped_numelnameZ wrapped_childZnum_wrapped_params remainderr%rvr&r{sJ     r{c@seZdZUdZdZeed<dZee ed<iZ e e e fed<de e e ffddZede d dfd d Zedd d ZdddZde de de d dfddZdS)rlz Helper class to wrap modules based on default config args via a context manager. See :func:`enable_wrap` for more information. FrnNrjr.cKrTr-r.)r;r.r%r%r&rGArVz_ConfigAutoWrap.__init__r,cCsHtjrtddt_d|vsJdtt|dt_|d=|t_dS)Nz]You are already within an autowrap context and we currently do not supported nested autowrap.Trjz9Expected to pass in wrapper_cls arg into _ConfigAutoWrap.)rlrnNotImplementedErrorkeysrrrjr.rr%r%r&enable_autowrap_contextDs  z'_ConfigAutoWrap.enable_autowrap_contextcCsdt_dt_it_dS)NF)rlrnrjr.r%r%r%r&disable_autowrap_contextTs z(_ConfigAutoWrap.disable_autowrap_contextcCs||jdSr-)rr.rOr%r%r& __enter__Zsz_ConfigAutoWrap.__enter__exc_typeexc_valexc_tbcCs |dSr-)r)r;rrrr%r%r&__exit__]s z_ConfigAutoWrap.__exit__)r,N)r=r>r?r@rnrX__annotations__rjr rr.rr(rrG staticmethodrrrrr%r%r%r&rl7s    rl)F)3 contextlibrHabcrrtypingrrrrrr r r r r rrZtorch.nnr __all__r!r)r(r0r7rXrr:intrDrrrrrwr]rdrZ ModuleListZ ModuleDictriZMultiheadAttentionrhcontextmanagerrrro Parameterr{rlr%r%r%r&s 8  )        %7       7  #%  J