fix up the documentation for system

Author: ksimpson-work

cuda_core/cuda/core/experimental/__init__.py

@@ -7,4 +7,4 @@
 from cuda.core.experimental._launcher import LaunchConfig, launch
 from cuda.core.experimental._program import Program
 from cuda.core.experimental._stream import Stream, StreamOptions
-from cuda.core.experimental._system import _system_instance as system
+from cuda.core.experimental._system import system

cuda_core/cuda/core/experimental/_system.py

@@ -4,20 +4,22 @@
 from cuda.core.experimental._utils import handle_return
 
 class System:
-    """Represent the system and provide information about the CUDA environment.
-
+    """ Provide information about the cuda system.
     This class is a singleton and should not be instantiated directly.
-    Use the provided instance `system` instead.
     """
 
+    _instance = None
+
     def __new__(cls):
-        if not cls._instance:
+        if cls._instance is None:
             cls._instance = super(System, cls).__new__(cls)
         return cls._instance
 
     def __init__(self):
-        if System._instance is not None:
-            raise RuntimeError("System is a singleton class and should not be instantiated directly.")
+        if hasattr(self, '_initialized') and self._initialized:
+            return
+        self._initialized = True
+        # Initialize other attributes if needed
 
     @property
     def driver_version(self) -> Tuple[int, int]:
@@ -32,8 +34,7 @@ def driver_version(self) -> Tuple[int, int]:
         version = handle_return(cuda.cuDriverGetVersion())
         major = version // 1000
         minor = (version % 1000) // 10
-        self._driver_version = (major, minor)
-        return self._driver_version
+        return (major, minor)
 
     @property
     def num_devices(self) -> int:
@@ -58,7 +59,9 @@ def devices(self) -> tuple:
             A tuple containing instances of available devices.
         """
         total = self.num_devices
-        self._devices = tuple(Device(device_id) for device_id in range(total))
-        return self._devices
+        return tuple(Device(device_id) for device_id in range(total))
 
-_system_instance = System.__new__(System)
+system = System()
+system.__doc__ = """
+Singleton instance of the :obj:`~cuda.core.experimental._system.System` class.
+"""

cuda_core/docs/source/api_private.rst

@@ -16,6 +16,7 @@ CUDA runtime
    _memory.Buffer
    _stream.Stream
    _event.Event
+   _system.System
 
 
 CUDA compilation toolchain

cuda_core/docs/source/conf.py

@@ -13,30 +13,30 @@
 import sys
 from unittest.mock import MagicMock
 
-# Add the path to your module
-sys.path.insert(0, os.path.abspath('../..'))
+# # Add the path to your module
+# sys.path.insert(0, os.path.abspath('../..'))
 
-# Mock the cuda module and its submodules
-class Mock(MagicMock):
-    @classmethod
-    def __getattr__(cls, name):
-        return MagicMock()
+# # Mock the cuda module and its submodules
+# class Mock(MagicMock):
+#     @classmethod
+#     def __getattr__(cls, name):
+#         return MagicMock()
 
-MOCK_MODULES = ['cuda.core.experimental._system']
-sys.modules.update((mod_name, Mock()) for mod_name in MOCK_MODULES)
+# MOCK_MODULES = ['cuda.core.experimental._system']
+# sys.modules.update((mod_name, Mock()) for mod_name in MOCK_MODULES)
 
-class SystemMock(MagicMock):
-    __doc__ = "Singleton instance of :class:`cuda.core.experimental._system.System`"
+# class SystemMock(MagicMock):
+#     __doc__ = "Singleton instance of :obj:`~cuda.core.experimental._system.System`"
 
 
-# Mock the System class within the _system module
-sys.modules['cuda.core.experimental._system'].System = SystemMock
+# # Mock the System class within the _system module
+# sys.modules['cuda.core.experimental._system'].System = SystemMock
 
-# Create a specific mock for the system instance
-system_mock = SystemMock()
+# # Create a specific mock for the system instance
+# system_mock = SystemMock()
 
-# Ensure the system instance is correctly mocked
-sys.modules['cuda.core.experimental._system']._system_instance = system_mock
+# # Ensure the system instance is correctly mocked
+# sys.modules['cuda.core.experimental._system']._system_instance = system_mock
 
 # -- Project information -----------------------------------------------------