pytorch_lightning.loggers.comet module¶

Comet¶

class pytorch_lightning.loggers.comet.CometLogger(api_key=None, save_dir=None, workspace=None, project_name=None, rest_api_key=None, experiment_name=None, experiment_key=None, **kwargs)[source]¶

Bases: pytorch_lightning.loggers.base.LightningLoggerBase

Log using Comet.ml. Install it with pip:

pip install comet-ml

Comet requires either an API Key (online mode) or a local directory path (offline mode).

ONLINE MODE

Example

>>> 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'),
...     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_name='default'  # Optional
... )
>>> trainer = Trainer(logger=comet_logger)

OFFLINE MODE

Example

>>> from pytorch_lightning.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='default'  # Optional
... )
>>> trainer = Trainer(logger=comet_logger)

Parameters

api_key¶ (Optional[str]) – Required in online mode. API key, found on Comet.ml
save_dir¶ (Optional[str]) – Required in offline mode. The path for the directory to save local comet logs
workspace¶ (Optional[str]) – Optional. Name of workspace for this user
project_name¶ (Optional[str]) – 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[str]) – Optional. Rest API key found in Comet.ml settings. This is used to determine version number
experiment_name¶ (Optional[str]) – Optional. String representing the name for this particular experiment on Comet.ml.
experiment_key¶ (Optional[str]) – Optional. If set, restores from existing experiment.

finalize(status)[source]¶

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 CometLogger.finalize() is called.

This happens automatically in the experiment() property, when self._experiment is set to None, i.e. self.reset_experiment().

Return type: None

log_hyperparams(params)[source]¶

Record hyperparameters.

Parameters: params¶ (Union[Dict[str, Any], Namespace]) – Namespace containing the hyperparameters
Return type: None

log_metrics(metrics, step=None)[source]¶

Records metrics. This method logs metrics as as soon as it received them. If you want to aggregate metrics for one specific step, use the agg_and_log_metrics() method.

Parameters

metrics¶ (Dict[str, Union[Tensor, float]]) – Dictionary with metric names as keys and measured quantities as values
step¶ (Optional[int]) – Step number at which the metrics should be recorded

Return type

None

reset_experiment()[source]¶

property experiment[source]¶

Actual Comet object. To use Comet features in your LightningModule do the following.

Example:

self.logger.experiment.some_comet_function()

Return type: BaseExperiment

property name[source]¶

Return the experiment name.

Return type: str

property save_dir[source]¶

Return the root directory where experiment logs get saved, or None if the logger does not save data locally.

Return type: Optional[str]

property version[source]¶

Return the experiment version.

Return type: str