Skip to content

qttools.profiling.utils#

[docs] module qttools.profiling.utils 

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
# Copyright (c) 2024 ETH Zurich and the authors of the qttools package.

from typing import Callable

from qttools import xp


def decorate_methods(
    decorator: Callable,
    exclude: list[str] | None = None,
) -> Callable:
    """Apply a decorator to multiple methods of a class.

    Parameters
    ----------
    decorator : Callable
        The decorator to apply to the methods.
    exclude : list[str] | None, optional
        A list of method names to exclude from decoration. By default
        all methods are decorated.

    Returns
    -------
    Callable
        A class decorator that applies the decorator to all methods of the class.

    """
    if exclude is None:
        exclude = []

    def decorate(cls):
        for attr in cls.__dict__:
            if callable(getattr(cls, attr)) and attr not in exclude:
                setattr(cls, attr, decorator(getattr(cls, attr)))
        return cls

    return decorate


def get_cuda_devices(return_names: bool = False):
    """Returns the list of available CUDA devices.

    Parameters
    ----------
    return_names
        If the device names should be written out.

    Returns
    ----------
    list
        List of available devices
    """
    if xp.__name__ != "cupy":
        return []
    num_devices = xp.cuda.runtime.getDeviceCount()
    if return_names:
        return [f"cuda:{i}" for i in range(num_devices)]

    return list(range(num_devices))