-
Notifications
You must be signed in to change notification settings - Fork 277
cuda.core.system: Add MIG-related APIs #1916
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from 6 commits
Commits
Show all changes
11 commits
Select commit
Hold shift + click to select a range
f29b935
cuda.core.system: Add MIG-related APIs
mdboom 884c0a7
Add "need"
mdboom b97924a
Add missing file
mdboom 32dff8e
Make properties
mdboom 2053c11
Fix test
mdboom 4d6e3a2
Fix test
mdboom 95f5c1b
Elaborate in the docstring
mdboom ad7fd63
Merge remote-tracking branch 'upstream/main' into cuda-core-system-da…
mdboom 58b4b21
Address comments in PR
mdboom 6db93f4
Address comments in PR
mdboom 7985112
Merge remote-tracking branch 'upstream/main' into cuda-core-system-da…
mdboom File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,177 @@ | ||
| # SPDX-FileCopyrightText: Copyright (c) 2025-2026 NVIDIA CORPORATION & AFFILIATES. All rights reserved. | ||
| # | ||
| # SPDX-License-Identifier: Apache-2.0 | ||
|
|
||
|
|
||
| from typing import Iterable | ||
|
|
||
|
|
||
| cdef class MigInfo: | ||
| cdef Device _device | ||
|
|
||
| def __init__(self, device: Device): | ||
| self._device = device | ||
|
|
||
| @property | ||
| def is_mig_device(self) -> bool: | ||
| """ | ||
| Whether this device is a MIG (Multi-Instance GPU) device. | ||
|
|
||
| A MIG device handle is an NVML abstraction which maps to a MIG compute | ||
| instance. These overloaded references can be used (with some | ||
| restrictions) interchangeably with a GPU device handle to execute | ||
| queries at a per-compute instance granularity. | ||
|
|
||
| For Ampere™ or newer fully supported devices. | ||
| """ | ||
| return bool(nvml.device_is_mig_device_handle(self._device._handle)) | ||
|
|
||
| @property | ||
| def mode(self) -> bool: | ||
| """ | ||
| Get current MIG mode for the device. | ||
|
|
||
| For Ampere™ or newer fully supported devices. | ||
|
|
||
| Changing MIG modes may require device unbind or reset. The "pending" MIG | ||
| mode refers to the target mode following the next activation trigger. | ||
|
|
||
| If the device is not a MIG device, returns `False`. | ||
|
|
||
| Returns | ||
| ------- | ||
| bool | ||
| `True` if current MIG mode is enabled. | ||
| """ | ||
| if not self.is_mig_device: | ||
| return False | ||
|
|
||
| current, _ = nvml.device_get_mig_mode(self._device._handle) | ||
| return current == nvml.EnableState.FEATURE_ENABLED | ||
|
|
||
| @mode.setter | ||
| def mode(self, mode: bool): | ||
| """ | ||
| Set the MIG mode for the device. | ||
|
|
||
| For Ampere™ or newer fully supported devices. | ||
|
|
||
| Changing MIG modes may require device unbind or reset. The "pending" MIG | ||
| mode refers to the target mode following the next activation trigger. | ||
|
|
||
| Parameters | ||
| ---------- | ||
| mode: bool | ||
| `True` to enable MIG mode, `False` to disable MIG mode. | ||
| """ | ||
| if not self.is_mig_device: | ||
| raise ValueError("Device is not a MIG device") | ||
|
|
||
| nvml.device_set_mig_mode( | ||
| self._device._handle, | ||
| nvml.EnableState.FEATURE_ENABLED if mode else nvml.EnableState.FEATURE_DISABLED | ||
| ) | ||
|
|
||
| @property | ||
| def pending_mode(self) -> bool: | ||
| """ | ||
| Get pending MIG mode for the device. | ||
|
|
||
| For Ampere™ or newer fully supported devices. | ||
|
|
||
| Changing MIG modes may require device unbind or reset. The "pending" MIG | ||
| mode refers to the target mode following the next activation trigger. | ||
|
|
||
| If the device is not a MIG device, returns `False`. | ||
|
|
||
| Returns | ||
| ------- | ||
| bool | ||
| `True` if pending MIG mode is enabled. | ||
| """ | ||
| if not self.is_mig_device: | ||
| return False | ||
|
|
||
| _, pending = nvml.device_get_mig_mode(self._device._handle) | ||
| return pending == nvml.EnableState.FEATURE_ENABLED | ||
|
|
||
| @property | ||
| def device_count(self) -> int: | ||
| """ | ||
| Get the maximum number of MIG devices that can exist under this device. | ||
|
|
||
| Returns zero if MIG is not supported or enabled. | ||
|
|
||
| For Ampere™ or newer fully supported devices. | ||
|
|
||
| Returns | ||
| ------- | ||
| int | ||
| The number of MIG devices (compute instances) on this GPU. | ||
| """ | ||
| return nvml.device_get_max_mig_device_count(self._device._handle) | ||
|
|
||
| @property | ||
| def parent(self) -> Device: | ||
| """ | ||
| For MIG devices, get the parent GPU device. | ||
|
|
||
| For Ampere™ or newer fully supported devices. | ||
|
|
||
| Returns | ||
| ------- | ||
| Device | ||
| The parent GPU device for this MIG device. | ||
| """ | ||
| parent_handle = nvml.device_get_handle_from_mig_device_handle(self._handle) | ||
| parent_device = Device.__new__(Device) | ||
| parent_device._handle = parent_handle | ||
| return parent_device | ||
|
|
||
| def get_device_by_index(self, index: int) -> Device: | ||
| """ | ||
| Get MIG device for the given index under its parent device. | ||
|
|
||
| If the compute instance is destroyed either explicitly or by destroying, | ||
| resetting or unbinding the parent GPU instance or the GPU device itself | ||
| the MIG device handle would remain invalid and must be requested again | ||
| using this API. Handles may be reused and their properties can change in | ||
| the process. | ||
|
|
||
| For Ampere™ or newer fully supported devices. | ||
|
|
||
| Parameters | ||
| ---------- | ||
| index: int | ||
| The index of the MIG device (compute instance) to retrieve. Must be | ||
| between 0 and the value returned by `get_device_count() - 1`. | ||
|
|
||
| Returns | ||
| ------- | ||
| Device | ||
| The MIG device corresponding to the given index. | ||
| """ | ||
| mig_device_handle = nvml.device_get_mig_device_handle_by_index(self._device._handle, index) | ||
| mig_device = Device.__new__(Device) | ||
| mig_device._handle = mig_device_handle | ||
| return mig_device | ||
|
|
||
| def get_all_devices(self) -> Iterable[Device]: | ||
| """ | ||
| Get all MIG devices under its parent device. | ||
|
|
||
| If the compute instance is destroyed either explicitly or by destroying, | ||
| resetting or unbinding the parent GPU instance or the GPU device itself | ||
| the MIG device handle would remain invalid and must be requested again | ||
| using this API. Handles may be reused and their properties can change in | ||
| the process. | ||
|
|
||
| For Ampere™ or newer fully supported devices. | ||
|
|
||
| Returns | ||
| ------- | ||
| list[Device] | ||
| A list of all MIG devices corresponding to this GPU. | ||
| """ | ||
| for i in range(self.get_device_count()): | ||
| yield self.get_device_by_index(i) |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Strong suggestion to move this comment into the docstring, mainly so that it appears in the online documentation.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Got it. Updated.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Minor nit: It'd be nice to be consistent; or simply remove the comment (preferred).
Lower-case here:
Upper-case here: