121 lines
3.3 KiB
Python
121 lines
3.3 KiB
Python
"""
|
|
Log using `mlflow <https://mlflow.org>'_
|
|
|
|
.. code-block:: python
|
|
|
|
from pytorch_lightning.loggers import MLFlowLogger
|
|
mlf_logger = MLFlowLogger(
|
|
experiment_name="default",
|
|
tracking_uri="file:/."
|
|
)
|
|
trainer = Trainer(logger=mlf_logger)
|
|
|
|
|
|
Use the logger anywhere in you LightningModule as follows:
|
|
|
|
.. code-block:: python
|
|
|
|
def train_step(...):
|
|
# example
|
|
self.logger.experiment.whatever_ml_flow_supports(...)
|
|
|
|
def any_lightning_module_function_or_hook(...):
|
|
self.logger.experiment.whatever_ml_flow_supports(...)
|
|
|
|
"""
|
|
import argparse
|
|
from logging import getLogger
|
|
from time import time
|
|
from typing import Optional, Dict, Any
|
|
|
|
try:
|
|
import mlflow
|
|
except ImportError:
|
|
raise ImportError('Missing mlflow package.')
|
|
|
|
from .base import LightningLoggerBase, rank_zero_only
|
|
|
|
logger = getLogger(__name__)
|
|
|
|
|
|
class MLFlowLogger(LightningLoggerBase):
|
|
def __init__(self, experiment_name: str, tracking_uri: Optional[str] = None,
|
|
tags: Dict[str, Any] = None):
|
|
r"""
|
|
|
|
Logs using MLFlow
|
|
|
|
Args:
|
|
experiment_name (str): The name of the experiment
|
|
tracking_uri (str): where this should track
|
|
tags (dict): todo this param
|
|
"""
|
|
super().__init__()
|
|
self._mlflow_client = mlflow.tracking.MlflowClient(tracking_uri)
|
|
self.experiment_name = experiment_name
|
|
self._run_id = None
|
|
self.tags = tags
|
|
|
|
@property
|
|
def experiment(self) -> mlflow.tracking.MlflowClient:
|
|
r"""
|
|
|
|
Actual mlflow object. To use mlflow features do the following.
|
|
|
|
Example::
|
|
|
|
self.logger.experiment.some_mlflow_function()
|
|
|
|
"""
|
|
return self._mlflow_client
|
|
|
|
@property
|
|
def run_id(self):
|
|
if self._run_id is not None:
|
|
return self._run_id
|
|
|
|
expt = self._mlflow_client.get_experiment_by_name(self.experiment_name)
|
|
|
|
if expt:
|
|
self._expt_id = expt.experiment_id
|
|
else:
|
|
logger.warning(f"Experiment with name {self.experiment_name} not found. Creating it.")
|
|
self._expt_id = self._mlflow_client.create_experiment(name=self.experiment_name)
|
|
|
|
run = self._mlflow_client.create_run(experiment_id=self._expt_id, tags=self.tags)
|
|
self._run_id = run.info.run_id
|
|
return self._run_id
|
|
|
|
@rank_zero_only
|
|
def log_hyperparams(self, params: argparse.Namespace):
|
|
for k, v in vars(params).items():
|
|
self.experiment.log_param(self.run_id, k, v)
|
|
|
|
@rank_zero_only
|
|
def log_metrics(self, metrics: Dict[str, float], step: Optional[int] = None):
|
|
timestamp_ms = int(time() * 1000)
|
|
for k, v in metrics.items():
|
|
if isinstance(v, str):
|
|
logger.warning(
|
|
f"Discarding metric with string value {k}={v}"
|
|
)
|
|
continue
|
|
self.experiment.log_metric(self.run_id, k, v, timestamp_ms, step)
|
|
|
|
def save(self):
|
|
pass
|
|
|
|
@rank_zero_only
|
|
def finalize(self, status: str = "FINISHED"):
|
|
if status == 'success':
|
|
status = 'FINISHED'
|
|
self.experiment.set_terminated(self.run_id, status)
|
|
|
|
@property
|
|
def name(self) -> str:
|
|
return self.experiment_name
|
|
|
|
@property
|
|
def version(self) -> str:
|
|
return self._run_id
|