105 lines
4.0 KiB
Python
105 lines
4.0 KiB
Python
# Copyright The PyTorch Lightning team.
|
|
#
|
|
# Licensed under the Apache License, Version 2.0 (the "License");
|
|
# you may not use this file except in compliance with the License.
|
|
# You may obtain a copy of the License at
|
|
#
|
|
# http://www.apache.org/licenses/LICENSE-2.0
|
|
#
|
|
# Unless required by applicable law or agreed to in writing, software
|
|
# distributed under the License is distributed on an "AS IS" BASIS,
|
|
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
# See the License for the specific language governing permissions and
|
|
# limitations under the License.
|
|
"""
|
|
Device Stats Monitor
|
|
====================
|
|
|
|
Monitors and logs device stats during training.
|
|
|
|
"""
|
|
from typing import Any, Dict, Optional
|
|
|
|
import pytorch_lightning as pl
|
|
from pytorch_lightning.callbacks.base import Callback
|
|
from pytorch_lightning.utilities.exceptions import MisconfigurationException
|
|
from pytorch_lightning.utilities.types import STEP_OUTPUT
|
|
from pytorch_lightning.utilities.warnings import rank_zero_deprecation
|
|
|
|
|
|
class DeviceStatsMonitor(Callback):
|
|
r"""
|
|
Automatically monitors and logs device stats during training stage. ``DeviceStatsMonitor``
|
|
is a special callback as it requires a ``logger`` to passed as argument to the ``Trainer``.
|
|
|
|
Raises:
|
|
MisconfigurationException:
|
|
If ``Trainer`` has no logger.
|
|
|
|
Example:
|
|
>>> from pytorch_lightning import Trainer
|
|
>>> from pytorch_lightning.callbacks import DeviceStatsMonitor
|
|
>>> device_stats = DeviceStatsMonitor() # doctest: +SKIP
|
|
>>> trainer = Trainer(callbacks=[device_stats]) # doctest: +SKIP
|
|
"""
|
|
|
|
def setup(self, trainer: "pl.Trainer", pl_module: "pl.LightningModule", stage: Optional[str] = None) -> None:
|
|
if not trainer.loggers:
|
|
raise MisconfigurationException("Cannot use DeviceStatsMonitor callback with Trainer that has no logger.")
|
|
|
|
def on_train_batch_start(
|
|
self,
|
|
trainer: "pl.Trainer",
|
|
pl_module: "pl.LightningModule",
|
|
batch: Any,
|
|
batch_idx: int,
|
|
unused: int = 0,
|
|
) -> None:
|
|
if not trainer.loggers:
|
|
raise MisconfigurationException("Cannot use `DeviceStatsMonitor` callback with `Trainer(logger=False)`.")
|
|
|
|
if not trainer._logger_connector.should_update_logs:
|
|
return
|
|
|
|
device = trainer.strategy.root_device
|
|
device_stats = trainer.accelerator.get_device_stats(device)
|
|
for logger in trainer.loggers:
|
|
separator = logger.group_separator
|
|
prefixed_device_stats = _prefix_metric_keys(device_stats, "on_train_batch_start", separator)
|
|
logger.log_metrics(prefixed_device_stats, step=trainer.fit_loop.epoch_loop._batches_that_stepped)
|
|
|
|
def on_train_batch_end(
|
|
self,
|
|
trainer: "pl.Trainer",
|
|
pl_module: "pl.LightningModule",
|
|
outputs: STEP_OUTPUT,
|
|
batch: Any,
|
|
batch_idx: int,
|
|
unused: int = 0,
|
|
) -> None:
|
|
if not trainer.loggers:
|
|
raise MisconfigurationException("Cannot use `DeviceStatsMonitor` callback with `Trainer(logger=False)`.")
|
|
|
|
if not trainer._logger_connector.should_update_logs:
|
|
return
|
|
|
|
device = trainer.strategy.root_device
|
|
device_stats = trainer.accelerator.get_device_stats(device)
|
|
for logger in trainer.loggers:
|
|
separator = logger.group_separator
|
|
prefixed_device_stats = _prefix_metric_keys(device_stats, "on_train_batch_end", separator)
|
|
logger.log_metrics(prefixed_device_stats, step=trainer.fit_loop.epoch_loop._batches_that_stepped)
|
|
|
|
|
|
def _prefix_metric_keys(metrics_dict: Dict[str, float], prefix: str, separator: str) -> Dict[str, float]:
|
|
return {prefix + separator + k: v for k, v in metrics_dict.items()}
|
|
|
|
|
|
def prefix_metric_keys(metrics_dict: Dict[str, float], prefix: str) -> Dict[str, float]:
|
|
rank_zero_deprecation(
|
|
"`pytorch_lightning.callbacks.device_stats_monitor.prefix_metrics`"
|
|
" is deprecated in v1.6 and will be removed in v1.8."
|
|
)
|
|
sep = ""
|
|
return _prefix_metric_keys(metrics_dict, prefix, sep)
|