cuda.core.system: Naming improvements suggested in #1945

Author: mdboom

cuda_core/cuda/core/system/_device.pyx

@@ -215,23 +215,23 @@ cdef class Device:
         return nvml.device_get_minor_number(self._handle)
 
     @property
-    def is_c2c_mode_enabled(self) -> bool:
+    def is_c2c_enabled(self) -> bool:
         """
         Whether the C2C (Chip-to-Chip) mode is enabled for this device.
         """
         return bool(nvml.device_get_c2c_mode_info_v(self._handle).is_c2c_enabled)
 
     @property
-    def persistence_mode_enabled(self) -> bool:
+    def persistence_mode(self) -> bool:
         """
         Whether persistence mode is enabled for this device.
 
         For Linux only.
         """
         return nvml.device_get_persistence_mode(self._handle) == nvml.EnableState.FEATURE_ENABLED
 
-    @persistence_mode_enabled.setter
-    def persistence_mode_enabled(self, enabled: bool) -> None:
+    @persistence_mode.setter
+    def persistence_mode(self, enabled: bool) -> None:
         nvml.device_set_persistence_mode(
             self._handle,
             nvml.EnableState.FEATURE_ENABLED if enabled else nvml.EnableState.FEATURE_DISABLED
@@ -409,13 +409,14 @@ cdef class Device:
     # CLOCK
     # See external class definitions in _clock.pxi
 
-    def clock(self, clock_type: ClockType) -> ClockInfo:
+    def get_clock(self, clock_type: ClockType) -> ClockInfo:
         """
         Get information about and manage a specific clock on a device.
         """
         return ClockInfo(self._handle, clock_type)
 
-    def get_auto_boosted_clocks_enabled(self) -> tuple[bool, bool]:
+    @property
+    def is_auto_boosted_clocks_enabled(self) -> tuple[bool, bool]:
         """
         Retrieve the current state of auto boosted clocks on a device.
 
@@ -440,7 +441,8 @@ cdef class Device:
         current, default = nvml.device_get_auto_boosted_clocks_enabled(self._handle)
         return current == nvml.EnableState.FEATURE_ENABLED, default == nvml.EnableState.FEATURE_ENABLED
 
-    def get_current_clock_event_reasons(self) -> list[ClocksEventReasons]:
+    @property
+    def current_clock_event_reasons(self) -> list[ClocksEventReasons]:
         """
         Retrieves the current clocks event reasons.
 
@@ -450,7 +452,8 @@ cdef class Device:
         reasons[0] = nvml.device_get_current_clocks_event_reasons(self._handle)
         return [ClocksEventReasons(1 << reason) for reason in _unpack_bitmask(reasons)]
 
-    def get_supported_clock_event_reasons(self) -> list[ClocksEventReasons]:
+    @property
+    def supported_clock_event_reasons(self) -> list[ClocksEventReasons]:
         """
         Retrieves supported clocks event reasons that can be returned by
         :meth:`get_current_clock_event_reasons`.
@@ -492,17 +495,17 @@ cdef class Device:
     # DISPLAY
 
     @property
-    def display_mode(self) -> bool:
+    def is_display_connected(self) -> bool:
         """
         The display mode for this device.
 
         Indicates whether a physical display (e.g. monitor) is currently connected to
         any of the device's connectors.
         """
-        return True if nvml.device_get_display_mode(self._handle) == nvml.EnableState.FEATURE_ENABLED else False
+        return nvml.device_get_display_mode(self._handle) == nvml.EnableState.FEATURE_ENABLED
 
     @property
-    def display_active(self) -> bool:
+    def is_display_active(self) -> bool:
         """
         The display active status for this device.
 
@@ -512,7 +515,7 @@ cdef class Device:
 
         Display can be active even when no monitor is physically attached.
         """
-        return True if nvml.device_get_display_active(self._handle) == nvml.EnableState.FEATURE_ENABLED else False
+        return nvml.device_get_display_active(self._handle) == nvml.EnableState.FEATURE_ENABLED
 
     ##########################################################################
     # EVENTS
@@ -580,7 +583,7 @@ cdef class Device:
     # FAN
     # See external class definitions in _fan.pxi
 
-    def fan(self, fan: int = 0) -> FanInfo:
+    def get_fan(self, fan: int = 0) -> FanInfo:
         """
         Get information and manage a specific fan on a device.
         """
@@ -707,7 +710,8 @@ cdef class Device:
         """
         return GpuDynamicPstatesInfo(nvml.device_get_dynamic_pstates_info(self._handle))
 
-    def get_supported_pstates(self) -> list[Pstates]:
+    @property
+    def supported_pstates(self) -> list[Pstates]:
         """
         Get all supported Performance States (P-States) for the device.
 

cuda_core/cuda/core/system/_fan.pxi

@@ -96,7 +96,7 @@ cdef class FanInfo:
         """
         return FanControlPolicy(nvml.device_get_fan_control_policy_v2(self._handle, self._fan))
 
-    def set_default_fan_speed(self):
+    def set_default_speed(self):
         """
         Set the speed of the fan control policy to default.
 

cuda_core/cuda/core/system/_inforom.pxi

@@ -12,7 +12,8 @@ cdef class InforomInfo:
     def __init__(self, device: Device):
         self._device = device
 
-    def get_version(self, inforom: InforomObject) -> str:
+    @property
+    def version(self, inforom: InforomObject) -> str:
         """
         Retrieves the InfoROM version for a given InfoROM object.
 

cuda_core/cuda/core/system/_pci_info.pxi

@@ -81,7 +81,8 @@ cdef class PciInfo:
         """
         return self._pci_info_ext.sub_class
 
-    def get_max_pcie_link_generation(self) -> int:
+    @property
+    def link_generation(self) -> int:
         """
         Retrieve the maximum PCIe link generation possible with this device and system.
 
@@ -93,15 +94,17 @@ cdef class PciInfo:
         """
         return nvml.device_get_max_pcie_link_generation(self._handle)
 
-    def get_gpu_max_pcie_link_generation(self) -> int:
+    @property
+    def max_link_generation(self) -> int:
         """
         Retrieve the maximum PCIe link generation supported by this GPU device.
 
         For Fermi™ or newer fully supported devices.
         """
         return nvml.device_get_gpu_max_pcie_link_generation(self._handle)
 
-    def get_max_pcie_link_width(self) -> int:
+    @property
+    def max_link_width(self) -> int:
         """
         Retrieve the maximum PCIe link width possible with this device and system.
 
@@ -113,23 +116,26 @@ cdef class PciInfo:
         """
         return nvml.device_get_max_pcie_link_width(self._handle)
 
-    def get_current_pcie_link_generation(self) -> int:
+    @property
+    def current_link_generation(self) -> int:
         """
         Retrieve the current PCIe link generation.
 
         For Fermi™ or newer fully supported devices.
         """
         return nvml.device_get_curr_pcie_link_generation(self._handle)
 
-    def get_current_pcie_link_width(self) -> int:
+    @property
+    def current_link_width(self) -> int:
         """
         Retrieve the current PCIe link width.
 
         For Fermi™ or newer fully supported devices.
         """
         return nvml.device_get_curr_pcie_link_width(self._handle)
 
-    def get_pcie_throughput(self, counter: PcieUtilCounter) -> int:
+    @property
+    def throughput(self, counter: PcieUtilCounter) -> int:
         """
         Retrieve PCIe utilization information, in KB/s.
 
@@ -143,7 +149,8 @@ cdef class PciInfo:
         """
         return nvml.device_get_pcie_throughput(self._handle, counter)
 
-    def get_pcie_replay_counter(self) -> int:
+    @property
+    def replay_counter(self) -> int:
         """
         Retrieve the PCIe replay counter.
 

cuda_core/cuda/core/system/_temperature.pxi

@@ -77,7 +77,7 @@ cdef class Temperature:
     def __init__(self, handle: int):
         self._handle = handle
 
-    def sensor(
+    def get_sensor(
         self,
         sensor: TemperatureSensors = TemperatureSensors.TEMPERATURE_GPU
     ) -> int:
@@ -97,7 +97,7 @@ cdef class Temperature:
         """
         return nvml.device_get_temperature_v(self._handle, sensor)
 
-    def threshold(self, threshold_type: TemperatureThresholds) -> int:
+    def get_threshold(self, threshold_type: TemperatureThresholds) -> int:
         """
         Retrieves the temperature threshold for this GPU with the specified
         threshold type, in degrees Celsius.
@@ -127,7 +127,7 @@ cdef class Temperature:
         """
         return nvml.device_get_margin_temperature(self._handle)
 
-    def thermal_settings(self, sensor_index: ThermalTarget) -> ThermalSettings:
+    def get_thermal_settings(self, sensor_index: ThermalTarget) -> ThermalSettings:
         """
         Used to execute a list of thermal system instructions.