Skip to content

Commit 74fccc7

Browse files
committed
simplify docstrings
1 parent 82d674f commit 74fccc7

File tree

1 file changed

+18
-116
lines changed

1 file changed

+18
-116
lines changed

cuda_core/cuda/core/experimental/_device.pyx

Lines changed: 18 additions & 116 deletions
Original file line numberDiff line numberDiff line change
@@ -791,132 +791,66 @@ cdef class DeviceProperties:
791791

792792
@property
793793
def tensor_map_access_supported(self) -> bool:
794-
"""
795-
Device supports accessing memory using Tensor Map.
796-
797-
Returns:
798-
bool: Device supports accessing memory using Tensor Map.
799-
"""
794+
"""bool: Device supports accessing memory using Tensor Map."""
800795
return bool(
801796
self._get_cached_attribute(driver.CUdevice_attribute.CU_DEVICE_ATTRIBUTE_TENSOR_MAP_ACCESS_SUPPORTED)
802797
)
803798

804799
@property
805800
def handle_type_fabric_supported(self) -> bool:
806-
"""
807-
Device supports exporting memory to a fabric handle with cuMemExportToShareableHandle() or requested
808-
with cuMemCreate().
809-
810-
Returns:
811-
bool: Device supports exporting memory to a fabric handle with cuMemExportToShareableHandle() or requested
812-
with cuMemCreate().
813-
"""
801+
"""bool: Device supports exporting memory to a fabric handle with cuMemExportToShareableHandle() or requested with cuMemCreate()."""
814802
return bool(
815803
self._get_cached_attribute(driver.CUdevice_attribute.CU_DEVICE_ATTRIBUTE_HANDLE_TYPE_FABRIC_SUPPORTED)
816804
)
817805

818806
@property
819807
def unified_function_pointers(self) -> bool:
820-
"""
821-
Device supports unified function pointers.
822-
823-
Returns:
824-
bool: Device supports unified function pointers.
825-
"""
808+
"""bool: Device supports unified function pointers."""
826809
return bool(self._get_cached_attribute(driver.CUdevice_attribute.CU_DEVICE_ATTRIBUTE_UNIFIED_FUNCTION_POINTERS))
827810

828811
@property
829812
def mps_enabled(self) -> bool:
830-
"""
831-
Indicates if contexts created on this device will be shared via MPS.
832-
833-
Returns:
834-
bool: Indicates if contexts created on this device will be shared via MPS.
835-
"""
813+
"""bool: Indicates if contexts created on this device will be shared via MPS."""
836814
return bool(self._get_cached_attribute(driver.CUdevice_attribute.CU_DEVICE_ATTRIBUTE_MPS_ENABLED))
837815

838816
@property
839817
def host_numa_id(self) -> int:
840-
"""
841-
NUMA ID of the host node closest to the device. Returns -1 when system does not support NUMA.
842-
843-
Returns:
844-
int: NUMA ID of the host node closest to the device. Returns -1 when system does not support NUMA.
845-
"""
818+
"""int: NUMA ID of the host node closest to the device. Returns -1 when system does not support NUMA."""
846819
return self._get_cached_attribute(driver.CUdevice_attribute.CU_DEVICE_ATTRIBUTE_HOST_NUMA_ID)
847820

848821
@property
849822
def d3d12_cig_supported(self) -> bool:
850-
"""
851-
Device supports CIG with D3D12.
852-
853-
Returns:
854-
bool: Device supports CIG with D3D12.
855-
"""
823+
"""bool: Device supports CIG with D3D12."""
856824
return bool(self._get_cached_attribute(driver.CUdevice_attribute.CU_DEVICE_ATTRIBUTE_D3D12_CIG_SUPPORTED))
857825

858826
@property
859827
def mem_decompress_algorithm_mask(self) -> int:
860-
"""
861-
The returned valued shall be interpreted as a bitmask, where the individual bits are described by
862-
the CUmemDecompressAlgorithm enum.
863-
864-
Returns:
865-
int: The returned valued shall be interpreted as a bitmask, where the individual bits are described by
866-
the CUmemDecompressAlgorithm enum.
867-
"""
828+
"""int: The returned valued shall be interpreted as a bitmask, where the individual bits are described by the CUmemDecompressAlgorithm enum."""
868829
return self._get_cached_attribute(driver.CUdevice_attribute.CU_DEVICE_ATTRIBUTE_MEM_DECOMPRESS_ALGORITHM_MASK)
869830

870831
@property
871832
def mem_decompress_maximum_length(self) -> int:
872-
"""
873-
The returned valued is the maximum length in bytes of a single decompress operation that is allowed.
874-
875-
Returns:
876-
int: The returned valued is the maximum length in bytes of a single decompress operation that is allowed.
877-
"""
833+
"""int: The returned valued is the maximum length in bytes of a single decompress operation that is allowed."""
878834
return self._get_cached_attribute(driver.CUdevice_attribute.CU_DEVICE_ATTRIBUTE_MEM_DECOMPRESS_MAXIMUM_LENGTH)
879835

880836
@property
881837
def vulkan_cig_supported(self) -> bool:
882-
"""
883-
Device supports CIG with Vulkan.
884-
885-
Returns:
886-
bool: Device supports CIG with Vulkan.
887-
"""
838+
"""bool: Device supports CIG with Vulkan."""
888839
return bool(self._get_cached_attribute(driver.CUdevice_attribute.CU_DEVICE_ATTRIBUTE_VULKAN_CIG_SUPPORTED))
889840

890841
@property
891842
def gpu_pci_device_id(self) -> int:
892-
"""
893-
The combined 16-bit PCI device ID and 16-bit PCI vendor ID.
894-
895-
Returns:
896-
int: The combined 16-bit PCI device ID and 16-bit PCI vendor ID.
897-
"""
843+
"""int: The combined 16-bit PCI device ID and 16-bit PCI vendor ID."""
898844
return self._get_cached_attribute(driver.CUdevice_attribute.CU_DEVICE_ATTRIBUTE_GPU_PCI_DEVICE_ID)
899845

900846
@property
901847
def gpu_pci_subsystem_id(self) -> int:
902-
"""
903-
The combined 16-bit PCI subsystem ID and 16-bit PCI subsystem vendor ID.
904-
905-
Returns:
906-
int: The combined 16-bit PCI subsystem ID and 16-bit PCI subsystem vendor ID.
907-
"""
848+
"""int: The combined 16-bit PCI subsystem ID and 16-bit PCI subsystem vendor ID."""
908849
return self._get_cached_attribute(driver.CUdevice_attribute.CU_DEVICE_ATTRIBUTE_GPU_PCI_SUBSYSTEM_ID)
909850

910851
@property
911852
def host_numa_virtual_memory_management_supported(self) -> bool:
912-
"""
913-
Device supports HOST_NUMA location with the virtual memory management APIs like cuMemCreate, cuMemMap and
914-
related APIs.
915-
916-
Returns:
917-
bool: Device supports HOST_NUMA location with the virtual memory management APIs like cuMemCreate, cuMemMap
918-
and related APIs.
919-
"""
853+
"""bool: Device supports HOST_NUMA location with the virtual memory management APIs like cuMemCreate, cuMemMap and related APIs."""
920854
return bool(
921855
self._get_cached_attribute(
922856
driver.CUdevice_attribute.CU_DEVICE_ATTRIBUTE_HOST_NUMA_VIRTUAL_MEMORY_MANAGEMENT_SUPPORTED
@@ -925,50 +859,28 @@ cdef class DeviceProperties:
925859

926860
@property
927861
def host_numa_memory_pools_supported(self) -> bool:
928-
"""
929-
Device supports HOST_NUMA location with the cuMemAllocAsync and cuMemPool family of APIs.
930-
931-
Returns:
932-
bool: Device supports HOST_NUMA location with the cuMemAllocAsync and cuMemPool family of APIs.
933-
"""
862+
"""bool: Device supports HOST_NUMA location with the cuMemAllocAsync and cuMemPool family of APIs."""
934863
return bool(
935864
self._get_cached_attribute(driver.CUdevice_attribute.CU_DEVICE_ATTRIBUTE_HOST_NUMA_MEMORY_POOLS_SUPPORTED)
936865
)
937866

938867
@property
939868
def host_numa_multinode_ipc_supported(self) -> bool:
940-
"""
941-
Device supports HOST_NUMA location IPC between nodes in a multi-node system.
942-
943-
Returns:
944-
bool: Device supports HOST_NUMA location IPC between nodes in a multi-node system.
945-
"""
869+
"""bool: Device supports HOST_NUMA location IPC between nodes in a multi-node system."""
946870
return bool(
947871
self._get_cached_attribute(driver.CUdevice_attribute.CU_DEVICE_ATTRIBUTE_HOST_NUMA_MULTINODE_IPC_SUPPORTED)
948872
)
949873

950874
@property
951875
def host_memory_pools_supported(self) -> bool:
952-
"""
953-
Device suports HOST location with the cuMemAllocAsync and cuMemPool family of APIs.
954-
955-
Returns:
956-
bool: Device suports HOST location with the cuMemAllocAsync and cuMemPool family of APIs.
957-
"""
876+
"""bool: Device suports HOST location with the cuMemAllocAsync and cuMemPool family of APIs."""
958877
return bool(
959878
self._get_cached_attribute(driver.CUdevice_attribute.CU_DEVICE_ATTRIBUTE_HOST_MEMORY_POOLS_SUPPORTED)
960879
)
961880

962881
@property
963882
def host_virtual_memory_management_supported(self) -> bool:
964-
"""
965-
Device supports HOST location with the virtual memory management APIs like cuMemCreate, cuMemMap and related
966-
APIs.
967-
968-
Returns:
969-
bool: Device supports HOST location with the virtual memory management APIs like cuMemCreate, cuMemMap and
970-
related APIs.
971-
"""
883+
"""bool: Device supports HOST location with the virtual memory management APIs like cuMemCreate, cuMemMap and related APIs."""
972884
return bool(
973885
self._get_cached_attribute(
974886
driver.CUdevice_attribute.CU_DEVICE_ATTRIBUTE_HOST_VIRTUAL_MEMORY_MANAGEMENT_SUPPORTED
@@ -977,24 +889,14 @@ cdef class DeviceProperties:
977889

978890
@property
979891
def host_alloc_dma_buf_supported(self) -> bool:
980-
"""
981-
Device supports page-locked host memory buffer sharing with dma_buf mechanism.
982-
983-
Returns:
984-
bool: Device supports page-locked host memory buffer sharing with dma_buf mechanism.
985-
"""
892+
"""bool: Device supports page-locked host memory buffer sharing with dma_buf mechanism."""
986893
return bool(
987894
self._get_cached_attribute(driver.CUdevice_attribute.CU_DEVICE_ATTRIBUTE_HOST_ALLOC_DMA_BUF_SUPPORTED)
988895
)
989896

990897
@property
991898
def only_partial_host_native_atomic_supported(self) -> bool:
992-
"""
993-
Link between the device and the host supports only some native atomic operations.
994-
995-
Returns:
996-
bool: Link between the device and the host supports only some native atomic operations.
997-
"""
899+
"""bool: Link between the device and the host supports only some native atomic operations."""
998900
return bool(
999901
self._get_cached_attribute(
1000902
driver.CUdevice_attribute.CU_DEVICE_ATTRIBUTE_ONLY_PARTIAL_HOST_NATIVE_ATOMIC_SUPPORTED

0 commit comments

Comments
 (0)