Fix VirtualMemoryResourceOptions docs (#1150)

* update docstring in virtualresourceoptions

* fix unaligned dic

* match other classes better

* flip self and peer

* update docs to use automatic generation

* Update cuda_core/cuda/core/experimental/_memory.pyx

Co-authored-by: Leo Fang <leo80042@gmail.com>

* Update cuda_core/cuda/core/experimental/_memory.pyx

Co-authored-by: Leo Fang <leo80042@gmail.com>

* Update cuda_core/cuda/core/experimental/_memory.pyx

Co-authored-by: Leo Fang <leo80042@gmail.com>

* Update cuda_core/cuda/core/experimental/_memory.pyx

Co-authored-by: Leo Fang <leo80042@gmail.com>

* Update cuda_core/cuda/core/experimental/_memory.pyx

Co-authored-by: Leo Fang <leo80042@gmail.com>

* Reply to Leo's comments

* Add _memory. qualifier to make docs resolver happy, and remove extra indent

* Apply suggestions from code review

---------

Co-authored-by: Leo Fang <leo80042@gmail.com>
Co-authored-by: Leo Fang <leof@nvidia.com>

Author: benhg

cuda_core/cuda/core/experimental/_memory.pyx

@@ -1089,10 +1089,10 @@ class _SynchronousMemoryResource(MemoryResource):
         return self._dev_id
 
 
-VirtualMemoryHandleTypeT = Literal["posix_fd", "generic", "none", "win32", "win32_kmt", "fabric"]
+VirtualMemoryHandleTypeT = Union[Literal["posix_fd", "generic", "win32", "win32_kmt", "fabric"], None]
 VirtualMemoryLocationTypeT = Literal["device", "host", "host_numa", "host_numa_current"]
 VirtualMemoryGranularityT = Literal["minimum", "recommended"]
-VirtualMemoryAccessTypeT = Literal["rw", "r", "none"]
+VirtualMemoryAccessTypeT = Union[Literal["rw", "r"], None]
 VirtualMemoryAllocationTypeT = Literal["pinned", "managed"]
 
 
@@ -1101,18 +1101,31 @@ class VirtualMemoryResourceOptions:
     """A configuration object for the VirtualMemoryResource
        Stores configuration information which tells the resource how to use the CUDA VMM APIs
 
-    Args:
-        handle_type: Export handle type for the physical allocation. Use
-            CU_MEM_HANDLE_TYPE_POSIX_FILE_DESCRIPTOR on Linux if you plan to
-            import/export the allocation (required for cuMemRetainAllocationHandle).
-            Use CU_MEM_HANDLE_TYPE_NONE if you don't need an exportable handle.
-        gpu_direct_rdma: Hint that the allocation should be GDR-capable (if supported).
-        granularity: 'recommended' or 'minimum'. Controls granularity query and size rounding.
-        addr_hint: A (optional) virtual address hint to try to reserve at. 0 -> let CUDA choose.
-        addr_align: Alignment for the VA reservation. If None, use the queried granularity.
-        peers: Extra device IDs that should be granted access in addition to `device`.
-        self_access: Access flags for the owning device ('rw', 'r', or 'none').
-        peer_access: Access flags for peers ('rw' or 'r').
+    Attributes
+    ----------
+    allocation_type: :obj:`~_memory.VirtualMemoryAllocationTypeT`
+        Controls the type of allocation.
+    location_type: :obj:`~_memory.VirtualMemoryLocationTypeT`
+        Controls the location of the allocation.
+    handle_type: :obj:`~_memory.VirtualMemoryHandleTypeT`
+        Export handle type for the physical allocation. Use
+        ``"posix_fd"`` on Linux if you plan to
+        import/export the allocation (required for cuMemRetainAllocationHandle).
+        Use `None` if you don't need an exportable handle.
+    gpu_direct_rdma: bool
+        Hint that the allocation should be GDR-capable (if supported).
+    granularity: :obj:`~_memory.VirtualMemoryGranularityT`
+        Controls granularity query and size rounding.
+    addr_hint: int
+        A (optional) virtual address hint to try to reserve at. Setting it to 0 lets the CUDA driver decide.
+    addr_align: int
+        Alignment for the VA reservation. If `None`, use the queried granularity.
+    peers: Iterable[int]
+        Extra device IDs that should be granted access in addition to ``device``.
+    self_access: :obj:`~_memory.VirtualMemoryAccessTypeT`
+        Access flags for the owning device.
+    peer_access: :obj:`~_memory.VirtualMemoryAccessTypeT`
+        Access flags for peers.
     """
     # Human-friendly strings; normalized in __post_init__
     allocation_type: VirtualMemoryAllocationTypeT = "pinned"
@@ -1127,9 +1140,9 @@ class VirtualMemoryResourceOptions:
     peer_access: VirtualMemoryAccessTypeT = "rw"
 
     _a = driver.CUmemAccess_flags
-    _access_flags = {"rw": _a.CU_MEM_ACCESS_FLAGS_PROT_READWRITE, "r": _a.CU_MEM_ACCESS_FLAGS_PROT_READ, "none": 0}
+    _access_flags = {"rw": _a.CU_MEM_ACCESS_FLAGS_PROT_READWRITE, "r": _a.CU_MEM_ACCESS_FLAGS_PROT_READ, None: 0}
     _h = driver.CUmemAllocationHandleType
-    _handle_types = {"none": _h.CU_MEM_HANDLE_TYPE_NONE, "posix_fd": _h.CU_MEM_HANDLE_TYPE_POSIX_FILE_DESCRIPTOR, "win32": _h.CU_MEM_HANDLE_TYPE_WIN32, "win32_kmt": _h.CU_MEM_HANDLE_TYPE_WIN32_KMT, "fabric": _h.CU_MEM_HANDLE_TYPE_FABRIC}
+    _handle_types = {None: _h.CU_MEM_HANDLE_TYPE_NONE, "posix_fd": _h.CU_MEM_HANDLE_TYPE_POSIX_FILE_DESCRIPTOR, "win32": _h.CU_MEM_HANDLE_TYPE_WIN32, "win32_kmt": _h.CU_MEM_HANDLE_TYPE_WIN32_KMT, "fabric": _h.CU_MEM_HANDLE_TYPE_FABRIC}
     _g = driver.CUmemAllocationGranularity_flags
     _granularity = {"recommended": _g.CU_MEM_ALLOC_GRANULARITY_RECOMMENDED, "minimum": _g.CU_MEM_ALLOC_GRANULARITY_MINIMUM}
     _l = driver.CUmemLocationType

cuda_core/docs/source/api_private.rst

@@ -18,6 +18,11 @@ CUDA runtime
 
    _memory.PyCapsule
    _memory.DevicePointerT
+   _memory.VirtualMemoryAllocationTypeT
+   _memory.VirtualMemoryLocationTypeT
+   _memory.VirtualMemoryGranularityT
+   _memory.VirtualMemoryAccessTypeT
+   _memory.VirtualMemoryHandleTypeT
    _device.DeviceProperties
    _memory.IPCAllocationHandle
    _memory.IPCBufferDescriptor