o 9wi=@sdZddlZddlZddlmZddlmZmZmZm Z m Z m Z ddl m Z ddlmZddlmZddlmZdd lmZmZmZdd lmZmZdd lmZdd lmZerbdd lm Z m!Z!m"Z"e#e$Z%e dddZ&GdddeZ'dS)z Comet Logger ------------ N) Namespace) TYPE_CHECKINGAnyDictMappingOptionalUnion)RequirementCache)Tensor)Module)override) _add_prefix_convert_params _flatten_dict)Loggerrank_zero_experiment)MisconfigurationException)rank_zero_onlyExistingExperiment ExperimentOfflineExperimentzcomet-ml>=3.31.0comet_ml)modulecseZdZdZdZ        d-deedeedeed eed eed eed ed edeffdd Z e e de dfddZ eede eeefefddfddZeed.deee eeffdeeddfddZd/ddZeededdfdd Ze edeefd!d"Ze edefd#d$Ze edefd%d&Zdeeeffd'd(Zed.d)ed*eeddfd+d,ZZ S)0 CometLoggeraTrack your parameters, metrics, source code and more using `Comet `_. Install it with pip: .. code-block:: bash pip install comet-ml Comet requires either an API Key (online mode) or a local directory path (offline mode). **ONLINE MODE** .. code-block:: python import os from lightning.pytorch import Trainer from lightning.pytorch.loggers import CometLogger # arguments made to CometLogger are passed on to the comet_ml.Experiment class comet_logger = CometLogger( api_key=os.environ.get("COMET_API_KEY"), workspace=os.environ.get("COMET_WORKSPACE"), # Optional save_dir=".", # Optional project_name="default_project", # Optional rest_api_key=os.environ.get("COMET_REST_API_KEY"), # Optional experiment_key=os.environ.get("COMET_EXPERIMENT_KEY"), # Optional experiment_name="lightning_logs", # Optional ) trainer = Trainer(logger=comet_logger) **OFFLINE MODE** .. code-block:: python from lightning.pytorch.loggers import CometLogger # arguments made to CometLogger are passed on to the comet_ml.Experiment class comet_logger = CometLogger( save_dir=".", workspace=os.environ.get("COMET_WORKSPACE"), # Optional project_name="default_project", # Optional rest_api_key=os.environ.get("COMET_REST_API_KEY"), # Optional experiment_name="lightning_logs", # Optional ) trainer = Trainer(logger=comet_logger) **Log Hyperparameters:** Log parameters used to initialize a :class:`~lightning.pytorch.core.LightningModule`: .. code-block:: python class LitModule(LightningModule): def __init__(self, *args, **kwarg): self.save_hyperparameters() Log other Experiment Parameters .. code-block:: python # log a single parameter logger.log_hyperparams({"batch_size": 16}) # log multiple parameters logger.log_hyperparams({"batch_size": 16, "learning_rate": 0.001}) **Log Metrics:** .. code-block:: python # log a single metric logger.log_metrics({"train/loss": 0.001}) # add multiple metrics logger.log_metrics({"train/loss": 0.001, "val/loss": 0.002}) **Access the Comet Experiment object:** You can gain access to the underlying Comet `Experiment `__ object and its methods through the :obj:`logger.experiment` property. This will let you use the additional logging features provided by the Comet SDK. Some examples of data you can log through the Experiment object: Log Image data: .. code-block:: python img = PIL.Image.open("") logger.experiment.log_image(img, file_name="my_image.png") Log Text data: .. code-block:: python text = "Lightning is awesome!" logger.experiment.log_text(text) Log Audio data: .. code-block:: python audio = "" logger.experiment.log_audio(audio, file_name="my_audio.wav") Log arbitrary data assets: You can log any type of data to Comet as an asset. These can be model checkpoints, datasets, debug logs, etc. .. code-block:: python logger.experiment.log_asset("", file_name="my_data.pkl") Log Models to Comet's Model Registry: .. code-block:: python logger.experiment.log_model(name="my-model", "") See Also: - `Demo in Google Colab `__ - `Comet Documentation `__ Args: api_key: Required in online mode. API key, found on Comet.ml. If not given, this will be loaded from the environment variable COMET_API_KEY or ~/.comet.config if either exists. save_dir: Required in offline mode. The path for the directory to save local comet logs. If given, this also sets the directory for saving checkpoints. project_name: Optional. Send your experiment to a specific project. Otherwise will be sent to Uncategorized Experiments. If the project name does not already exist, Comet.ml will create a new project. rest_api_key: Optional. Rest API key found in Comet.ml settings. This is used to determine version number experiment_name: Optional. String representing the name for this particular experiment on Comet.ml. experiment_key: Optional. If set, restores from existing experiment. offline: If api_key and save_dir are both given, this determines whether the experiment will be in online or offline mode. This is useful if you use save_dir to control the checkpoints directory and have a ~/.comet.config file but still want to run offline experiments. prefix: A string to put at the beginning of metric keys. \**kwargs: Additional arguments like `workspace`, `log_code`, etc. used by :class:`CometExperiment` can be passed as keyword arguments in this logger. Raises: ModuleNotFoundError: If required Comet package is not installed on the device. MisconfigurationException: If neither ``api_key`` nor ``save_dir`` are passed as arguments. -NFapi_keysave_dir project_name rest_api_keyexperiment_nameexperiment_keyofflineprefixkwargsc  s*tsttttd|_||dtjd<ddl} |p(| j d| j }|dur?|dur?|r5dnd|_ ||_ ||_n|durMd|_ ||_ d|_n|durXd|_ ||_ntdtd|j d||_||_||_||_| |_d|_|durdd lm} ||_| |j|_dSd|_d|_dS) N1COMET_DISABLE_AUTO_LOGGINGrr#onlinezFCometLogger requires either api_key or save_dir during initialization.z#CometLogger will be initialized in z mode)API)_COMET_AVAILABLEModuleNotFoundErrorstrsuper__init__ _experimentosenvironrconfig get_api_key get_configmoder _save_dirrloginfo _project_name_experiment_key_experiment_name_prefix_kwargs_future_experiment_key comet_ml.apir)r comet_api) selfrrrr r!r"r#r$r%rr) __class__\/home/ubuntu/sommelier/.venv/lib/python3.10/site-packages/lightning/pytorch/loggers/comet.pyr.sD     zCometLogger.__init__return)rrrc Cs&|jdur |jjr |jS|jdur|jtjd<ddlm}m}m}zU|j dkrR|j durA|d |j |j d|j |_|j|_ n|d |j |j |j d|j |_n|d |j|j d|j |_|jd d W|jdurvtjdd|_n|jdurtjdd|_w|jr|j|j|jS) zActual Comet object. To use Comet features in your :class:`~lightning.pytorch.core.LightningModule` do the following. Example:: self.logger.experiment.some_comet_function() NCOMET_EXPERIMENT_KEYrrr()rr)rrprevious_experiment)offline_directoryrz Created fromzpytorch-lightningrD)r/aliver>r0r1rrrrr5r:rr9r=get_keyr log_otherpopr;set_name)rArrrrDrDrE experimentsB         zCometLogger.experimentparamscCs t|}t|}|j|dSN)rrrOlog_parameters)rArPrDrDrElog_hyperparams2szCometLogger.log_hyperparamsmetricsstepcCsxtjdks Jd|}|D]\}}t|tr"|||<q|dd}t ||j |j }|j j |||ddS)Nrz-experiment tried to log from global_rank != 0epoch)rUrV)rrankcopyitems isinstancer cpudetachrMr r<LOGGER_JOIN_CHARrO log_metrics)rArTrUmetrics_without_epochkeyvalrVrDrDrEr^9s  zCometLogger.log_metricscCs d|_dSrQ)r/rArDrDrEreset_experimentGs zCometLogger.reset_experimentstatuscCs$|jdurdS|j|dS)a When calling ``self.experiment.end()``, that experiment won't log any more data to Comet. That's why, if you need to log any more data, you need to create an ExistingCometExperiment. For example, to log data when testing your model after training, because when training is finalized :meth:`CometLogger.finalize` is called. This happens automatically in the :meth:`~CometLogger.experiment` property, when ``self._experiment`` is set to ``None``, i.e. ``self.reset_experiment()``. N)r/rOendrc)rArdrDrDrEfinalizeJs   zCometLogger.finalizecCs|jS)z`Gets the save directory. Returns: The path to the save directory. )r6rbrDrDrEr\s zCometLogger.save_dircCs2|jdur|jjdur|jjS|jdur|jSdS)zyGets the project name. Returns: The project name if it is specified, else "comet-default". Nz comet-default)r/rr9rbrDrDrEnamegs   zCometLogger.namecCs^|jdur |jjS|jdur|jSdtjvrtjdS|jdur#|jSddl}||_|jS)aRGets the version. Returns: The first one of the following that is set in the following order 1. experiment id. 2. experiment key. 3. "COMET_EXPERIMENT_KEY" environment variable. 4. future experiment key. If none are present generates a new guid. NrGr)r/idr:r0r1r>r generate_guid)rArrDrDrEversionys      zCometLogger.versioncCs0|j}|jdur|jjnd|d<d|d<|S)Nr:r/)__dict__rXr/rh)rAstaterDrDrE __getstate__s zCometLogger.__getstate__model input_arraycCs|jdur |j|dSdSrQ)r/set_model_graph)rArnrorDrDrE log_graphs zCometLogger.log_graph)NNNNNNFrrQ)rFN)!__name__ __module__ __qualname____doc__r]rr,boolrr.propertyrrrOr rrrrSrr floatintr^rcrfrrgrjrmr rq __classcell__rDrDrBrEr)sp  =,&0  "&r)(ruloggingr0argparsertypingrrrrrr lightning_utilities.core.importsr torchr torch.nnr typing_extensionsr !lightning.fabric.utilities.loggerr rr lightning.pytorch.loggers.loggerrr&lightning.pytorch.utilities.exceptionsr%lightning.pytorch.utilities.rank_zerorrrrr getLoggerrrr7r*rrDrDrDrEs$