o ziU2@sddlZddlmZddlmZmZmZmZmZm Z ddl m Z ddl m Z ddlmZddlmZddlmZmZdd lmZmZdd lmZmZmZdd lmZdd lmZm Z dd l!m"Z"ddl#m$Z$e dZ%e dZ&ere%ryddl'm(Z(nddl)m(Z(GdddeZ*dS)N) Namespace) TYPE_CHECKINGAnyDictMappingOptionalUnion)RequirementCache)Tensor)Module)override)Loggerrank_zero_experiment)_is_dirget_filesystem) _add_prefix_convert_params _flatten_dict)_sanitize_params)rank_zero_onlyrank_zero_warn)_PATH)_unwrap_objects tensorboard tensorboardX SummaryWritercseZdZdZdZ     d4dedeed eee efd e d ed eed e ffdd Z e edefddZe edee effddZe edefddZe edefddZe deefddZe ed5ddZeed6deeefdee ddfd d!Zee d6d"eeee fefdeeee fddfd#d$Zeed6d%ed&eeddfd'd(Zeed7d)d*Z eed+eddfd,d-Z!de fd.d/Z"e#d"eee fdeee ffd0d1Z$deee ffd2d3Z%Z&S)8TensorBoardLoggeraLog to local file system in `TensorBoard `_ format. Implemented using :class:`~tensorboardX.SummaryWriter`. Logs are saved to ``os.path.join(root_dir, name, version)``. This is the recommended logger in Lightning Fabric. Args: root_dir: The root directory in which all your experiments with different names and versions will be stored. name: Experiment name. Defaults to ``'lightning_logs'``. If it is the empty string then no per-experiment subdirectory is used. version: Experiment version. If version is not specified the logger inspects the save directory for existing versions, then automatically assigns the next available version. If it is a string then it is used as the run-specific subdirectory name, otherwise ``'version_${version}'`` is used. default_hp_metric: Enables a placeholder metric with key `hp_metric` when `log_hyperparams` is called without a metric (otherwise calls to ``log_hyperparams`` without a metric are ignored). prefix: A string to put at the beginning of all metric keys. sub_dir: Sub-directory to group TensorBoard logs. If a ``sub_dir`` argument is passed then logs are saved in ``/root_dir/name/version/sub_dir/``. Defaults to ``None`` in which case logs are saved in ``/root_dir/name/version/``. \**kwargs: Additional arguments used by :class:`tensorboardX.SummaryWriter` can be passed as keyword arguments in this logger. To automatically flush to disk, `max_queue` sets the size of the queue for pending logs before flushing. `flush_secs` determines how many seconds elapses before flushing. Example:: from lightning_fabric.loggers import TensorBoardLogger logger = TensorBoardLogger("path/to/logs/root", name="my_model") logger.log_hyperparams({"epochs": 5, "optimizer": "Adam"}) logger.log_metrics({"acc": 0.75}) logger.finalize("success") -lightning_logsNTroot_dirnameversiondefault_hp_metricprefixsub_dirkwargsc stststdttdtttt|}||_|p"d|_ ||_ |dur-dnt||_ ||_ ||_ t||_d|_||_dS)NzTNeither `tensorboard` nor `tensorboardX` is available. Try `pip install`ing either.  r )_TENSORBOARD_AVAILABLE_TENSORBOARDX_AVAILABLEModuleNotFoundErrorstrsuper__init__osfspath _root_dir_name_version_sub_dir_default_hp_metric_prefixr_fs _experiment_kwargs)selfr!r"r#r$r%r&r' __class__X/home/ubuntu/.local/lib/python3.10/site-packages/lightning_fabric/loggers/tensorboard.pyr.Qs&      zTensorBoardLogger.__init__returncC|jS)zcGet the name of the experiment. Returns: The name of the experiment. )r2r:r=r=r>r"n zTensorBoardLogger.namecCs|jdur ||_|jS)z~Get the experiment version. Returns: The experiment version if specified else the next version. N)r3_get_next_versionrAr=r=r>r#ys zTensorBoardLogger.versioncCr@)zGets the save directory where the TensorBoard experiments are saved. Returns: The local path to the save directory where the TensorBoard experiments are saved. )r1rAr=r=r>r!rBzTensorBoardLogger.root_dircCsjt|jtr |jnd|j}tj|j|j|}t|jtr'tj||j}tj |}tj |}|S)zThe directory for this run's tensorboard checkpoint. By default, it is named ``'version_${self.version}'`` but it can be overridden by passing a string value for the constructor's version parameter instead of ``None`` or an int. version_) isinstancer#r,r/pathjoinr!r"r& expandvars expanduser)r:r#log_dirr=r=r>rJs    zTensorBoardLogger.log_dircCr@)zGets the sub directory where the TensorBoard experiments are saved. Returns: The local path to the sub directory where the TensorBoard experiments are saved. )r4rAr=r=r>r&szTensorBoardLogger.sub_dirrcCsv|jdur|jStjdksJd|jr|jj|jddtr&ddlm}nddl m}|dd|j i|j |_|jS) zActual tensorboard object. To use TensorBoard features anywhere in your code, do the following. Example:: logger.experiment.some_tensorboard_function() Nrz+tried to init log dirs in non global_rank=0T)exist_okrrJr=) r8rrankr!r7makedirsr)torch.utils.tensorboardrrrJr9)r:rr=r=r> experiments  zTensorBoardLogger.experimentmetricsstepc Cstjdks Jdt||j|j}|D]:\}}t|tr"|}t|t r0|j |||qz |j |||Wqt yO}z td|d|d}~wwdS)Nrz-experiment tried to log from global_rank != 0z you tried to log zA which is currently not supported. Try a dict or a scalar/tensor.)rrLrr6LOGGER_JOIN_CHARitemsrEr itemdictrO add_scalars add_scalar Exception ValueError)r:rPrQkvexr=r=r> log_metricss$   zTensorBoardLogger.log_metricsparamscCst|}t|}||}|dur|jrddi}n t|ts"d|i}|rW||dtr3ddlm }nddl m }|||\}}}|j }| || || |dSdS)aRecord hyperparameters. TensorBoard logs with and without saved hyperparameters are incompatible, the hyperparameters are then not displayed in the TensorBoard. Please delete or move the previously saved logs to display the new ones with hyperparameters. Args: params: a dictionary-like container with the hyperparameters metrics: Dictionary with metric names as keys and measured quantities as values N hp_metricr)hparams)rrrr5rErUr]r)torch.utils.tensorboard.summaryratensorboardX.summaryrO_get_file_writer add_summary)r:r^rPraexpssiseiwriterr=r=r>log_hyperparamss(       z!TensorBoardLogger.log_hyperparamsmodel input_arraycCst|dd}|dur |n|}t|}|durtddSt|ttfs/tdt|ddStt|ddrRtt|ddrR||}| |}|j ||dS|j ||dS)Nexample_input_arrayzCould not log computational graph to TensorBoard: The `model.example_input_array` attribute is not set or `input_array` was not given.zlCould not log computational graph to TensorBoard: The `input_array` or `model.example_input_array` has type z which can't be traced by TensorBoard. Make the input array a tuple representing the positional arguments to the model's `forward()` implementation._on_before_batch_transfer_apply_batch_transfer_handler) getattrrrrEr tupletypecallablernrorO add_graph)r:rkrlmodel_example_inputr=r=r> log_graphs(    zTensorBoardLogger.log_graphcCs|jdSN)rOflushrAr=r=r>saveszTensorBoardLogger.savestatuscCs&|jdur|j|jdSdSrw)r8rOrxclose)r:rzr=r=r>finalize$s  zTensorBoardLogger.finalizecCstj|j|j}z|j|}Wn tyYdSwg}|D]-}|d}tj|}t |j|rM| drM| dd dd}| rM|t|q t|dkrVdSt|dS)Nrr"rD_/r )r/rFrGr!r"r7listdirOSErrorbasenamer startswithsplitreplaceisdigitappendintlenmax)r:save_dir listdir_infoexisting_versionslistingdbndir_verr=r=r>rC+s$    z#TensorBoardLogger._get_next_versioncCst|}dd|DS)NcSs2i|]\}}|t|dr|jdkrt|n|qS)ndimr~)hasattrrr,).0rZr[r=r=r> Ds2z6TensorBoardLogger._sanitize_params..)_utils_sanitize_paramsrS)r^r=r=r>r@sz"TensorBoardLogger._sanitize_paramscCs|j}d|d<|S)Nr8)__dict__copy)r:stater=r=r> __getstate__Fs zTensorBoardLogger.__getstate__)rNTr N)r?rrw)r?N)'__name__ __module__ __qualname____doc__rRrrr,rrboolrr.propertyr r"r#r!rJr&rrOrrfloatr]rrrjr r rvryr|rC staticmethodrr __classcell__r=r=r;r>r*s$    (& $r)+r/argparsertypingrrrrrr lightning_utilities.core.importsr torchr torch.nnr typing_extensionsr lightning_fabric.loggers.loggerr r#lightning_fabric.utilities.cloud_iorr!lightning_fabric.utilities.loggerrrrrr$lightning_fabric.utilities.rank_zerorr lightning_fabric.utilities.typesrlightning_fabric.wrappersrr)r*rNrrrr=r=r=r>s*