a d0@sddlZddlmZmZddlmZmZmZmZm Z m Z m Z ddl m Z ddlZddlmZddlmZddlmZddlmZe d ZGd d d eeeZdS) N)ABCabstractmethod)AnyDictGenericOptionalTypeTypeVarUnion)Metric)_ResultCollection) BaseProgress)MisconfigurationException)_fault_tolerant_trainingTc@seZdZdZddddZeddddZejddd d dZeedd d Z e jedd dd Z ee edddZ eedddZ dddddZ ededfddddZedddZeeedddZe ddddZeeddd d!Zeeddd"d#Ze eeddd$d%Zddd&d'Zedd(d)Zddd*d+Zedd,d-Zedd.d/d0Zd:eee ed2d3d4Z!d;ee eee e"fdd5d6d7Z#d= self.trainer.max_steps NrrrrrdoneQsz Loop.donecCsdS)zDetermine whether to return immediately from the call to :meth:`run`. Example:: @property def skip(self): return len(self.trainer.train_dataloader) == 0 Frrrrrskip]s z Loop.skip)kwargsrcKsdS)zhOptionally connect one or multiple loops to this one. Linked loops should form a tree. Nr)rr%rrrconnectisz Loop.connect)loopsrc si}|D]\}}t||t|trtjjj}t|jj}||krtt d|jj d|j djj dfdd|D}|fi|}n|}ddj D}|j fi||j |_ |||<q |j fi|dS) aOptionally replace one or multiple of this loop's sub-loops. This method takes care of instantiating the class (if necessary) with all existing arguments, connecting all sub-loops of the old loop to the new instance, setting the ``Trainer`` reference, and connecting the new loop to the parent. Args: **loops: ``Loop`` subclasses or instances. The name used should match the loop attribute name you want to replace. Raises: MisconfigurationException: When passing a ``Loop`` class, if the ``__init__`` arguments do not match those of the Loop class it replaces. `z .replace(z<)` can only be used if the `__init__` signatures match but `z ` does not.cs i|]}|dkr|t|qSr)getattr).0pZold_looprr z Loop.replace..cSs i|]\}}t|tr||qSr)rr)r*nlprrrr-r.N)itemsr)rtypeinspect signature __class__r parametersr__name__rr&r) rr'Z new_loopsnameZtype_or_objectZold_parametersZcurrent_parametersr%r"rr,rreplaceos(   z Loop.replacecCsdS)zThe function to run when :meth:`run` should be skipped, determined by the condition in :attr:`skip`. Returns: the default output value of :meth:`on_run_end` Nrrrrron_skipsz Loop.on_skip)argsr%rcOs|jr|S||j|i||jsxz2|j|i||j|i||d|_Wq&t ytYqxYq&0q&d|_| }|S)aThe main entry point to the loop. Will frequently check the :attr:`done` condition and calls :attr:`advance` until :attr:`done` evaluates to ``True``. Override this if you wish to change the default behavior. The default implementation is: Example:: def run(self, *args, **kwargs): if self.skip: return self.on_skip() self.reset() self.on_run_start(*args, **kwargs) while not self.done: self.advance(*args, **kwargs) output = self.on_run_end() return output Returns: The output of :attr:`on_run_end` (often outputs collected from each step of the loop) F) r$r:reset on_run_startr#on_advance_startadvanceon_advance_endr StopIteration on_run_end)rr;r%outputrrrruns   zLoop.runcCsdS)a\Resets the internal state of the loop at the beginning of each call to :attr:`run`. Example:: def reset(self): # reset your internal state or add custom logic # if you expect run() to be called multiple times self.current_iteration = 0 self.outputs = [] Nrrrrrr<sz Loop.resetcOsdS)zHook to be called as the first thing after entering :attr:`run` (except the state reset). Accepts all arguments passed to :attr:`run`. Nrrr;r%rrrr=szLoop.on_run_startcOsdS)z{Hook to be called each time before :attr:`advance` is called. Accepts all arguments passed to :attr`run`. NrrErrrr>szLoop.on_advance_startcOsdS)a#Performs a single step. Accepts all arguments passed to :attr:`run`. Example:: def advance(self, iterator): batch = next(iterator) loss = self.trainer.lightning_module.training_step(batch, batch_idx) ... NrrErrrr?sz Loop.advancecCsdS)zThe state dict is determined by the state and progress of this loop and all its children. Args: destination: An existing dictionary to update with this loop's state. By default a new dictionary is returned. prefix: A prefix for each key in the state dictionary NrH.) rGrrr1rr rHrr syncZunsync)rrKrLZ ft_enabledkrkeyrrrrHs    zLoop.state_dict)rHrLmetricsrcCsR|||||jD]*\}}t|tr||||dqd|_dS)z2Loads the state of this loop and all its children.rMTN)_load_from_state_dictcopyrr1rrload_state_dictr )rrHrLrQrOrrrrrT,s  zLoop.load_state_dictc Cs|j}|jD]\}}||}||vr*qt|trD|||qt|tr|dur|jdurdd|jj D}|r| ||j||||jj j d|jj s|jddq|d|vr|||ddS)NcSs i|]\}}t|tr||qSr)rr )r*r8modulerrrr-Ds z.Loop._load_from_state_dict..)rQZsync_fnF)rQrH)rrr1rr rTr Zlightning_modulerZ named_modulesupdateZstrategyreduceZis_global_zeror<rI) rrHrLrQrrOrrPZmetric_attributesrrrrR9s$    zLoop._load_from_state_dict)NrJ)rJN)N)%r7 __module__ __qualname____doc__rpropertyrsetterboolr rr#r$r&r rr9rr:rrDr<r=r>r?r@rBrFrrGrIrstrrHr rTrRrrrrrsP  -.    r)r3abcrrtypingrrrrrr r Z torchmetricsr Zpytorch_lightningplZs$