Reference for ultralytics/utils/cpu.py#

class CPUInfo:
    """Provide cross-platform CPU brand and model information.

    Query platform-specific sources to retrieve a human-readable CPU descriptor and normalize it for consistent
    presentation across macOS, Linux, and Windows. If platform-specific probing fails, generic platform identifiers are
    used to ensure a stable string is always returned.

    Methods:
        name: Return the normalized CPU name using platform-specific sources with robust fallbacks.
        _sysctl: Read a macOS sysctl string through libc.
        _clean: Normalize and prettify common vendor brand strings and frequency patterns.
        __str__: Return the normalized CPU name for string contexts.

    Examples:
        >>> name = CPUInfo.name()
        >>> text = str(CPUInfo())
    """

def __str__(self) -> str:
    """Return the normalized CPU name."""
    return self.name()

@staticmethod
def _clean(s: str) -> str:
    """Normalize and prettify a raw CPU descriptor string."""
    s = re.sub(r"\s+", " ", s.strip())
    s = s.replace("(TM)", "").replace("(tm)", "").replace("(R)", "").replace("(r)", "").strip()
    if m := re.search(r"(Intel.*?i\d[\w-]*) CPU @ ([\d.]+GHz)", s, re.IGNORECASE):
        return f"{m.group(1)} {m.group(2)}"
    if m := re.search(r"(AMD.*?Ryzen.*?[\w-]*) CPU @ ([\d.]+GHz)", s, re.IGNORECASE):
        return f"{m.group(1)} {m.group(2)}"
    return s

@staticmethod
def _sysctl(key: str) -> str:
    """Read a macOS sysctl string through libc, since spawning `sysctl` costs milliseconds."""
    libc = ctypes.CDLL(None)
    libc.sysctlbyname.restype = ctypes.c_int
    libc.sysctlbyname.argtypes = [
        ctypes.c_char_p,
        ctypes.c_void_p,
        ctypes.POINTER(ctypes.c_size_t),
        ctypes.c_void_p,
        ctypes.c_size_t,
    ]
    name, n = key.encode(), ctypes.c_size_t(0)
    if libc.sysctlbyname(name, None, ctypes.byref(n), None, 0) or not n.value:  # size probe
        return ""
    buf = ctypes.create_string_buffer(n.value)
    if libc.sysctlbyname(name, buf, ctypes.byref(n), None, 0):
        return ""
    return buf.value.decode(errors="ignore").strip()

@staticmethod
def name() -> str:
    """Return a normalized CPU model string from platform-specific sources."""
    try:
        if sys.platform == "darwin":
            # Query macOS sysctl for the CPU brand string
            s = CPUInfo._sysctl("machdep.cpu.brand_string")
            if s:
                return CPUInfo._clean(s)
        elif sys.platform.startswith("linux"):
            # Parse /proc/cpuinfo for the first "model name" entry, streaming since a many-core host
            # repeats a full block per logical CPU and only the first is needed
            p = Path("/proc/cpuinfo")
            if p.exists():
                with p.open(errors="ignore") as f:
                    for line in f:
                        if "model name" in line:
                            return CPUInfo._clean(line.split(":", 1)[1])
        elif sys.platform.startswith("win"):
            try:
                import winreg as wr

                with wr.OpenKey(wr.HKEY_LOCAL_MACHINE, r"HARDWARE\DESCRIPTION\System\CentralProcessor\0") as k:
                    val, _ = wr.QueryValueEx(k, "ProcessorNameString")
                    if val:
                        return CPUInfo._clean(val)
            except Exception:
                # Fall through to generic platform fallbacks on Windows registry access failure
                pass
        # Generic platform fallbacks
        s = platform.processor() or getattr(platform.uname(), "processor", "") or platform.machine()
        return CPUInfo._clean(s or "Unknown CPU")
    except Exception:
        # Ensure a string is always returned even on unexpected failures
        s = platform.processor() or platform.machine() or ""
        return CPUInfo._clean(s or "Unknown CPU")