File: OpenClDeviceLabel.py

package info (click to toggle)
pyfai 0.20.0%2Bdfsg1-3
  • links: PTS, VCS
  • area: main
  • in suites: bullseye
  • size: 78,460 kB
  • sloc: python: 49,743; lisp: 7,059; sh: 225; ansic: 165; makefile: 119
file content (130 lines) | stat: -rw-r--r-- 4,799 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
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
53
54
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
100
101
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
128
129
130
# coding: utf-8
# /*##########################################################################
#
# Copyright (C) 2016-2018 European Synchrotron Radiation Facility
#
# Permission is hereby granted, free of charge, to any person obtaining a copy
# of this software and associated documentation files (the "Software"), to deal
# in the Software without restriction, including without limitation the rights
# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
# copies of the Software, and to permit persons to whom the Software is
# furnished to do so, subject to the following conditions:
#
# The above copyright notice and this permission notice shall be included in
# all copies or substantial portions of the Software.
#
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
# THE SOFTWARE.
#
# ###########################################################################*/

__authors__ = ["V. Valls"]
__license__ = "MIT"
__date__ = "16/10/2020"

from silx.gui import qt

try:
    import pyopencl
except ImportError:
    pyopencl = None


class OpenClDeviceLabel(qt.QLabel):
    """Label displaying a specific OpenCL device.
    """

    def __init__(self, parent=None):
        super(OpenClDeviceLabel, self).__init__(parent)
        self.__device = None
        self.__updateDisplay()

    def __getOpenClDevice(self, platformId, deviceId):
        if pyopencl is None:
            return None
        if not (0 <= platformId < len(pyopencl.get_platforms())):
            return None
        platform = pyopencl.get_platforms()[platformId]
        if not (0 <= deviceId < len(platform.get_devices())):
            return None
        return platform.get_devices()[deviceId]

    def __updateDisplay(self):
        toolTip = ""
        if self.__device is None:
            label = "No OpenCL device selected"
        elif self.__device == "any":
            label = "Any available device"
        elif self.__device == "cpu":
            label = "Any available CPU"
        elif self.__device == "gpu":
            label = "Any available GPU"
        else:
            platformId, deviceId = self.__device
            device = self.__getOpenClDevice(platformId, deviceId)
            if device is not None:
                deviceName, platformName = device.name, device.platform.name
            else:
                deviceName, platformName = None, None

            args = {
                "deviceName": deviceName,
                "deviceId": deviceId,
                "platformName": platformName,
                "platformId": platformId,
            }

            if deviceName is None:
                labelTemplate = "{deviceId}, {platformId}"
                tipTemplate = """
                    <ul>
                    <li><b>Platform index</b>: {platformId}</li>
                    <li><b>Device index</b>: {deviceId}</li>
                    </ul>
                """
            else:
                labelTemplate = "{deviceName} ({platformId}, {deviceId})"
                tipTemplate = """
                    <ul>
                    <li><b>Platform name</b>: {platformName}</li>
                    <li><b>Platform index</b>: {platformId}</li>
                    <li><b>Device name</b>: {deviceName}</li>
                    <li><b>Device index</b>: {deviceId}</li>
                    </ul>
                """

            label = labelTemplate.format(**args)
            toolTip = tipTemplate.format(**args)

        self.setText(label)
        self.setToolTip(toolTip)

    def setDevice(self, device):
        """Select an OpenCL device displayed on this dialog.

        A device can be identified as a string like 'any', 'cpu' or 'gpu' or a
        tuple containing the platform index and the device index.

        If this device is available on this platform is is selected in the
        list. Else it is selected as a custom indexes.

        :param Union[None,str,Tuple[int,int]] device: A device.
        """
        self.__device = device
        self.__updateDisplay()

    def device(self):
        """Returns the selected OpenCL device.

        A device can be identified as a string like 'any', 'cpu' or 'gpu' or a
        tuple containing the platform index and the device index.

        :rtype: Union[None,str,Tuple[int,int]]
        :raises ValueError: If no devices are selected
        """
        return self.__device