o zi"@szddlmZmZmZmZddlmZddlZddl m Z ddl m Z Gddde Z dd d eeeeefffd d ZdS) )AnyDictOptionalUnion)overrideN)Callback)rank_zero_warnc@seZdZdZd2ddZed3ddZedefd d Zedefd d Z edefd dZ edefddZ edefddZ ede eeffddZede eeffddZede eeffddZede eeffddZede eeffddZdedefddZd2d d!Zd2d"d#Zd2d$d%Zd&ed'eddfd(d)Zed*dd+d,d-eddfd.d/Zd*dd+d,deee eeeeeeffffd0d1ZdS)4 ProgressBaraThe base class for progress bars in Lightning. It is a :class:`~pytorch_lightning.callbacks.Callback` that keeps track of the batch progress in the :class:`~pytorch_lightning.trainer.trainer.Trainer`. You should implement your highly custom progress bars with this as the base class. Example:: class LitProgressBar(ProgressBar): def __init__(self): super().__init__() # don't forget this :) self.enable = True def disable(self): self.enable = False def on_train_batch_end(self, trainer, pl_module, outputs, batch, batch_idx): super().on_train_batch_end(trainer, pl_module, outputs, batch, batch_idx) # don't forget this :) percent = (batch_idx / self.total_train_batches) * 100 sys.stdout.flush() sys.stdout.write(f'{percent:.01f} percent complete \r') bar = LitProgressBar() trainer = Trainer(callbacks=[bar]) returnNcCsd|_d|_dSN)_trainer_current_eval_dataloader_idxselfre/home/ubuntu/.local/lib/python3.10/site-packages/pytorch_lightning/callbacks/progress/progress_bar.py__init__2s zProgressBar.__init__ pl.TrainercCs$|jdurtd|jjd|jS)NzThe `z*._trainer` reference has not been set yet.)r TypeError __class____name__rrrrtrainer6s zProgressBar.trainercCdS)NzSanity Checkingrrrrrsanity_check_description<z$ProgressBar.sanity_check_descriptioncCr)NTrainingrrrrrtrain_description@rzProgressBar.train_descriptioncCr)N Validationrrrrrvalidation_descriptionDrz"ProgressBar.validation_descriptioncCr)NTestingrrrrrtest_descriptionHrzProgressBar.test_descriptioncCr)N Predictingrrrrrpredict_descriptionLrzProgressBar.predict_descriptioncCs|jjS)zThe total number of training batches, which may change from epoch to epoch. Use this to set the total number of iterations in the progress bar. Can return ``inf`` if the training dataloader is of infinite size. )rnum_training_batchesrrrrtotal_train_batchesPszProgressBar.total_train_batchescCs>|jjr|jjn|jj}t|tr|jdusJ||jS|S)aThe total number of validation batches, which may change from epoch to epoch for current dataloader. Use this to set the total number of iterations in the progress bar. Can return ``inf`` if the validation dataloader is of infinite size. N)rsanity_checkingnum_sanity_val_batchesnum_val_batches isinstancelistr rbatchesrrr$total_val_batches_current_dataloaderZs   z0ProgressBar.total_val_batches_current_dataloadercCs.|jj}t|tr|jdusJ||jS|S)zThe total number of testing batches, which may change from epoch to epoch for current dataloader. Use this to set the total number of iterations in the progress bar. Can return ``inf`` if the test dataloader is of infinite size. N)rnum_test_batchesr(r)r r*rrr%total_test_batches_current_dataloaderhs   z1ProgressBar.total_test_batches_current_dataloadercCs|jdusJ|jj|jS)aThe total number of prediction batches, which may change from epoch to epoch for current dataloader. Use this to set the total number of iterations in the progress bar. Can return ``inf`` if the predict dataloader is of infinite size. N)r rnum_predict_batchesrrrr(total_predict_batches_current_dataloadervsz4ProgressBar.total_predict_batches_current_dataloadercCs4|jjjs dSt|jjtrt|jjS|jjS)aThe total number of validation batches, which may change from epoch to epoch for all val dataloaders. Use this to set the total number of iterations in the progress bar. Can return ``inf`` if the predict dataloader is of infinite size. r)rfit_loop epoch_loop_should_check_val_epochr(r'r)sumrrrrtotal_val_batchess  zProgressBar.total_val_batchesdataloader_idxcCs|j}||_||kSr r )rr6old_dataloader_idxrrrhas_dataloader_changedsz"ProgressBar.has_dataloader_changedcCs d|_dSr r7rrrrreset_dataloader_idx_trackers z(ProgressBar.reset_dataloader_idx_trackercCt)z5You should provide a way to disable the progress bar.NotImplementedErrorrrrrdisablerzProgressBar.disablecCr;)aOYou should provide a way to enable the progress bar. The :class:`~pytorch_lightning.trainer.trainer.Trainer` will call this in e.g. pre-training routines like the :ref:`learning rate finder `. to temporarily enable and disable the training progress bar. r<rrrrenableszProgressBar.enableargskwargscOst|i|dS)zDYou should provide a way to print without breaking the progress bar.N)print)rr@rArrrrBszProgressBar.printr pl_modulezpl.LightningModulestagecCs||_|js |dSdSr )r is_global_zeror>)rrrCrDrrrsetups zProgressBar.setupcCsRt|}|j}t||@}|r#tdd|d|ddi||S)a^Combines progress bar metrics collected from the trainer with standard metrics from get_standard_metrics. Implement this to override the items displayed in the progress bar. Here is an example of how to override the defaults: .. code-block:: python def get_metrics(self, trainer, model): # don't show the version number items = super().get_metrics(trainer, model) items.pop("v_num", None) return items Return: Dictionary with the items to be displayed in the progress bar. z;The progress bar already tracks a metric with the name(s) 'z, z' and `self.log('rz', ..., prog_bar=True)` will overwrite this value. If this is undesired, change the name or override `get_metrics()` in the progress bar callback.)get_standard_metricsprogress_bar_metricsr)keysrjoin)rrrCstandard_metrics pbar_metrics duplicatesrrr get_metricss zProgressBar.get_metrics)r N)r r) r __module__ __qualname____doc__rpropertyrstrrrrr r"rintfloatr$r,r.r0r5boolr9r:r>r?rrBrrFrrNrrrrr sN          r rrr cCsJi}|jr#ddlm}||j}dvr#t|tr|dd}||d<|S)uXReturns the standard metrics displayed in the progress bar. Currently, it only includes the version of the experiment when using a logger. .. code-block:: Epoch 1: 4%|▎ | 40/1095 [00:03<01:37, 10.84it/s, v_num=10] Return: Dictionary with the standard metrics to be displayed in the progress bar. r)_version)NNv_num)loggers#pytorch_lightning.loggers.utilitiesrWr(rS)r items_dictrWversionrrrrGs    rG)typingrrrrtyping_extensionsrpytorch_lightningplpytorch_lightning.callbacksr%pytorch_lightning.utilities.rank_zerorr rSrTrGrrrrs   &<