Skip to content

device

getDevice(device=None)

Get cpu, gpu or mps device for training. Args: device (str): Device for training. If None or “auto” the device is selected automatically.

Returns:

Name Type Description
device str

Device for training.

Examples:

>>> from spotPython.utils.device import getDevice
>>> getDevice()
'cuda:0'
Source code in spotPython/utils/device.py 
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
def getDevice(device=None):
    """Get cpu, gpu or mps device for training.
    Args:
        device (str):
            Device for training. If None or "auto" the device is selected automatically.

    Returns:
        device (str):
            Device for training.

    Examples:
        >>> from spotPython.utils.device import getDevice
        >>> getDevice()
        'cuda:0'
    """
    if device is None or device == "auto":
        device = "cpu"
        if torch.cuda.is_available():
            device = "cuda:0"
        elif torch.backends.mps.is_available():
            device = "mps"
    return device