Source code for pytorch_lightning.accelerators.cpu

# 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
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# See the License for the specific language governing permissions and
# limitations under the License.
from typing import Any, Dict, List, Union

import torch

from pytorch_lightning.accelerators.accelerator import Accelerator
from pytorch_lightning.utilities.device_parser import parse_cpu_cores
from pytorch_lightning.utilities.exceptions import MisconfigurationException
from pytorch_lightning.utilities.imports import _PSUTIL_AVAILABLE
from pytorch_lightning.utilities.types import _DEVICE

[docs]class CPUAccelerator(Accelerator): """Accelerator for CPU devices."""
[docs] def setup_environment(self, root_device: torch.device) -> None: """ Raises: MisconfigurationException: If the selected device is not CPU. """ super().setup_environment(root_device) if root_device.type != "cpu": raise MisconfigurationException(f"Device should be CPU, got {root_device} instead.")
[docs] def get_device_stats(self, device: _DEVICE) -> Dict[str, Any]: """Get CPU stats from ``psutil`` package.""" return get_cpu_stats()
[docs] @staticmethod def parse_devices(devices: Union[int, str, List[int]]) -> int: """Accelerator device parsing logic.""" devices = parse_cpu_cores(devices) return devices
[docs] @staticmethod def get_parallel_devices(devices: Union[int, str, List[int]]) -> List[torch.device]: """Gets parallel devices for the Accelerator.""" devices = parse_cpu_cores(devices) return [torch.device("cpu")] * devices
[docs] @staticmethod def auto_device_count() -> int: """Get the devices when set to auto.""" return 1
[docs] @staticmethod def is_available() -> bool: """CPU is always available for execution.""" return True
@classmethod def register_accelerators(cls, accelerator_registry: Dict) -> None: accelerator_registry.register( "cpu", cls, description=f"{cls.__class__.__name__}", )
# CPU device metrics _CPU_VM_PERCENT = "cpu_vm_percent" _CPU_PERCENT = "cpu_percent" _CPU_SWAP_PERCENT = "cpu_swap_percent" def get_cpu_stats() -> Dict[str, float]: if not _PSUTIL_AVAILABLE: raise ModuleNotFoundError( "Fetching CPU device stats requires `psutil` to be installed." " Install it by running `pip install -U psutil`." ) import psutil return { _CPU_VM_PERCENT: psutil.virtual_memory().percent, _CPU_PERCENT: psutil.cpu_percent(), _CPU_SWAP_PERCENT: psutil.swap_memory().percent, }

© Copyright Copyright (c) 2018-2023, Lightning AI et al...

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