cleanup existing code

Author: Titus-von-Koeller

bitsandbytes/cextension.py

@@ -62,7 +62,7 @@ def __init__(self, lib: ct.CDLL):
         lib.cget_managed_ptr.restype = ct.c_void_p
 
 
-def get_available_cuda_binaries() -> list[str]:
+def get_available_cuda_binary_versions() -> list[str]:
     """Get formatted CUDA versions from existing library files using cuda_specs logic"""
     lib_pattern = f"libbitsandbytes_cuda*{DYNAMIC_LIBRARY_SUFFIX}"
     versions = []
@@ -86,26 +86,23 @@ def parse_cuda_version(version_str: str) -> str:
 def _format_cuda_error_message(
     available_versions: list[str],
     user_cuda_version: str,
-    override_info: str,
     original_error: str = "",
-    include_diagnostics: bool = False,
-    include_override_notes: bool = False,
-    required_version: Optional[str] = None,
-    version_missing: bool = False,
+    requested_version: Optional[str] = None,
 ) -> str:
-    version_list = ", ".join(available_versions) if available_versions else "none"
     base_msg = "Attempted to use bitsandbytes native library functionality but it's not available.\n\n"
 
-    # Explicit version availability check
     version_alert = ""
-    if version_missing and required_version:
-        version_list_str = "\n- " + "\n- ".join(available_versions) if available_versions else "NONE"
+    if requested_version not in available_versions:
+        version_list_str = "\n  - " + "\n  - ".join(available_versions) if available_versions else "NONE"
         version_alert = (
             f"🚨 CUDA VERSION MISMATCH 🚨\n"
-            f"Requested CUDA version:  {required_version}\n"
+            f"Requested CUDA version:          {requested_version}\n"
+            f"Detected PyTorch CUDA version:   {user_cuda_version}\n"
             f"Available pre-compiled versions: {version_list_str}\n\n"
             "This means:\n"
             "1. The version you're trying to use is NOT distributed with this package\n"
+            if available_versions
+            else "1. You're not using the package but checked-out the source code\n"
             "2. You MUST compile from source for this specific CUDA version\n"
             "3. The installation will NOT work until you compile or choose a CUDA supported version\n\n"
         )
@@ -122,43 +119,25 @@ def _format_cuda_error_message(
         "If your CUDA version doesn't have a pre-compiled binary, you MUST compile from source.\n\n"
     )
 
-    cuda_info = (
-        f"Detected PyTorch CUDA version: {user_cuda_version}\n"
-        f"Available pre-compiled bitsandbytes binaries for these CUDA versions: {version_list}\n"
-        f"{override_info}\n\n"
-    )
-
     compile_instructions = (
-        (
-            "You have three options:\n"
-            "1. COMPILE FROM SOURCE (required if no binary exists):\n"
-            "   https://huggingface.co/docs/bitsandbytes/main/en/installation#cuda-compile\n"
-            "2. Use BNB_CUDA_VERSION to specify a DIFFERENT CUDA version from the detected one\n"
-            "3. Check LD_LIBRARY_PATH contains the correct CUDA libraries\n\n"
-        )
-        if include_override_notes
-        else ""
+        "You have three options:\n"
+        "1. COMPILE FROM SOURCE (required if no binary exists):\n"
+        "   https://huggingface.co/docs/bitsandbytes/main/en/installation#cuda-compile\n"
+        "2. Use BNB_CUDA_VERSION to specify a DIFFERENT CUDA version from the detected one, which is installed on your machine and matching an available pre-compiled version listed above\n"
+        "3. Check LD_LIBRARY_PATH contains the correct CUDA libraries\n\n"
     )
 
     diagnostics = (
-        (
-            "🔍 Run this command for detailed diagnostics:\n"
-            "python -m bitsandbytes\n\n"
-            "If you've tried everything and still have issues:\n"
-            "1. Include ALL version info (operating system, bitsandbytes, pytorch, cuda, python)\n"
-            "2. Describe what you've tried in detail\n"
-            "3. Open an issue with this information:\n"
-            "   https://github.com/bitsandbytes-foundation/bitsandbytes/issues\n\n"
-        )
-        if include_diagnostics
-        else ""
+        "🔍 Run this command for detailed diagnostics:\n"
+        "python -m bitsandbytes\n\n"
+        "If you've tried everything and still have issues:\n"
+        "1. Include ALL version info (operating system, bitsandbytes, pytorch, cuda, python)\n"
+        "2. Describe what you've tried in detail\n"
+        "3. Open an issue with this information:\n"
+        "   https://github.com/bitsandbytes-foundation/bitsandbytes/issues\n\n"
     )
 
-    return (
-        f"{version_alert}{base_msg}{troubleshooting}{cuda_info}"
-        f"{note}{compile_instructions}"
-        f"{original_error}\n{diagnostics}"
-    )
+    return f"{version_alert}{base_msg}{troubleshooting}{note}{compile_instructions}{original_error}\n{diagnostics}"
 
 
 class MockBNBNativeLibrary(BNBNativeLibrary):
@@ -174,26 +153,20 @@ def __init__(self, error_msg: str):
         self.user_cuda_version = get_cuda_version_tuple()
 
     def __getattr__(self, name):
-        available_versions = get_available_cuda_binaries()
+        available_versions = get_available_cuda_binary_versions()
         override_value = os.environ.get("BNB_CUDA_VERSION")
-        override_info = f"\nCUDA override: BNB_CUDA_VERSION={override_value}" if override_value else ""
 
-        formatted_version = (
+        requested_version = (
             parse_cuda_version(override_value)
             if override_value
             else f"{self.user_cuda_version[0]}.{self.user_cuda_version[1]}"
         )
-        required_version = formatted_version
-        version_missing = required_version not in available_versions
 
         msg = _format_cuda_error_message(
             available_versions=available_versions,
             user_cuda_version=f"{self.user_cuda_version[0]}.{self.user_cuda_version[1]}",
-            override_info=override_info,
             original_error=f"Original error: {self.error_msg}\n" if self.error_msg else "",
-            include_diagnostics=True,
-            required_version=formatted_version,
-            version_missing=version_missing,
+            requested_version=requested_version,
         )
         raise RuntimeError(msg)
 
@@ -212,21 +185,15 @@ def get_native_library() -> BNBNativeLibrary:
         if cuda_binary_path.exists():
             binary_path = cuda_binary_path
         else:
-            available_versions = get_available_cuda_binaries()
+            available_versions = get_available_cuda_binary_versions()
             env_version = os.environ.get("BNB_CUDA_VERSION")
-            override_info = "\nCUDA override active" if env_version else ""
 
-            formatted_version = parse_cuda_version(env_version) if env_version else cuda_specs.cuda_version_string
-            required_version = formatted_version
-            version_missing = required_version not in available_versions
+            requested_version = parse_cuda_version(env_version) if env_version else cuda_specs.cuda_version_string
 
             msg = _format_cuda_error_message(
                 available_versions=available_versions,
                 user_cuda_version=cuda_specs.cuda_version_string,
-                override_info=override_info,
-                include_override_notes=True,
-                required_version=formatted_version,
-                version_missing=version_missing,
+                requested_version=requested_version,
             )
             logger.warning(msg)
 
@@ -249,19 +216,5 @@ def get_native_library() -> BNBNativeLibrary:
     error_msg = f"Could not load bitsandbytes native library: {e}"
     logger.error(error_msg, exc_info=False)
 
-    diagnostic_help = ""
-    if torch.cuda.is_available():
-        diagnostic_help = (
-            "CUDA Setup failed despite CUDA being available.\n\n"
-            "Please run the following command to get more information:\n\n"
-            "python -m bitsandbytes\n\n"
-            "Inspect the output of the command and see if you can locate CUDA libraries. "
-            "You might need to add them to your LD_LIBRARY_PATH. "
-            "If you suspect a bug, please take the information from the command and open an issue at:\n\n"
-            "https://github.com/bitsandbytes-foundation/bitsandbytes/issues\n\n"
-            "If you are using a custom CUDA version, you might need to set the BNB_CUDA_VERSION "
-            "environment variable to the correct version."
-        )
-
     # create a mock with error messaging as fallback
-    lib = MockBNBNativeLibrary(diagnostic_help)
+    lib = MockBNBNativeLibrary(error_msg)