o 8wi;@sdZddlZddlZddlmZddlmZddlmZm Z m Z m Z m Z ddl mZddlmZddlmZdd lmZdd lmZdd lmZdd lmZmZdd lmZerbddlmZm Z m!Z!e"e#Z$edddZ%dZ&e dZ'GdddeZ(dS)z Comet Logger ------------ N) Namespace)Mapping) TYPE_CHECKINGAnyLiteralOptionalUnion)RequirementCache)Tensor)Module)override)_convert_params) _get_rank)Loggerrank_zero_experiment)rank_zero_only)ExistingExperiment ExperimentOfflineExperimentzcomet-ml>=3.44.4comet_ml)modulezpytorch-lightning)rrrcseZdZdZdddddddddeedeedeedeedeed d eed eed effd dZ d*ddZ e e de fddZeedeeeefefddfddZeed+deeeeeffdeeddfddZeededdfddZe edeefddZe edeefd d!Ze edeefd"d#Zdeeeffd$d%Zed+d&ed'eeddfd(d)Z Z!S), 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 pytorch_lightning import Trainer from pytorch_lightning.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"), # Optional workspace=os.environ.get("COMET_WORKSPACE"), # Optional project="default_project", # Optional experiment_key=os.environ.get("COMET_EXPERIMENT_KEY"), # Optional name="lightning_logs", # Optional ) trainer = Trainer(logger=comet_logger) **OFFLINE MODE** .. code-block:: python from pytorch_lightning.loggers import CometLogger # arguments made to CometLogger are passed on to the comet_ml.Experiment class comet_logger = CometLogger( workspace=os.environ.get("COMET_WORKSPACE"), # Optional project="default_project", # Optional name="lightning_logs", # Optional online=False ) trainer = Trainer(logger=comet_logger) **Log Hyperparameters:** Log parameters used to initialize a :class:`~pytorch_lightning.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 nested parameters logger.log_hyperparams({"specific": {'param': {'subparam': "value"}}}) **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}) # add nested metrics logger.log_metrics({"specific": {'metric': {'submetric': "value"}}}) **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: Comet API key. It's recommended to configure the API Key with `comet login`. workspace: Comet workspace name. If not provided, uses the default workspace. project: Comet project name. Defaults to `Uncategorized`. experiment_key: The Experiment identifier to be used for logging. This is used either to append data to an Existing Experiment or to control the key of new experiments (for example to match another identifier). Must be an alphanumeric string whose length is between 32 and 50 characters. mode: Control how the Comet experiment is started. * ``"get_or_create"``: Starts a fresh experiment if required, or persists logging to an existing one. * ``"get"``: Continue logging to an existing experiment identified by the ``experiment_key`` value. * ``"create"``: Always creates of a new experiment, useful for HPO sweeps. online: If True, the data will be logged to Comet server, otherwise it will be stored locally in an offline experiment. Default is ``True``. prefix: The prefix to add to names of the logged metrics. example: prefix=`exp1`, then metric name will be logged as `exp1_metric_name` **kwargs: Additional arguments like `name`, `log_code`, `offline_directory` 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. N)api_key workspaceprojectexperiment_keymodeonlineprefixrrrrr) get_or_creategetcreaterrkwargsc  s~tsttttd|vr)td|d} d|vr$| |d<ntdd|vrAtd|dur<|d}ntdd|vrYtd |durT|d}ntd d |vrstd d |vrn|d |d <ntd||_d|_ ||_ ||_ ||_ ||_ ||_||_||_dtjd<ddl} |j} |durd| d<| jdi| |_tdurtdkrdS|dS)Nexperiment_namezIThe parameter `experiment_name` is deprecated, please use `name` instead.namezRYou specified both `experiment_name` and `name` parameters, please use `name` only project_namezIThe parameter `project_name` is deprecated, please use `project` instead.zUYou specified both `project_name` and `project` parameters, please use `project` onlyofflinezBThe parameter `offline is deprecated, please use `online` instead.zNYou specified both `offline` and `online` parameters, please use `online` onlysave_dirzOThe parameter `save_dir` is deprecated, please use `offline_directory` instead.offline_directoryzeYou specified both `save_dir` and `offline_directory` parameters, please use `offline_directory` only1COMET_DISABLE_AUTO_LOGGINGrFTdisabled)_COMET_AVAILABLEModuleNotFoundErrorstrsuper__init__logwarningpop_api_key _experiment _workspace_mode_online _project_name_experiment_key_prefix_kwargsosenvironrcopyExperimentConfig _comet_configr_create_experiment) selfrrrrrrrr"r#r config_kwargs __class__r,\/home/ubuntu/sommelier/.venv/lib/python3.10/site-packages/pytorch_lightning/loggers/comet.pyr1sX                zCometLogger.__init__returnc Csnddl}|j|j|j|j|j|j|j|jd|_ |j dur#|j d|j |_|j j |_|j dtdS)Nr)rrrrrrexperiment_configz"Failed to create Comet experiment.z Created from)rstartr5r7r:r;r8r9rBr6 exceptionsExperimentNotFoundget_keyr% log_otherFRAMEWORK_NAME)rDrr,r,rHrCs   zCometLogger._create_experimentcCs|js||jS)zActual Comet object. To use Comet features in your :class:`~pytorch_lightning.core.LightningModule` do the following. Example:: self.logger.experiment.some_comet_function() )r6rCrDr,r,rH experiment0szCometLogger.experimentparamscCs t|}|jj|tddddS)NTmanual) parameters frameworkflatten_nestedsource)r rR __internal_api__log_parameters__rP)rDrSr,r,rHlog_hyperparamsCs zCometLogger.log_hyperparamsmetricsstepcCsntjdks Jd|}|D]\}}t|tr"|||<q|dd}|j j ||||j t ddS)Nrz-experiment tried to log from global_rank != 0epoch)r\r]rrV) rrankr@items isinstancer cpudetachr4rR__internal_api__log_metrics__r<rP)rDr[r\metrics_without_epochkeyvalr]r,r,rH log_metricsNs   zCometLogger.log_metricsstatuscCs|jdurdS|jdS)zWe will not end experiment (will not call self._experiment.end()) here to have an ability to continue using it after training is complete but instead of ending we will upload/save all the data.N)r6rRflush)rDrhr,r,rHfinalizeas zCometLogger.finalizecCs|jjS)z`Gets the save directory. Returns: The path to the save directory. )rBr(rQr,r,rHr'ns zCometLogger.save_dircCs|jS)zcGets the project name. Returns: The project name if it is specified. )r:rQr,r,rHr$ys zCometLogger.namecCs|jdur |jSdS)zWGets the version. Returns: The experiment key if present N)r6rNrQr,r,rHversions zCometLogger.versioncCs2|j}|jdur|jnd|d<d|d<|S)Nr;r6)__dict__r@r6rN)rDstater,r,rH __getstate__s zCometLogger.__getstate__model input_arraycCs"|jdur|jj|tddSdS)N)graphrV)r6!__internal_api__set_model_graph__rP)rDrorpr,r,rH log_graphs  zCometLogger.log_graph)rIN)N)"__name__ __module__ __qualname____doc__rr/rboolrr1rCpropertyrcomet_experimentrRr rrdictrrZrr floatintrgrjr'r$rkrnr rs __classcell__r,r,rFrHr-sh    U& 0    &r))rwloggingr>argparsercollections.abcrtypingrrrrr lightning_utilities.core.importsr torchr torch.nnr typing_extensionsr !lightning_fabric.utilities.loggerr $lightning_fabric.utilities.rank_zeror pytorch_lightning.loggers.loggerrr%pytorch_lightning.utilities.rank_zerorrrrr getLoggerrtr2r-rPrzrr,r,r,rHs*