Skip to content

utils/device_info module

device_info

Classes

Functions

detect_darwin 

detect_darwin(specs: dict[str, Any]) -> dict[str, Any]

Detect hardware specifications on macOS, including CPU and GPU details.

Parameters:

Name Type Description Default
specs dict

Initial dictionary containing OS information.

 required

Returns:

Type Description
dict

Updated dictionary with CPU architecture and GPU type for macOS.
Source code in color_correction/utils/device_info.py 
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
def detect_darwin(specs: dict[str, Any]) -> dict[str, Any]:
    """
    Detect hardware specifications on macOS, including CPU and GPU details.

    Parameters
    ----------
    specs : dict
        Initial dictionary containing OS information.

    Returns
    -------
    dict
        Updated dictionary with CPU architecture and GPU type for macOS.
    """
    try:
        cpu_info = subprocess.check_output(
            ["sysctl", "-n", "machdep.cpu.brand_string"],
        ).decode()
        specs["is_apple_silicon"] = "Apple" in cpu_info
        specs["cpu_arch"] = (
            CPUArchitecture.APPLE if "Apple" in cpu_info else CPUArchitecture.INTEL
        )
    except subprocess.SubprocessError:
        specs["cpu_arch"] = CPUArchitecture.UNKNOWN

    try:
        gpu_info = subprocess.check_output(
            ["system_profiler", "SPDisplaysDataType"],
        ).decode()
        if "Apple M" in gpu_info:
            specs["gpu_type"] = GPUType.APPLE
        elif "AMD" in gpu_info:
            specs["gpu_type"] = GPUType.AMD
        elif "NVIDIA" in gpu_info:
            specs["gpu_type"] = GPUType.NVIDIA
        else:
            specs["gpu_type"] = GPUType.UNKNOWN
    except subprocess.SubprocessError:
        specs["gpu_type"] = GPUType.UNKNOWN

    return specs

detect_linux 

detect_linux(specs: dict[str, Any]) -> dict[str, Any]

Detect hardware specifications on Linux systems.

Parameters:

Name Type Description Default
specs dict

Initial dictionary with OS information.

 required

Returns:

Type Description
dict

Updated dictionary with CPU architecture and GPU type for Linux.
Source code in color_correction/utils/device_info.py 
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
def detect_linux(specs: dict[str, Any]) -> dict[str, Any]:
    """
    Detect hardware specifications on Linux systems.

    Parameters
    ----------
    specs : dict
        Initial dictionary with OS information.

    Returns
    -------
    dict
        Updated dictionary with CPU architecture and GPU type for Linux.
    """
    try:
        cpu_info = subprocess.check_output("lscpu", shell=True).decode().lower()
        specs["cpu_arch"] = (
            CPUArchitecture.ARM if "aarch64" in cpu_info else CPUArchitecture.INTEL
        )
    except subprocess.SubprocessError:
        specs["cpu_arch"] = CPUArchitecture(platform.machine())

    # GPU detection
    try:
        subprocess.check_output("nvidia-smi", shell=True)
        specs["gpu_type"] = GPUType.NVIDIA
    except subprocess.SubprocessError:
        try:
            amd_info = (
                subprocess.check_output(
                    "lspci | grep -i amd",
                    shell=True,
                )
                .decode()
                .lower()
            )
            specs["gpu_type"] = (
                GPUType.AMD
                if ("vga" in amd_info or "amd" in amd_info)
                else GPUType.UNKNOWN
            )
        except subprocess.SubprocessError:
            specs["gpu_type"] = GPUType.UNKNOWN

    return specs

detect_windows 

detect_windows(specs: dict[str, Any]) -> dict[str, Any]

Detect hardware specifications on Windows systems.

Parameters:

Name Type Description Default
specs dict

Initial dictionary with OS information.

 required

Returns:

Type Description
dict

Updated dictionary with CPU architecture and GPU type for Windows.
Source code in color_correction/utils/device_info.py 
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
def detect_windows(specs: dict[str, Any]) -> dict[str, Any]:
    """
    Detect hardware specifications on Windows systems.

    Parameters
    ----------
    specs : dict
        Initial dictionary with OS information.

    Returns
    -------
    dict
        Updated dictionary with CPU architecture and GPU type for Windows.
    """
    proc = platform.processor().lower()
    if "intel" in proc:
        specs["cpu_arch"] = CPUArchitecture.INTEL
    elif "amd" in proc:
        specs["cpu_arch"] = CPUArchitecture.AMD
    elif "arm" in proc:
        specs["cpu_arch"] = CPUArchitecture.ARM
    else:
        specs["cpu_arch"] = CPUArchitecture.UNKNOWN

    specs["gpu_type"] = GPUType.UNKNOWN
    return specs

get_device_specs 

get_device_specs() -> DeviceSpecs

Retrieve a structured set of device hardware specifications.

Returns:

Type Description
DeviceSpecs

An object containing OS name, CPU architecture, GPU type, and Apple Silicon flag.
Source code in color_correction/utils/device_info.py 
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
def get_device_specs() -> DeviceSpecs:
    """
    Retrieve a structured set of device hardware specifications.

    Returns
    -------
    DeviceSpecs
        An object containing OS name, CPU architecture, GPU type,
        and Apple Silicon flag.
    """
    specs = {
        "os_name": platform.system(),
        "cpu_arch": CPUArchitecture.UNKNOWN,
        "gpu_type": GPUType.UNKNOWN,
        "is_apple_silicon": False,
    }

    detector_map = {
        "Darwin": detect_darwin,
        "Linux": detect_linux,
        "Windows": detect_windows,
    }

    detect_func = detector_map.get(specs["os_name"], lambda x: x)
    specs = detect_func(specs)

    return DeviceSpecs(**specs)