Skip to content

Reference for ultralytics/utils/cpu.py

Improvements

This page is sourced from https://github.com/ultralytics/ultralytics/blob/main/ultralytics/utils/cpu.py. Have an improvement or example to add? Open a Pull Request — thank you! 🙏


Summary

class ultralytics.utils.cpu.CPUInfo

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

NameDescription
__str__Return the normalized CPU name.
_cleanNormalize and prettify a raw CPU descriptor string.
nameReturn a normalized CPU model string from platform-specific sources.

Examples

>>> CPUInfo.name()
'Apple M4 Pro'
>>> str(CPUInfo())
'Intel Core i7-9750H 2.60GHz'
Source code in ultralytics/utils/cpu.pyView on GitHub
class CPUInfo:


method ultralytics.utils.cpu.CPUInfo.__str__

def __str__(self) -> str

Return the normalized CPU name.

Source code in ultralytics/utils/cpu.pyView on GitHub
def __str__(self) -> str:
    """Return the normalized CPU name."""
    return self.name()


method ultralytics.utils.cpu.CPUInfo._clean

def _clean(s: str) -> str

Normalize and prettify a raw CPU descriptor string.

Args

NameTypeDescriptionDefault
sstrrequired
Source code in ultralytics/utils/cpu.pyView on GitHub
@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.I):
        return f"{m.group(1)} {m.group(2)}"
    if m := re.search(r"(AMD.*?Ryzen.*?[\w-]*) CPU @ ([\d.]+GHz)", s, re.I):
        return f"{m.group(1)} {m.group(2)}"
    return s


method ultralytics.utils.cpu.CPUInfo.name

def name() -> str

Return a normalized CPU model string from platform-specific sources.

Source code in ultralytics/utils/cpu.pyView on GitHub
@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 = subprocess.run(
                ["sysctl", "-n", "machdep.cpu.brand_string"], capture_output=True, text=True
            ).stdout.strip()
            if s:
                return CPUInfo._clean(s)
        elif sys.platform.startswith("linux"):
            # Parse /proc/cpuinfo for the first "model name" entry
            p = Path("/proc/cpuinfo")
            if p.exists():
                for line in p.read_text(errors="ignore").splitlines():
                    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")





📅 Created 3 months ago ✏️ Updated 18 days ago
glenn-jocher