Shortcuts

Source code for pytorch_lightning.accelerators.gpu

# 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.
import logging
import os
import shutil
import subprocess
from typing import Any, Dict, List, Union

import torch

import pytorch_lightning as pl
from pytorch_lightning.accelerators.accelerator import Accelerator
from pytorch_lightning.utilities.exceptions import MisconfigurationException
from pytorch_lightning.utilities.imports import _TORCH_GREATER_EQUAL_1_8

_log = logging.getLogger(__name__)


[docs]class GPUAccelerator(Accelerator): """Accelerator for GPU devices."""
[docs] def setup_environment(self) -> None: """ Raises: MisconfigurationException: If the selected device is not GPU. """ super().setup_environment() if "cuda" not in str(self.root_device): raise MisconfigurationException(f"Device should be GPU, got {self.root_device} instead") torch.cuda.set_device(self.root_device)
[docs] def setup(self, trainer: "pl.Trainer") -> None: self.set_nvidia_flags(trainer.local_rank) return super().setup(trainer)
[docs] def on_train_start(self) -> None: super().on_train_start() # clear cache before training torch.cuda.empty_cache()
@staticmethod def set_nvidia_flags(local_rank: int) -> None: # set the correct cuda visible devices (using pci order) os.environ["CUDA_DEVICE_ORDER"] = "PCI_BUS_ID" all_gpu_ids = ",".join(str(x) for x in range(torch.cuda.device_count())) devices = os.getenv("CUDA_VISIBLE_DEVICES", all_gpu_ids) _log.info(f"LOCAL_RANK: {local_rank} - CUDA_VISIBLE_DEVICES: [{devices}]")
[docs] def get_device_stats(self, device: Union[str, torch.device]) -> Dict[str, Any]: """Gets stats for the given GPU device. Args: device: GPU device for which to get stats Returns: A dictionary mapping the metrics to their values. Raises: FileNotFoundError: If nvidia-smi installation not found """ if _TORCH_GREATER_EQUAL_1_8: return torch.cuda.memory_stats(device) return _get_nvidia_gpu_stats(device)
[docs] def teardown(self) -> None: super().teardown() self._move_optimizer_state(torch.device("cpu"))
[docs] @staticmethod def auto_device_count() -> int: """Get the devices when set to auto.""" return torch.cuda.device_count()
def _get_nvidia_gpu_stats(device: torch.device) -> Dict[str, float]: """Get GPU stats including memory, fan speed, and temperature from nvidia-smi. Args: device: GPU device for which to get stats Returns: A dictionary mapping the metrics to their values. Raises: FileNotFoundError: If nvidia-smi installation not found """ gpu_stat_metrics = [ ("utilization.gpu", "%"), ("memory.used", "MB"), ("memory.free", "MB"), ("utilization.memory", "%"), ("fan.speed", "%"), ("temperature.gpu", "°C"), ("temperature.memory", "°C"), ] gpu_stat_keys = [k for k, _ in gpu_stat_metrics] gpu_query = ",".join(gpu_stat_keys) gpu_id = _get_gpu_id(device.index) nvidia_smi_path = shutil.which("nvidia-smi") if nvidia_smi_path is None: raise FileNotFoundError("nvidia-smi: command not found") result = subprocess.run( [nvidia_smi_path, f"--query-gpu={gpu_query}", "--format=csv,nounits,noheader", f"--id={gpu_id}"], encoding="utf-8", stdout=subprocess.PIPE, stderr=subprocess.PIPE, # for backward compatibility with python version 3.6 check=True, ) def _to_float(x: str) -> float: try: return float(x) except ValueError: return 0.0 s = result.stdout.strip() stats = [_to_float(x) for x in s.split(", ")] gpu_stats = {} for i, (x, unit) in enumerate(gpu_stat_metrics): gpu_stats[f"{x} ({unit})"] = stats[i] return gpu_stats def _get_gpu_id(device_id: int) -> str: """Get the unmasked real GPU IDs.""" # All devices if `CUDA_VISIBLE_DEVICES` unset default = ",".join(str(i) for i in range(torch.cuda.device_count())) cuda_visible_devices: List[str] = os.getenv("CUDA_VISIBLE_DEVICES", default=default).split(",") return cuda_visible_devices[device_id].strip()

© Copyright Copyright (c) 2018-2023, William Falcon et al...

Built with Sphinx using a theme provided by Read the Docs.