Skip to content

common

zeus.device.gpu.common

Error wrappers and classes common to all GPU vendors.

GPU

Bases: ABC

Abstract base class for managing one GPU.

For each method, child classes should call into vendor-specific GPU management libraries (e.g., NVML for NVIDIA GPUs).

Source code in zeus/device/gpu/common.py 
 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
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
class GPU(abc.ABC, metaclass=DeprecatedAliasABCMeta):
    """Abstract base class for managing one GPU.

    For each method, child classes should call into vendor-specific
    GPU management libraries (e.g., NVML for NVIDIA GPUs).
    """

    def __init__(self, gpu_index: int) -> None:
        """Initializ the GPU with a specified index."""
        self.gpu_index = gpu_index

    def _warn_sys_admin(self) -> None:
        """Warn the user if the current process doesn't have `SYS_ADMIN` privileges."""
        # Deriving classes can disable this warning by setting this attribute.
        if not getattr(self, "_disable_sys_admin_warning", False) and not has_sys_admin():
            warnings.warn(
                "You are about to call a GPU management API that requires "
                "`SYS_ADMIN` privileges. Some energy optimizers that change the "
                "GPU's power settings need this.\nSee "
                "https://ml.energy/zeus/getting_started/#system-privileges "
                "for more information and how to obtain `SYS_ADMIN`.",
                stacklevel=2,
            )
            # Only warn once.
            self._disable_sys_admin_warning = True

    @property
    @abc.abstractmethod
    def supports_nonblocking_setters(self) -> bool:
        """Return True if the GPU object supports non-blocking configuration setters."""
        return False

    @deprecated_alias("getName")
    @abc.abstractmethod
    def get_name(self) -> str:
        """Return the name of the GPU model."""
        pass

    @deprecated_alias("getPowerManagementLimitConstraints")
    @abc.abstractmethod
    def get_power_management_limit_constraints(self) -> tuple[int, int]:
        """Return the minimum and maximum power management limits. Units: mW."""
        pass

    @abc.abstractmethod
    def get_power_management_limit(self) -> int:
        """Return the current power management limit. Units: mW."""
        pass

    @deprecated_alias("setPowerManagementLimit")
    @abc.abstractmethod
    def set_power_management_limit(self, power_limit_mw: int, block: bool = True) -> None:
        """Set the GPU's power management limit. Unit: mW."""
        pass

    @deprecated_alias("resetPowerManagementLimit")
    @abc.abstractmethod
    def reset_power_management_limit(self, block: bool = True) -> None:
        """Reset the GPU's power management limit to the default value."""
        pass

    @deprecated_alias("setPersistenceMode")
    @abc.abstractmethod
    def set_persistence_mode(self, enabled: bool, block: bool = True) -> None:
        """Set persistence mode."""
        pass

    @abc.abstractmethod
    def get_persistence_mode(self) -> bool:
        """Return whether persistence mode is currently enabled."""
        pass

    @deprecated_alias("getSupportedMemoryClocks")
    @abc.abstractmethod
    def get_supported_memory_clocks(self) -> list[int]:
        """Return a list of supported memory clock frequencies. Units: MHz."""
        pass

    @deprecated_alias("setMemoryLockedClocks")
    @abc.abstractmethod
    def set_memory_locked_clocks(self, min_clock_mhz: int, max_clock_mhz: int, block: bool = True) -> None:
        """Lock the memory clock to a specified range. Units: MHz."""
        pass

    @deprecated_alias("resetMemoryLockedClocks")
    @abc.abstractmethod
    def reset_memory_locked_clocks(self, block: bool = True) -> None:
        """Reset the locked memory clocks to the default."""
        pass

    @deprecated_alias("getSupportedGraphicsClocks")
    @abc.abstractmethod
    def get_supported_graphics_clocks(self, memory_clock_mhz: int | None = None) -> list[int]:
        """Return a list of supported graphics clock frequencies. Units: MHz.

        Args:
            memory_clock_mhz: Memory clock frequency to use. Some GPUs have
                different supported graphics clocks depending on the memory clock.
        """
        pass

    @deprecated_alias("setGpuLockedClocks")
    @abc.abstractmethod
    def set_gpu_locked_clocks(self, min_clock_mhz: int, max_clock_mhz: int, block: bool = True) -> None:
        """Lock the GPU clock to a specified range. Units: MHz."""
        pass

    @deprecated_alias("resetGpuLockedClocks")
    @abc.abstractmethod
    def reset_gpu_locked_clocks(self, block: bool = True) -> None:
        """Reset the locked GPU clocks to the default."""
        pass

    @deprecated_alias("getAveragePowerUsage")
    @abc.abstractmethod
    def get_average_power_usage(self) -> int:
        """Return the average power usage of the GPU. Units: mW."""
        pass

    @deprecated_alias("getInstantPowerUsage")
    @abc.abstractmethod
    def get_instant_power_usage(self) -> int:
        """Return the current power draw of the GPU. Units: mW."""
        pass

    @deprecated_alias("getAverageMemoryPowerUsage")
    @abc.abstractmethod
    def get_average_memory_power_usage(self) -> int:
        """Return the average power usage of the GPU's memory. Units: mW."""
        pass

    @deprecated_alias("supportsGetTotalEnergyConsumption")
    @abc.abstractmethod
    def supports_get_total_energy_consumption(self) -> bool:
        """Check if the GPU supports retrieving total energy consumption."""
        pass

    @deprecated_alias("getTotalEnergyConsumption")
    @abc.abstractmethod
    def get_total_energy_consumption(self) -> int:
        """Return the total energy consumption of the GPU since driver load. Units: mJ."""
        pass

    @deprecated_alias("getGpuTemperature")
    @abc.abstractmethod
    def get_gpu_temperature(self) -> int:
        """Return the current GPU temperature. Units: Celsius."""
        pass

supports_nonblocking_setters abstractmethod property 

supports_nonblocking_setters

Return True if the GPU object supports non-blocking configuration setters.

__init__ 

__init__(gpu_index)
Source code in zeus/device/gpu/common.py 
23
24
25
def __init__(self, gpu_index: int) -> None:
    """Initializ the GPU with a specified index."""
    self.gpu_index = gpu_index

_warn_sys_admin 

_warn_sys_admin()

Warn the user if the current process doesn't have SYS_ADMIN privileges.

Source code in zeus/device/gpu/common.py 
27
28
29
30
31
32
33
34
35
36
37
38
39
40
def _warn_sys_admin(self) -> None:
    """Warn the user if the current process doesn't have `SYS_ADMIN` privileges."""
    # Deriving classes can disable this warning by setting this attribute.
    if not getattr(self, "_disable_sys_admin_warning", False) and not has_sys_admin():
        warnings.warn(
            "You are about to call a GPU management API that requires "
            "`SYS_ADMIN` privileges. Some energy optimizers that change the "
            "GPU's power settings need this.\nSee "
            "https://ml.energy/zeus/getting_started/#system-privileges "
            "for more information and how to obtain `SYS_ADMIN`.",
            stacklevel=2,
        )
        # Only warn once.
        self._disable_sys_admin_warning = True

get_name abstractmethod 

get_name()

Return the name of the GPU model.

Source code in zeus/device/gpu/common.py 
48
49
50
51
52
@deprecated_alias("getName")
@abc.abstractmethod
def get_name(self) -> str:
    """Return the name of the GPU model."""
    pass

get_power_management_limit_constraints abstractmethod 

get_power_management_limit_constraints()

Return the minimum and maximum power management limits. Units: mW.

Source code in zeus/device/gpu/common.py 
54
55
56
57
58
@deprecated_alias("getPowerManagementLimitConstraints")
@abc.abstractmethod
def get_power_management_limit_constraints(self) -> tuple[int, int]:
    """Return the minimum and maximum power management limits. Units: mW."""
    pass

get_power_management_limit abstractmethod 

get_power_management_limit()

Return the current power management limit. Units: mW.

Source code in zeus/device/gpu/common.py 
60
61
62
63
@abc.abstractmethod
def get_power_management_limit(self) -> int:
    """Return the current power management limit. Units: mW."""
    pass

set_power_management_limit abstractmethod 

set_power_management_limit(power_limit_mw, block=True)

Set the GPU's power management limit. Unit: mW.

Source code in zeus/device/gpu/common.py 
65
66
67
68
69
@deprecated_alias("setPowerManagementLimit")
@abc.abstractmethod
def set_power_management_limit(self, power_limit_mw: int, block: bool = True) -> None:
    """Set the GPU's power management limit. Unit: mW."""
    pass

reset_power_management_limit abstractmethod 

reset_power_management_limit(block=True)

Reset the GPU's power management limit to the default value.

Source code in zeus/device/gpu/common.py 
71
72
73
74
75
@deprecated_alias("resetPowerManagementLimit")
@abc.abstractmethod
def reset_power_management_limit(self, block: bool = True) -> None:
    """Reset the GPU's power management limit to the default value."""
    pass

set_persistence_mode abstractmethod 

set_persistence_mode(enabled, block=True)

Set persistence mode.

Source code in zeus/device/gpu/common.py 
77
78
79
80
81
@deprecated_alias("setPersistenceMode")
@abc.abstractmethod
def set_persistence_mode(self, enabled: bool, block: bool = True) -> None:
    """Set persistence mode."""
    pass

get_persistence_mode abstractmethod 

get_persistence_mode()

Return whether persistence mode is currently enabled.

Source code in zeus/device/gpu/common.py 
83
84
85
86
@abc.abstractmethod
def get_persistence_mode(self) -> bool:
    """Return whether persistence mode is currently enabled."""
    pass

get_supported_memory_clocks abstractmethod 

get_supported_memory_clocks()

Return a list of supported memory clock frequencies. Units: MHz.

Source code in zeus/device/gpu/common.py 
88
89
90
91
92
@deprecated_alias("getSupportedMemoryClocks")
@abc.abstractmethod
def get_supported_memory_clocks(self) -> list[int]:
    """Return a list of supported memory clock frequencies. Units: MHz."""
    pass

set_memory_locked_clocks abstractmethod 

set_memory_locked_clocks(min_clock_mhz, max_clock_mhz, block=True)

Lock the memory clock to a specified range. Units: MHz.

Source code in zeus/device/gpu/common.py 
94
95
96
97
98
@deprecated_alias("setMemoryLockedClocks")
@abc.abstractmethod
def set_memory_locked_clocks(self, min_clock_mhz: int, max_clock_mhz: int, block: bool = True) -> None:
    """Lock the memory clock to a specified range. Units: MHz."""
    pass

reset_memory_locked_clocks abstractmethod 

reset_memory_locked_clocks(block=True)

Reset the locked memory clocks to the default.

Source code in zeus/device/gpu/common.py 
100
101
102
103
104
@deprecated_alias("resetMemoryLockedClocks")
@abc.abstractmethod
def reset_memory_locked_clocks(self, block: bool = True) -> None:
    """Reset the locked memory clocks to the default."""
    pass

get_supported_graphics_clocks abstractmethod 

get_supported_graphics_clocks(memory_clock_mhz=None)

Return a list of supported graphics clock frequencies. Units: MHz.

Parameters:

Name Type Description Default
memory_clock_mhz int | None

Memory clock frequency to use. Some GPUs have different supported graphics clocks depending on the memory clock.

 None
Source code in zeus/device/gpu/common.py 
106
107
108
109
110
111
112
113
114
115
@deprecated_alias("getSupportedGraphicsClocks")
@abc.abstractmethod
def get_supported_graphics_clocks(self, memory_clock_mhz: int | None = None) -> list[int]:
    """Return a list of supported graphics clock frequencies. Units: MHz.

    Args:
        memory_clock_mhz: Memory clock frequency to use. Some GPUs have
            different supported graphics clocks depending on the memory clock.
    """
    pass

set_gpu_locked_clocks abstractmethod 

set_gpu_locked_clocks(min_clock_mhz, max_clock_mhz, block=True)

Lock the GPU clock to a specified range. Units: MHz.

Source code in zeus/device/gpu/common.py 
117
118
119
120
121
@deprecated_alias("setGpuLockedClocks")
@abc.abstractmethod
def set_gpu_locked_clocks(self, min_clock_mhz: int, max_clock_mhz: int, block: bool = True) -> None:
    """Lock the GPU clock to a specified range. Units: MHz."""
    pass

reset_gpu_locked_clocks abstractmethod 

reset_gpu_locked_clocks(block=True)

Reset the locked GPU clocks to the default.

Source code in zeus/device/gpu/common.py 
123
124
125
126
127
@deprecated_alias("resetGpuLockedClocks")
@abc.abstractmethod
def reset_gpu_locked_clocks(self, block: bool = True) -> None:
    """Reset the locked GPU clocks to the default."""
    pass

get_average_power_usage abstractmethod 

get_average_power_usage()

Return the average power usage of the GPU. Units: mW.

Source code in zeus/device/gpu/common.py 
129
130
131
132
133
@deprecated_alias("getAveragePowerUsage")
@abc.abstractmethod
def get_average_power_usage(self) -> int:
    """Return the average power usage of the GPU. Units: mW."""
    pass

get_instant_power_usage abstractmethod 

get_instant_power_usage()

Return the current power draw of the GPU. Units: mW.

Source code in zeus/device/gpu/common.py 
135
136
137
138
139
@deprecated_alias("getInstantPowerUsage")
@abc.abstractmethod
def get_instant_power_usage(self) -> int:
    """Return the current power draw of the GPU. Units: mW."""
    pass

get_average_memory_power_usage abstractmethod 

get_average_memory_power_usage()

Return the average power usage of the GPU's memory. Units: mW.

Source code in zeus/device/gpu/common.py 
141
142
143
144
145
@deprecated_alias("getAverageMemoryPowerUsage")
@abc.abstractmethod
def get_average_memory_power_usage(self) -> int:
    """Return the average power usage of the GPU's memory. Units: mW."""
    pass

supports_get_total_energy_consumption abstractmethod 

supports_get_total_energy_consumption()

Check if the GPU supports retrieving total energy consumption.

Source code in zeus/device/gpu/common.py 
147
148
149
150
151
@deprecated_alias("supportsGetTotalEnergyConsumption")
@abc.abstractmethod
def supports_get_total_energy_consumption(self) -> bool:
    """Check if the GPU supports retrieving total energy consumption."""
    pass

get_total_energy_consumption abstractmethod 

get_total_energy_consumption()

Return the total energy consumption of the GPU since driver load. Units: mJ.

Source code in zeus/device/gpu/common.py 
153
154
155
156
157
@deprecated_alias("getTotalEnergyConsumption")
@abc.abstractmethod
def get_total_energy_consumption(self) -> int:
    """Return the total energy consumption of the GPU since driver load. Units: mJ."""
    pass

get_gpu_temperature abstractmethod 

get_gpu_temperature()

Return the current GPU temperature. Units: Celsius.

Source code in zeus/device/gpu/common.py 
159
160
161
162
163
@deprecated_alias("getGpuTemperature")
@abc.abstractmethod
def get_gpu_temperature(self) -> int:
    """Return the current GPU temperature. Units: Celsius."""
    pass

GPUs

Bases: ABC

An abstract base class for a collection of GPU objects.

This is basically a list of GPU objects and forwards most API calls to the individual GPU objects. Still, a separate wrapper class is is needed to for group-level operations like:

  • ensure_homogeneous that ensures that all GPUs have the same name
  • handling vendor-specific environment variables (e.g., CUDA_VISIBLE_DEVICES for NVIDIA)
Source code in zeus/device/gpu/common.py 
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
class GPUs(abc.ABC, metaclass=DeprecatedAliasABCMeta):
    """An abstract base class for a collection of `GPU` objects.

    This is basically a list of [`GPU`][zeus.device.gpu.common.GPU] objects and forwards
    most API calls to the individual `GPU` objects. Still, a separate wrapper class is
    is needed to for group-level operations like:

    - `ensure_homogeneous` that ensures that all GPUs have the same name
    - handling vendor-specific environment variables (e.g., `CUDA_VISIBLE_DEVICES` for NVIDIA)
    """

    @abc.abstractmethod
    def __init__(self, ensure_homogeneous: bool = False) -> None:
        """Initialize the GPU management library and initializes `GPU` objects."""
        pass

    @abc.abstractmethod
    def __del__(self) -> None:
        """Shut down the GPU monitoring library to release resources and clean up."""
        pass

    @property
    @abc.abstractmethod
    def gpus(self) -> Sequence[GPU]:
        """Return a list of GPU objects being tracked."""
        pass

    def __len__(self) -> int:
        """Return the number of GPUs being tracked."""
        return len(self.gpus)

    def _ensure_homogeneous(self) -> None:
        """Ensures that all tracked GPUs are homogeneous in terms of name."""
        gpu_names = [gpu.get_name() for gpu in self.gpus]
        # Both zero (no GPUs found) and one are fine.
        if len(set(gpu_names)) > 1:
            raise ZeusGPUHeterogeneousError(f"Heterogeneous GPUs found: {gpu_names}")

    def _warn_sys_admin(self) -> None:
        """Warn the user if the current process doesn't have `SYS_ADMIN` privileges."""
        # Deriving classes can disable this warning by setting this attribute.
        if not getattr(self, "_disable_sys_admin_warning", False) and not has_sys_admin():
            warnings.warn(
                "You are about to call a GPU management API that requires "
                "`SYS_ADMIN` privileges. Some energy optimizers that change the "
                "GPU's power settings need this.\nSee "
                "https://ml.energy/zeus/getting_started/#system-privileges "
                "for more information and how to obtain `SYS_ADMIN`.",
                stacklevel=2,
            )
            # Only warn once.
            self._disable_sys_admin_warning = True

    @deprecated_alias("getName")
    def get_name(self, gpu_index: int) -> str:
        """Return the name of the specified GPU."""
        return self.gpus[gpu_index].get_name()

    @deprecated_alias("getPowerManagementLimitConstraints")
    def get_power_management_limit_constraints(self, gpu_index: int) -> tuple[int, int]:
        """Return the minimum and maximum power management limits. Units: mW."""
        return self.gpus[gpu_index].get_power_management_limit_constraints()

    def get_power_management_limit(self, gpu_index: int) -> int:
        """Return the current power management limit. Units: mW."""
        return self.gpus[gpu_index].get_power_management_limit()

    @deprecated_alias("setPowerManagementLimit")
    def set_power_management_limit(self, gpu_index: int, power_limit_mw: int, block: bool = True) -> None:
        """Set the GPU's power management limit. Unit: mW."""
        self.gpus[gpu_index].set_power_management_limit(power_limit_mw, block)

    @deprecated_alias("resetPowerManagementLimit")
    def reset_power_management_limit(self, gpu_index: int, block: bool = True) -> None:
        """Reset the GPU's power management limit to the default value."""
        self.gpus[gpu_index].reset_power_management_limit(block)

    @deprecated_alias("setPersistenceMode")
    def set_persistence_mode(self, gpu_index: int, enabled: bool, block: bool = True) -> None:
        """Set persistence mode for the specified GPU."""
        self.gpus[gpu_index].set_persistence_mode(enabled, block)

    def get_persistence_mode(self, gpu_index: int) -> bool:
        """Return whether persistence mode is currently enabled."""
        return self.gpus[gpu_index].get_persistence_mode()

    @deprecated_alias("getSupportedMemoryClocks")
    def get_supported_memory_clocks(self, gpu_index: int) -> list[int]:
        """Return a list of supported memory clock frequencies. Units: MHz."""
        return self.gpus[gpu_index].get_supported_memory_clocks()

    @deprecated_alias("setMemoryLockedClocks")
    def set_memory_locked_clocks(
        self,
        gpu_index: int,
        min_clock_mhz: int,
        max_clock_mhz: int,
        block: bool = True,
    ) -> None:
        """Lock the memory clock to a specified range. Units: MHz."""
        self.gpus[gpu_index].set_memory_locked_clocks(min_clock_mhz, max_clock_mhz, block)

    @deprecated_alias("resetMemoryLockedClocks")
    def reset_memory_locked_clocks(self, gpu_index: int, block: bool = True) -> None:
        """Reset the locked memory clocks to the default."""
        self.gpus[gpu_index].reset_memory_locked_clocks(block)

    @deprecated_alias("getSupportedGraphicsClocks")
    def get_supported_graphics_clocks(self, gpu_index: int, memory_clock_mhz: int | None = None) -> list[int]:
        """Return a list of supported graphics clock frequencies. Units: MHz.

        Args:
            gpu_index: Index of the GPU to query.
            memory_clock_mhz: Memory clock frequency to use. Some GPUs have
                different supported graphics clocks depending on the memory clock.
        """
        return self.gpus[gpu_index].get_supported_graphics_clocks(memory_clock_mhz)

    @deprecated_alias("setGpuLockedClocks")
    def set_gpu_locked_clocks(
        self,
        gpu_index: int,
        min_clock_mhz: int,
        max_clock_mhz: int,
        block: bool = True,
    ) -> None:
        """Lock the GPU clock to a specified range. Units: MHz."""
        self.gpus[gpu_index].set_gpu_locked_clocks(min_clock_mhz, max_clock_mhz, block)

    @deprecated_alias("resetGpuLockedClocks")
    def reset_gpu_locked_clocks(self, gpu_index: int, block: bool = True) -> None:
        """Reset the locked GPU clocks to the default."""
        self.gpus[gpu_index].reset_gpu_locked_clocks(block)

    @deprecated_alias("getAveragePowerUsage")
    def get_average_power_usage(self, gpu_index: int) -> int:
        """Return the average power usage of the GPU. Units: mW."""
        return self.gpus[gpu_index].get_average_power_usage()

    @deprecated_alias("getInstantPowerUsage")
    def get_instant_power_usage(self, gpu_index: int) -> int:
        """Return the current power draw of the GPU. Units: mW."""
        return self.gpus[gpu_index].get_instant_power_usage()

    @deprecated_alias("getAverageMemoryPowerUsage")
    def get_average_memory_power_usage(self, gpu_index: int) -> int:
        """Return the average power usage of the GPU's memory. Units: mW."""
        return self.gpus[gpu_index].get_average_memory_power_usage()

    @deprecated_alias("supportsGetTotalEnergyConsumption")
    def supports_get_total_energy_consumption(self, gpu_index: int) -> bool:
        """Check if the GPU supports retrieving total energy consumption."""
        return self.gpus[gpu_index].supports_get_total_energy_consumption()

    @deprecated_alias("getTotalEnergyConsumption")
    def get_total_energy_consumption(self, gpu_index: int) -> int:
        """Return the total energy consumption of the GPU since driver load. Units: mJ."""
        return self.gpus[gpu_index].get_total_energy_consumption()

    @deprecated_alias("getGpuTemperature")
    def get_gpu_temperature(self, gpu_index: int) -> int:
        """Return the current GPU temperature. Units: Celsius."""
        return self.gpus[gpu_index].get_gpu_temperature()

gpus abstractmethod property 

gpus

Return a list of GPU objects being tracked.

__init__ abstractmethod 

__init__(ensure_homogeneous=False)
Source code in zeus/device/gpu/common.py 
177
178
179
180
@abc.abstractmethod
def __init__(self, ensure_homogeneous: bool = False) -> None:
    """Initialize the GPU management library and initializes `GPU` objects."""
    pass

__del__ abstractmethod 

__del__()

Shut down the GPU monitoring library to release resources and clean up.

Source code in zeus/device/gpu/common.py 
182
183
184
185
@abc.abstractmethod
def __del__(self) -> None:
    """Shut down the GPU monitoring library to release resources and clean up."""
    pass

__len__ 

__len__()

Return the number of GPUs being tracked.

Source code in zeus/device/gpu/common.py 
193
194
195
def __len__(self) -> int:
    """Return the number of GPUs being tracked."""
    return len(self.gpus)

_ensure_homogeneous 

_ensure_homogeneous()

Ensures that all tracked GPUs are homogeneous in terms of name.

Source code in zeus/device/gpu/common.py 
197
198
199
200
201
202
def _ensure_homogeneous(self) -> None:
    """Ensures that all tracked GPUs are homogeneous in terms of name."""
    gpu_names = [gpu.get_name() for gpu in self.gpus]
    # Both zero (no GPUs found) and one are fine.
    if len(set(gpu_names)) > 1:
        raise ZeusGPUHeterogeneousError(f"Heterogeneous GPUs found: {gpu_names}")

_warn_sys_admin 

_warn_sys_admin()

Warn the user if the current process doesn't have SYS_ADMIN privileges.

Source code in zeus/device/gpu/common.py 
204
205
206
207
208
209
210
211
212
213
214
215
216
217
def _warn_sys_admin(self) -> None:
    """Warn the user if the current process doesn't have `SYS_ADMIN` privileges."""
    # Deriving classes can disable this warning by setting this attribute.
    if not getattr(self, "_disable_sys_admin_warning", False) and not has_sys_admin():
        warnings.warn(
            "You are about to call a GPU management API that requires "
            "`SYS_ADMIN` privileges. Some energy optimizers that change the "
            "GPU's power settings need this.\nSee "
            "https://ml.energy/zeus/getting_started/#system-privileges "
            "for more information and how to obtain `SYS_ADMIN`.",
            stacklevel=2,
        )
        # Only warn once.
        self._disable_sys_admin_warning = True

get_name 

get_name(gpu_index)

Return the name of the specified GPU.

Source code in zeus/device/gpu/common.py 
219
220
221
222
@deprecated_alias("getName")
def get_name(self, gpu_index: int) -> str:
    """Return the name of the specified GPU."""
    return self.gpus[gpu_index].get_name()

get_power_management_limit_constraints 

get_power_management_limit_constraints(gpu_index)

Return the minimum and maximum power management limits. Units: mW.

Source code in zeus/device/gpu/common.py 
224
225
226
227
@deprecated_alias("getPowerManagementLimitConstraints")
def get_power_management_limit_constraints(self, gpu_index: int) -> tuple[int, int]:
    """Return the minimum and maximum power management limits. Units: mW."""
    return self.gpus[gpu_index].get_power_management_limit_constraints()

get_power_management_limit 

get_power_management_limit(gpu_index)

Return the current power management limit. Units: mW.

Source code in zeus/device/gpu/common.py 
229
230
231
def get_power_management_limit(self, gpu_index: int) -> int:
    """Return the current power management limit. Units: mW."""
    return self.gpus[gpu_index].get_power_management_limit()

set_power_management_limit 

set_power_management_limit(gpu_index, power_limit_mw, block=True)

Set the GPU's power management limit. Unit: mW.

Source code in zeus/device/gpu/common.py 
233
234
235
236
@deprecated_alias("setPowerManagementLimit")
def set_power_management_limit(self, gpu_index: int, power_limit_mw: int, block: bool = True) -> None:
    """Set the GPU's power management limit. Unit: mW."""
    self.gpus[gpu_index].set_power_management_limit(power_limit_mw, block)

reset_power_management_limit 

reset_power_management_limit(gpu_index, block=True)

Reset the GPU's power management limit to the default value.

Source code in zeus/device/gpu/common.py 
238
239
240
241
@deprecated_alias("resetPowerManagementLimit")
def reset_power_management_limit(self, gpu_index: int, block: bool = True) -> None:
    """Reset the GPU's power management limit to the default value."""
    self.gpus[gpu_index].reset_power_management_limit(block)

set_persistence_mode 

set_persistence_mode(gpu_index, enabled, block=True)

Set persistence mode for the specified GPU.

Source code in zeus/device/gpu/common.py 
243
244
245
246
@deprecated_alias("setPersistenceMode")
def set_persistence_mode(self, gpu_index: int, enabled: bool, block: bool = True) -> None:
    """Set persistence mode for the specified GPU."""
    self.gpus[gpu_index].set_persistence_mode(enabled, block)

get_persistence_mode 

get_persistence_mode(gpu_index)

Return whether persistence mode is currently enabled.

Source code in zeus/device/gpu/common.py 
248
249
250
def get_persistence_mode(self, gpu_index: int) -> bool:
    """Return whether persistence mode is currently enabled."""
    return self.gpus[gpu_index].get_persistence_mode()

get_supported_memory_clocks 

get_supported_memory_clocks(gpu_index)

Return a list of supported memory clock frequencies. Units: MHz.

Source code in zeus/device/gpu/common.py 
252
253
254
255
@deprecated_alias("getSupportedMemoryClocks")
def get_supported_memory_clocks(self, gpu_index: int) -> list[int]:
    """Return a list of supported memory clock frequencies. Units: MHz."""
    return self.gpus[gpu_index].get_supported_memory_clocks()

set_memory_locked_clocks 

set_memory_locked_clocks(gpu_index, min_clock_mhz, max_clock_mhz, block=True)

Lock the memory clock to a specified range. Units: MHz.

Source code in zeus/device/gpu/common.py 
257
258
259
260
261
262
263
264
265
266
@deprecated_alias("setMemoryLockedClocks")
def set_memory_locked_clocks(
    self,
    gpu_index: int,
    min_clock_mhz: int,
    max_clock_mhz: int,
    block: bool = True,
) -> None:
    """Lock the memory clock to a specified range. Units: MHz."""
    self.gpus[gpu_index].set_memory_locked_clocks(min_clock_mhz, max_clock_mhz, block)

reset_memory_locked_clocks 

reset_memory_locked_clocks(gpu_index, block=True)

Reset the locked memory clocks to the default.

Source code in zeus/device/gpu/common.py 
268
269
270
271
@deprecated_alias("resetMemoryLockedClocks")
def reset_memory_locked_clocks(self, gpu_index: int, block: bool = True) -> None:
    """Reset the locked memory clocks to the default."""
    self.gpus[gpu_index].reset_memory_locked_clocks(block)

get_supported_graphics_clocks 

get_supported_graphics_clocks(gpu_index, memory_clock_mhz=None)

Return a list of supported graphics clock frequencies. Units: MHz.

Parameters:

Name Type Description Default
gpu_index int

Index of the GPU to query.

 required
memory_clock_mhz int | None

Memory clock frequency to use. Some GPUs have different supported graphics clocks depending on the memory clock.

 None
Source code in zeus/device/gpu/common.py 
273
274
275
276
277
278
279
280
281
282
@deprecated_alias("getSupportedGraphicsClocks")
def get_supported_graphics_clocks(self, gpu_index: int, memory_clock_mhz: int | None = None) -> list[int]:
    """Return a list of supported graphics clock frequencies. Units: MHz.

    Args:
        gpu_index: Index of the GPU to query.
        memory_clock_mhz: Memory clock frequency to use. Some GPUs have
            different supported graphics clocks depending on the memory clock.
    """
    return self.gpus[gpu_index].get_supported_graphics_clocks(memory_clock_mhz)

set_gpu_locked_clocks 

set_gpu_locked_clocks(gpu_index, min_clock_mhz, max_clock_mhz, block=True)

Lock the GPU clock to a specified range. Units: MHz.

Source code in zeus/device/gpu/common.py 
284
285
286
287
288
289
290
291
292
293
@deprecated_alias("setGpuLockedClocks")
def set_gpu_locked_clocks(
    self,
    gpu_index: int,
    min_clock_mhz: int,
    max_clock_mhz: int,
    block: bool = True,
) -> None:
    """Lock the GPU clock to a specified range. Units: MHz."""
    self.gpus[gpu_index].set_gpu_locked_clocks(min_clock_mhz, max_clock_mhz, block)

reset_gpu_locked_clocks 

reset_gpu_locked_clocks(gpu_index, block=True)

Reset the locked GPU clocks to the default.

Source code in zeus/device/gpu/common.py 
295
296
297
298
@deprecated_alias("resetGpuLockedClocks")
def reset_gpu_locked_clocks(self, gpu_index: int, block: bool = True) -> None:
    """Reset the locked GPU clocks to the default."""
    self.gpus[gpu_index].reset_gpu_locked_clocks(block)

get_average_power_usage 

get_average_power_usage(gpu_index)

Return the average power usage of the GPU. Units: mW.

Source code in zeus/device/gpu/common.py 
300
301
302
303
@deprecated_alias("getAveragePowerUsage")
def get_average_power_usage(self, gpu_index: int) -> int:
    """Return the average power usage of the GPU. Units: mW."""
    return self.gpus[gpu_index].get_average_power_usage()

get_instant_power_usage 

get_instant_power_usage(gpu_index)

Return the current power draw of the GPU. Units: mW.

Source code in zeus/device/gpu/common.py 
305
306
307
308
@deprecated_alias("getInstantPowerUsage")
def get_instant_power_usage(self, gpu_index: int) -> int:
    """Return the current power draw of the GPU. Units: mW."""
    return self.gpus[gpu_index].get_instant_power_usage()

get_average_memory_power_usage 

get_average_memory_power_usage(gpu_index)

Return the average power usage of the GPU's memory. Units: mW.

Source code in zeus/device/gpu/common.py 
310
311
312
313
@deprecated_alias("getAverageMemoryPowerUsage")
def get_average_memory_power_usage(self, gpu_index: int) -> int:
    """Return the average power usage of the GPU's memory. Units: mW."""
    return self.gpus[gpu_index].get_average_memory_power_usage()

supports_get_total_energy_consumption 

supports_get_total_energy_consumption(gpu_index)

Check if the GPU supports retrieving total energy consumption.

Source code in zeus/device/gpu/common.py 
315
316
317
318
@deprecated_alias("supportsGetTotalEnergyConsumption")
def supports_get_total_energy_consumption(self, gpu_index: int) -> bool:
    """Check if the GPU supports retrieving total energy consumption."""
    return self.gpus[gpu_index].supports_get_total_energy_consumption()

get_total_energy_consumption 

get_total_energy_consumption(gpu_index)

Return the total energy consumption of the GPU since driver load. Units: mJ.

Source code in zeus/device/gpu/common.py 
320
321
322
323
@deprecated_alias("getTotalEnergyConsumption")
def get_total_energy_consumption(self, gpu_index: int) -> int:
    """Return the total energy consumption of the GPU since driver load. Units: mJ."""
    return self.gpus[gpu_index].get_total_energy_consumption()

get_gpu_temperature 

get_gpu_temperature(gpu_index)

Return the current GPU temperature. Units: Celsius.

Source code in zeus/device/gpu/common.py 
325
326
327
328
@deprecated_alias("getGpuTemperature")
def get_gpu_temperature(self, gpu_index: int) -> int:
    """Return the current GPU temperature. Units: Celsius."""
    return self.gpus[gpu_index].get_gpu_temperature()

EmptyGPUs

Bases: GPUs

A concrete class implementing the GPUs abstract base class, but representing an empty collection of GPUs.

This class is used to represent a scenario where no GPUs are available or detected. Any method call attempting to interact with a GPU will raise a ValueError.

Source code in zeus/device/gpu/common.py 
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
class EmptyGPUs(GPUs):
    """A concrete class implementing the GPUs abstract base class, but representing an empty collection of GPUs.

    This class is used to represent a scenario where no GPUs are available or detected.
    Any method call attempting to interact with a GPU will raise a ValueError.
    """

    def __init__(self, ensure_homogeneous: bool = False) -> None:
        """Initialize the EMPTYGPUs class.

        Since this class represents an empty collection of GPUs, no actual initialization of GPU objects is performed.
        """
        pass

    def __del__(self) -> None:
        """Clean up any resources if necessary.

        As this class represents an empty collection of GPUs, no specific cleanup is required.
        """
        pass

    @property
    def gpus(self) -> Sequence["GPU"]:
        """Return an empty list as no GPUs are being tracked."""
        return []

    def __len__(self) -> int:
        """Return 0, indicating no GPUs are being tracked."""
        return 0

    def _ensure_homogeneous(self) -> None:
        """Raise a ValueError as no GPUs are being tracked."""
        raise ValueError("No GPUs available to ensure homogeneity.")

    def _warn_sys_admin(self) -> None:
        """Raise a ValueError as no GPUs are being tracked."""
        raise ValueError("No GPUs available to warn about SYS_ADMIN privileges.")

    @deprecated_alias("getName")
    def get_name(self, gpu_index: int) -> str:
        """Raise a ValueError as no GPUs are available."""
        raise ValueError("No GPUs available.")

    @deprecated_alias("getPowerManagementLimitConstraints")
    def get_power_management_limit_constraints(self, gpu_index: int) -> tuple[int, int]:
        """Raise a ValueError as no GPUs are available."""
        raise ValueError("No GPUs available.")

    def get_power_management_limit(self, gpu_index: int) -> int:
        """Raise a ValueError as no GPUs are available."""
        raise ValueError("No GPUs available.")

    @deprecated_alias("setPowerManagementLimit")
    def set_power_management_limit(self, gpu_index: int, power_limit_mw: int, block: bool = True) -> None:
        """Raise a ValueError as no GPUs are available."""
        raise ValueError("No GPUs available.")

    @deprecated_alias("resetPowerManagementLimit")
    def reset_power_management_limit(self, gpu_index: int, block: bool = True) -> None:
        """Raise a ValueError as no GPUs are available."""
        raise ValueError("No GPUs available.")

    @deprecated_alias("setPersistenceMode")
    def set_persistence_mode(self, gpu_index: int, enabled: bool, block: bool = True) -> None:
        """Raise a ValueError as no GPUs are available."""
        raise ValueError("No GPUs available.")

    def get_persistence_mode(self, gpu_index: int) -> bool:
        """Raise a ValueError as no GPUs are available."""
        raise ValueError("No GPUs available.")

    @deprecated_alias("getSupportedMemoryClocks")
    def get_supported_memory_clocks(self, gpu_index: int) -> list[int]:
        """Raise a ValueError as no GPUs are available."""
        raise ValueError("No GPUs available.")

    @deprecated_alias("setMemoryLockedClocks")
    def set_memory_locked_clocks(
        self,
        gpu_index: int,
        min_clock_mhz: int,
        max_clock_mhz: int,
        block: bool = True,
    ) -> None:
        """Raise a ValueError as no GPUs are available."""
        raise ValueError("No GPUs available.")

    @deprecated_alias("resetMemoryLockedClocks")
    def reset_memory_locked_clocks(self, gpu_index: int, block: bool = True) -> None:
        """Raise a ValueError as no GPUs are available."""
        raise ValueError("No GPUs available.")

    @deprecated_alias("getSupportedGraphicsClocks")
    def get_supported_graphics_clocks(self, gpu_index: int, memory_clock_mhz: int | None = None) -> list[int]:
        """Raise a ValueError as no GPUs are available."""
        raise ValueError("No GPUs available.")

    @deprecated_alias("setGpuLockedClocks")
    def set_gpu_locked_clocks(
        self,
        gpu_index: int,
        min_clock_mhz: int,
        max_clock_mhz: int,
        block: bool = True,
    ) -> None:
        """Raise a ValueError as no GPUs are available."""
        raise ValueError("No GPUs available.")

    @deprecated_alias("resetGpuLockedClocks")
    def reset_gpu_locked_clocks(self, gpu_index: int, block: bool = True) -> None:
        """Raise a ValueError as no GPUs are available."""
        raise ValueError("No GPUs available.")

    @deprecated_alias("getInstantPowerUsage")
    def get_instant_power_usage(self, gpu_index: int) -> int:
        """Raise a ValueError as no GPUs are available."""
        raise ValueError("No GPUs available.")

    @deprecated_alias("supportsGetTotalEnergyConsumption")
    def supports_get_total_energy_consumption(self, gpu_index: int) -> bool:
        """Raise a ValueError as no GPUs are available."""
        raise ValueError("No GPUs available.")

    @deprecated_alias("getTotalEnergyConsumption")
    def get_total_energy_consumption(self, gpu_index: int) -> int:
        """Raise a ValueError as no GPUs are available."""
        raise ValueError("No GPUs available.")

    @deprecated_alias("getGpuTemperature")
    def get_gpu_temperature(self, gpu_index: int) -> int:
        """Raise a ValueError as no GPUs are available."""
        raise ValueError("No GPUs available.")

gpus property 

gpus

Return an empty list as no GPUs are being tracked.

__init__ 

__init__(ensure_homogeneous=False)

Since this class represents an empty collection of GPUs, no actual initialization of GPU objects is performed.

Source code in zeus/device/gpu/common.py 
338
339
340
341
342
343
def __init__(self, ensure_homogeneous: bool = False) -> None:
    """Initialize the EMPTYGPUs class.

    Since this class represents an empty collection of GPUs, no actual initialization of GPU objects is performed.
    """
    pass

__del__ 

__del__()

Clean up any resources if necessary.

As this class represents an empty collection of GPUs, no specific cleanup is required.

Source code in zeus/device/gpu/common.py 
345
346
347
348
349
350
def __del__(self) -> None:
    """Clean up any resources if necessary.

    As this class represents an empty collection of GPUs, no specific cleanup is required.
    """
    pass

__len__ 

__len__()

Return 0, indicating no GPUs are being tracked.

Source code in zeus/device/gpu/common.py 
357
358
359
def __len__(self) -> int:
    """Return 0, indicating no GPUs are being tracked."""
    return 0

_ensure_homogeneous 

_ensure_homogeneous()

Raise a ValueError as no GPUs are being tracked.

Source code in zeus/device/gpu/common.py 
361
362
363
def _ensure_homogeneous(self) -> None:
    """Raise a ValueError as no GPUs are being tracked."""
    raise ValueError("No GPUs available to ensure homogeneity.")

_warn_sys_admin 

_warn_sys_admin()

Raise a ValueError as no GPUs are being tracked.

Source code in zeus/device/gpu/common.py 
365
366
367
def _warn_sys_admin(self) -> None:
    """Raise a ValueError as no GPUs are being tracked."""
    raise ValueError("No GPUs available to warn about SYS_ADMIN privileges.")

get_name 

get_name(gpu_index)

Raise a ValueError as no GPUs are available.

Source code in zeus/device/gpu/common.py 
369
370
371
372
@deprecated_alias("getName")
def get_name(self, gpu_index: int) -> str:
    """Raise a ValueError as no GPUs are available."""
    raise ValueError("No GPUs available.")

get_power_management_limit_constraints 

get_power_management_limit_constraints(gpu_index)

Raise a ValueError as no GPUs are available.

Source code in zeus/device/gpu/common.py 
374
375
376
377
@deprecated_alias("getPowerManagementLimitConstraints")
def get_power_management_limit_constraints(self, gpu_index: int) -> tuple[int, int]:
    """Raise a ValueError as no GPUs are available."""
    raise ValueError("No GPUs available.")

get_power_management_limit 

get_power_management_limit(gpu_index)

Raise a ValueError as no GPUs are available.

Source code in zeus/device/gpu/common.py 
379
380
381
def get_power_management_limit(self, gpu_index: int) -> int:
    """Raise a ValueError as no GPUs are available."""
    raise ValueError("No GPUs available.")

set_power_management_limit 

set_power_management_limit(gpu_index, power_limit_mw, block=True)

Raise a ValueError as no GPUs are available.

Source code in zeus/device/gpu/common.py 
383
384
385
386
@deprecated_alias("setPowerManagementLimit")
def set_power_management_limit(self, gpu_index: int, power_limit_mw: int, block: bool = True) -> None:
    """Raise a ValueError as no GPUs are available."""
    raise ValueError("No GPUs available.")

reset_power_management_limit 

reset_power_management_limit(gpu_index, block=True)

Raise a ValueError as no GPUs are available.

Source code in zeus/device/gpu/common.py 
388
389
390
391
@deprecated_alias("resetPowerManagementLimit")
def reset_power_management_limit(self, gpu_index: int, block: bool = True) -> None:
    """Raise a ValueError as no GPUs are available."""
    raise ValueError("No GPUs available.")

set_persistence_mode 

set_persistence_mode(gpu_index, enabled, block=True)

Raise a ValueError as no GPUs are available.

Source code in zeus/device/gpu/common.py 
393
394
395
396
@deprecated_alias("setPersistenceMode")
def set_persistence_mode(self, gpu_index: int, enabled: bool, block: bool = True) -> None:
    """Raise a ValueError as no GPUs are available."""
    raise ValueError("No GPUs available.")

get_persistence_mode 

get_persistence_mode(gpu_index)

Raise a ValueError as no GPUs are available.

Source code in zeus/device/gpu/common.py 
398
399
400
def get_persistence_mode(self, gpu_index: int) -> bool:
    """Raise a ValueError as no GPUs are available."""
    raise ValueError("No GPUs available.")

get_supported_memory_clocks 

get_supported_memory_clocks(gpu_index)

Raise a ValueError as no GPUs are available.

Source code in zeus/device/gpu/common.py 
402
403
404
405
@deprecated_alias("getSupportedMemoryClocks")
def get_supported_memory_clocks(self, gpu_index: int) -> list[int]:
    """Raise a ValueError as no GPUs are available."""
    raise ValueError("No GPUs available.")

set_memory_locked_clocks 

set_memory_locked_clocks(gpu_index, min_clock_mhz, max_clock_mhz, block=True)

Raise a ValueError as no GPUs are available.

Source code in zeus/device/gpu/common.py 
407
408
409
410
411
412
413
414
415
416
@deprecated_alias("setMemoryLockedClocks")
def set_memory_locked_clocks(
    self,
    gpu_index: int,
    min_clock_mhz: int,
    max_clock_mhz: int,
    block: bool = True,
) -> None:
    """Raise a ValueError as no GPUs are available."""
    raise ValueError("No GPUs available.")

reset_memory_locked_clocks 

reset_memory_locked_clocks(gpu_index, block=True)

Raise a ValueError as no GPUs are available.

Source code in zeus/device/gpu/common.py 
418
419
420
421
@deprecated_alias("resetMemoryLockedClocks")
def reset_memory_locked_clocks(self, gpu_index: int, block: bool = True) -> None:
    """Raise a ValueError as no GPUs are available."""
    raise ValueError("No GPUs available.")

get_supported_graphics_clocks 

get_supported_graphics_clocks(gpu_index, memory_clock_mhz=None)

Raise a ValueError as no GPUs are available.

Source code in zeus/device/gpu/common.py 
423
424
425
426
@deprecated_alias("getSupportedGraphicsClocks")
def get_supported_graphics_clocks(self, gpu_index: int, memory_clock_mhz: int | None = None) -> list[int]:
    """Raise a ValueError as no GPUs are available."""
    raise ValueError("No GPUs available.")

set_gpu_locked_clocks 

set_gpu_locked_clocks(gpu_index, min_clock_mhz, max_clock_mhz, block=True)

Raise a ValueError as no GPUs are available.

Source code in zeus/device/gpu/common.py 
428
429
430
431
432
433
434
435
436
437
@deprecated_alias("setGpuLockedClocks")
def set_gpu_locked_clocks(
    self,
    gpu_index: int,
    min_clock_mhz: int,
    max_clock_mhz: int,
    block: bool = True,
) -> None:
    """Raise a ValueError as no GPUs are available."""
    raise ValueError("No GPUs available.")

reset_gpu_locked_clocks 

reset_gpu_locked_clocks(gpu_index, block=True)

Raise a ValueError as no GPUs are available.

Source code in zeus/device/gpu/common.py 
439
440
441
442
@deprecated_alias("resetGpuLockedClocks")
def reset_gpu_locked_clocks(self, gpu_index: int, block: bool = True) -> None:
    """Raise a ValueError as no GPUs are available."""
    raise ValueError("No GPUs available.")

get_instant_power_usage 

get_instant_power_usage(gpu_index)

Raise a ValueError as no GPUs are available.

Source code in zeus/device/gpu/common.py 
444
445
446
447
@deprecated_alias("getInstantPowerUsage")
def get_instant_power_usage(self, gpu_index: int) -> int:
    """Raise a ValueError as no GPUs are available."""
    raise ValueError("No GPUs available.")

supports_get_total_energy_consumption 

supports_get_total_energy_consumption(gpu_index)

Raise a ValueError as no GPUs are available.

Source code in zeus/device/gpu/common.py 
449
450
451
452
@deprecated_alias("supportsGetTotalEnergyConsumption")
def supports_get_total_energy_consumption(self, gpu_index: int) -> bool:
    """Raise a ValueError as no GPUs are available."""
    raise ValueError("No GPUs available.")

get_total_energy_consumption 

get_total_energy_consumption(gpu_index)

Raise a ValueError as no GPUs are available.

Source code in zeus/device/gpu/common.py 
454
455
456
457
@deprecated_alias("getTotalEnergyConsumption")
def get_total_energy_consumption(self, gpu_index: int) -> int:
    """Raise a ValueError as no GPUs are available."""
    raise ValueError("No GPUs available.")

get_gpu_temperature 

get_gpu_temperature(gpu_index)

Raise a ValueError as no GPUs are available.

Source code in zeus/device/gpu/common.py 
459
460
461
462
@deprecated_alias("getGpuTemperature")
def get_gpu_temperature(self, gpu_index: int) -> int:
    """Raise a ValueError as no GPUs are available."""
    raise ValueError("No GPUs available.")

ZeusGPUInitError

Bases: ZeusBaseGPUError

Import error or GPU library initialization failures.

Source code in zeus/device/gpu/common.py 
465
466
467
468
469
470
class ZeusGPUInitError(ZeusBaseGPUError):
    """Import error or GPU library initialization failures."""

    def __init__(self, message: str) -> None:
        """Intialize the exception object."""
        super().__init__(message)

__init__ 

__init__(message)
Source code in zeus/device/gpu/common.py 
468
469
470
def __init__(self, message: str) -> None:
    """Intialize the exception object."""
    super().__init__(message)

ZeusGPUInvalidArgError

Bases: ZeusBaseGPUError

Zeus GPU exception that wraps Invalid Argument.

Source code in zeus/device/gpu/common.py 
473
474
475
476
477
478
class ZeusGPUInvalidArgError(ZeusBaseGPUError):
    """Zeus GPU exception that wraps Invalid Argument."""

    def __init__(self, message: str) -> None:
        """Intialize the exception object."""
        super().__init__(message)

__init__ 

__init__(message)
Source code in zeus/device/gpu/common.py 
476
477
478
def __init__(self, message: str) -> None:
    """Intialize the exception object."""
    super().__init__(message)

ZeusGPUNotSupportedError

Bases: ZeusBaseGPUError

Zeus GPU exception that wraps Not Supported Operation on GPU.

Source code in zeus/device/gpu/common.py 
481
482
483
484
485
486
class ZeusGPUNotSupportedError(ZeusBaseGPUError):
    """Zeus GPU exception that wraps Not Supported Operation on GPU."""

    def __init__(self, message: str) -> None:
        """Intialize the exception object."""
        super().__init__(message)

__init__ 

__init__(message)
Source code in zeus/device/gpu/common.py 
484
485
486
def __init__(self, message: str) -> None:
    """Intialize the exception object."""
    super().__init__(message)

ZeusGPUNoPermissionError

Bases: ZeusBaseGPUError

Zeus GPU exception that wraps No Permission to perform GPU operation.

Source code in zeus/device/gpu/common.py 
489
490
491
492
493
494
class ZeusGPUNoPermissionError(ZeusBaseGPUError):
    """Zeus GPU exception that wraps No Permission to perform GPU operation."""

    def __init__(self, message: str) -> None:
        """Intialize the exception object."""
        super().__init__(message)

__init__ 

__init__(message)
Source code in zeus/device/gpu/common.py 
492
493
494
def __init__(self, message: str) -> None:
    """Intialize the exception object."""
    super().__init__(message)

ZeusGPUAlreadyInitializedError

Bases: ZeusBaseGPUError

Zeus GPU exception that wraps Already Initialized GPU.

Source code in zeus/device/gpu/common.py 
497
498
499
500
501
502
class ZeusGPUAlreadyInitializedError(ZeusBaseGPUError):
    """Zeus GPU exception that wraps Already Initialized GPU."""

    def __init__(self, message: str) -> None:
        """Intialize the exception object."""
        super().__init__(message)

__init__ 

__init__(message)
Source code in zeus/device/gpu/common.py 
500
501
502
def __init__(self, message: str) -> None:
    """Intialize the exception object."""
    super().__init__(message)

ZeusGPUNotFoundError

Bases: ZeusBaseGPUError

Zeus GPU exception that wraps Not Found GPU.

Source code in zeus/device/gpu/common.py 
505
506
507
508
509
510
class ZeusGPUNotFoundError(ZeusBaseGPUError):
    """Zeus GPU exception that wraps Not Found GPU."""

    def __init__(self, message: str) -> None:
        """Intialize the exception object."""
        super().__init__(message)

__init__ 

__init__(message)
Source code in zeus/device/gpu/common.py 
508
509
510
def __init__(self, message: str) -> None:
    """Intialize the exception object."""
    super().__init__(message)

ZeusGPUInsufficientSizeError

Bases: ZeusBaseGPUError

Zeus GPU exception that wraps Insufficient Size.

Source code in zeus/device/gpu/common.py 
513
514
515
516
517
518
class ZeusGPUInsufficientSizeError(ZeusBaseGPUError):
    """Zeus GPU exception that wraps Insufficient Size."""

    def __init__(self, message: str) -> None:
        """Intialize the exception object."""
        super().__init__(message)

__init__ 

__init__(message)
Source code in zeus/device/gpu/common.py 
516
517
518
def __init__(self, message: str) -> None:
    """Intialize the exception object."""
    super().__init__(message)

ZeusGPUInsufficientPowerError

Bases: ZeusBaseGPUError

Zeus GPU exception that wraps Insufficient Power.

Source code in zeus/device/gpu/common.py 
521
522
523
524
525
526
class ZeusGPUInsufficientPowerError(ZeusBaseGPUError):
    """Zeus GPU exception that wraps Insufficient Power."""

    def __init__(self, message: str) -> None:
        """Intialize the exception object."""
        super().__init__(message)

__init__ 

__init__(message)
Source code in zeus/device/gpu/common.py 
524
525
526
def __init__(self, message: str) -> None:
    """Intialize the exception object."""
    super().__init__(message)

ZeusGPUDriverNotLoadedError

Bases: ZeusBaseGPUError

Zeus GPU exception that wraps Driver Error.

Source code in zeus/device/gpu/common.py 
529
530
531
532
533
534
class ZeusGPUDriverNotLoadedError(ZeusBaseGPUError):
    """Zeus GPU exception that wraps Driver Error."""

    def __init__(self, message: str) -> None:
        """Intialize the exception object."""
        super().__init__(message)

__init__ 

__init__(message)
Source code in zeus/device/gpu/common.py 
532
533
534
def __init__(self, message: str) -> None:
    """Intialize the exception object."""
    super().__init__(message)

ZeusGPUTimeoutError

Bases: ZeusBaseGPUError

Zeus GPU exception that wraps Timeout Error.

Source code in zeus/device/gpu/common.py 
537
538
539
540
541
542
class ZeusGPUTimeoutError(ZeusBaseGPUError):
    """Zeus GPU exception that wraps Timeout Error."""

    def __init__(self, message: str) -> None:
        """Intialize the exception object."""
        super().__init__(message)

__init__ 

__init__(message)
Source code in zeus/device/gpu/common.py 
540
541
542
def __init__(self, message: str) -> None:
    """Intialize the exception object."""
    super().__init__(message)

ZeusGPUIRQError

Bases: ZeusBaseGPUError

Zeus GPU exception that wraps IRQ Error.

Source code in zeus/device/gpu/common.py 
545
546
547
548
549
550
class ZeusGPUIRQError(ZeusBaseGPUError):
    """Zeus GPU exception that wraps IRQ Error."""

    def __init__(self, message: str) -> None:
        """Intialize the exception object."""
        super().__init__(message)

__init__ 

__init__(message)
Source code in zeus/device/gpu/common.py 
548
549
550
def __init__(self, message: str) -> None:
    """Intialize the exception object."""
    super().__init__(message)

ZeusGPULibraryNotFoundError

Bases: ZeusBaseGPUError

Zeus GPU exception that wraps Library Not Found Error.

Source code in zeus/device/gpu/common.py 
553
554
555
556
557
558
class ZeusGPULibraryNotFoundError(ZeusBaseGPUError):
    """Zeus GPU exception that wraps Library Not Found Error."""

    def __init__(self, message: str) -> None:
        """Intialize the exception object."""
        super().__init__(message)

__init__ 

__init__(message)
Source code in zeus/device/gpu/common.py 
556
557
558
def __init__(self, message: str) -> None:
    """Intialize the exception object."""
    super().__init__(message)

ZeusGPUFunctionNotFoundError

Bases: ZeusBaseGPUError

Zeus GPU exception that wraps Function Not Found Error.

Source code in zeus/device/gpu/common.py 
561
562
563
564
565
566
class ZeusGPUFunctionNotFoundError(ZeusBaseGPUError):
    """Zeus GPU exception that wraps Function Not Found Error."""

    def __init__(self, message: str) -> None:
        """Intialize the exception object."""
        super().__init__(message)

__init__ 

__init__(message)
Source code in zeus/device/gpu/common.py 
564
565
566
def __init__(self, message: str) -> None:
    """Intialize the exception object."""
    super().__init__(message)

ZeusGPUCorruptedInfoROMError

Bases: ZeusBaseGPUError

Zeus GPU exception that wraps Corrupted Info ROM Error.

Source code in zeus/device/gpu/common.py 
569
570
571
572
573
574
class ZeusGPUCorruptedInfoROMError(ZeusBaseGPUError):
    """Zeus GPU exception that wraps Corrupted Info ROM Error."""

    def __init__(self, message: str) -> None:
        """Intialize the exception object."""
        super().__init__(message)

__init__ 

__init__(message)
Source code in zeus/device/gpu/common.py 
572
573
574
def __init__(self, message: str) -> None:
    """Intialize the exception object."""
    super().__init__(message)

ZeusGPULostError

Bases: ZeusBaseGPUError

Zeus GPU exception that wraps Lost GPU Error.

Source code in zeus/device/gpu/common.py 
577
578
579
580
581
582
class ZeusGPULostError(ZeusBaseGPUError):
    """Zeus GPU exception that wraps Lost GPU Error."""

    def __init__(self, message: str) -> None:
        """Intialize the exception object."""
        super().__init__(message)

__init__ 

__init__(message)
Source code in zeus/device/gpu/common.py 
580
581
582
def __init__(self, message: str) -> None:
    """Intialize the exception object."""
    super().__init__(message)

ZeusGPUResetRequiredError

Bases: ZeusBaseGPUError

Zeus GPU exception that wraps Reset Required Error.

Source code in zeus/device/gpu/common.py 
585
586
587
588
589
590
class ZeusGPUResetRequiredError(ZeusBaseGPUError):
    """Zeus GPU exception that wraps Reset Required Error."""

    def __init__(self, message: str) -> None:
        """Intialize the exception object."""
        super().__init__(message)

__init__ 

__init__(message)
Source code in zeus/device/gpu/common.py 
588
589
590
def __init__(self, message: str) -> None:
    """Intialize the exception object."""
    super().__init__(message)

ZeusGPUOperatingSystemError

Bases: ZeusBaseGPUError

Zeus GPU exception that wraps Operating System Error.

Source code in zeus/device/gpu/common.py 
593
594
595
596
597
598
class ZeusGPUOperatingSystemError(ZeusBaseGPUError):
    """Zeus GPU exception that wraps Operating System Error."""

    def __init__(self, message: str) -> None:
        """Intialize the exception object."""
        super().__init__(message)

__init__ 

__init__(message)
Source code in zeus/device/gpu/common.py 
596
597
598
def __init__(self, message: str) -> None:
    """Intialize the exception object."""
    super().__init__(message)

ZeusGPULibRMVersionMismatchError

Bases: ZeusBaseGPUError

Zeus GPU exception that wraps LibRM Version Mismatch Error.

Source code in zeus/device/gpu/common.py 
601
602
603
604
605
606
class ZeusGPULibRMVersionMismatchError(ZeusBaseGPUError):
    """Zeus GPU exception that wraps LibRM Version Mismatch Error."""

    def __init__(self, message: str) -> None:
        """Intialize the exception object."""
        super().__init__(message)

__init__ 

__init__(message)
Source code in zeus/device/gpu/common.py 
604
605
606
def __init__(self, message: str) -> None:
    """Intialize the exception object."""
    super().__init__(message)

ZeusGPUMemoryError

Bases: ZeusBaseGPUError

Zeus GPU exception that wraps Insufficient Memory Error.

Source code in zeus/device/gpu/common.py 
609
610
611
612
613
614
class ZeusGPUMemoryError(ZeusBaseGPUError):
    """Zeus GPU exception that wraps Insufficient Memory Error."""

    def __init__(self, message: str) -> None:
        """Intialize the exception object."""
        super().__init__(message)

__init__ 

__init__(message)
Source code in zeus/device/gpu/common.py 
612
613
614
def __init__(self, message: str) -> None:
    """Intialize the exception object."""
    super().__init__(message)

ZeusGPUUnknownError

Bases: ZeusBaseGPUError

Zeus GPU exception that wraps Unknown Error.

Source code in zeus/device/gpu/common.py 
617
618
619
620
621
622
class ZeusGPUUnknownError(ZeusBaseGPUError):
    """Zeus GPU exception that wraps Unknown Error."""

    def __init__(self, message: str) -> None:
        """Intialize the exception object."""
        super().__init__(message)

__init__ 

__init__(message)
Source code in zeus/device/gpu/common.py 
620
621
622
def __init__(self, message: str) -> None:
    """Intialize the exception object."""
    super().__init__(message)

ZeusGPUHeterogeneousError

Bases: ZeusBaseGPUError

Exception for when GPUs are not homogeneous.

Source code in zeus/device/gpu/common.py 
625
626
627
628
629
630
class ZeusGPUHeterogeneousError(ZeusBaseGPUError):
    """Exception for when GPUs are not homogeneous."""

    def __init__(self, message: str) -> None:
        """Intialize the exception object."""
        super().__init__(message)

__init__ 

__init__(message)
Source code in zeus/device/gpu/common.py 
628
629
630
def __init__(self, message: str) -> None:
    """Intialize the exception object."""
    super().__init__(message)