Add a flag for fan speed (wookayin#63)

* Add a flag for fan speed.
* Addressing review comments and fixing ci failure.
* Update fan flag in readme.

Author: bethune-bryant

README.md

@@ -28,6 +28,7 @@ Options:
 * `-u`, `--show-user`  : Display username of the process owner
 * `-c`, `--show-cmd`   : Display the process name
 * `-p`, `--show-pid`   : Display PID of the process
+* `-F`, `--show-fan`   : Display GPU fan speed
 * `-P`, `--show-power` : Display GPU power usage and/or limit (`draw` or `draw,limit`)
 * `--watch`, `-i`, `--interval`   : Run in watch mode (equivalent to `watch gpustat`) if given. Denotes interval between updates. ([#41][gh-issue-41])
 * `--json`             : JSON Output (Experimental, [#10][gh-issue-10])

gpustat/__main__.py

@@ -79,6 +79,8 @@ def main(*argv):
                         help='Display username of running process')
     parser.add_argument('-p', '--show-pid', action='store_true',
                         help='Display PID of running process')
+    parser.add_argument('-F', '--show-fan', action='store_true',
+                        help='Display GPU fan speed')
     parser.add_argument('--json', action='store_true', default=False,
                         help='Print all the information in JSON format')
     parser.add_argument('-v', '--version', action='version',

gpustat/core.py

@@ -107,6 +107,15 @@ def temperature(self):
         v = self.entry['temperature.gpu']
         return int(v) if v is not None else None
 
+    @property
+    def fan(self):
+        """
+        Returns the fan percentage of GPU as an integer,
+        or None if the information is not available.
+        """
+        v = self.entry['fan.speed']
+        return int(v) if v is not None else None
+
     @property
     def utilization(self):
         """
@@ -147,6 +156,7 @@ def print_to(self, fp,
                  show_user=False,
                  show_pid=False,
                  show_power=None,
+                 show_fan=None,
                  gpuname_width=16,
                  term=Terminal(),
                  ):
@@ -165,6 +175,8 @@ def _conditional(cond_fn, true_value, false_value,
         colors['CName'] = term.blue
         colors['CTemp'] = _conditional(lambda: self.temperature < 50,
                                        term.red, term.bold_red)
+        colors['FSpeed'] = _conditional(lambda: self.fan < 50,
+                                        term.yellow, term.bold_yellow)
         colors['CMemU'] = term.bold_yellow
         colors['CMemT'] = term.yellow
         colors['CMemP'] = term.yellow
@@ -189,8 +201,12 @@ def _repr(v, none_value='??'):
         # temperature and utilization
         reps = "%(C1)s[{entry[index]}]%(C0)s " \
             "%(CName)s{entry[name]:{gpuname_width}}%(C0)s |" \
-            "%(CTemp)s{entry[temperature.gpu]:>3}'C%(C0)s, " \
-            "%(CUtil)s{entry[utilization.gpu]:>3} %%%(C0)s"
+            "%(CTemp)s{entry[temperature.gpu]:>3}'C%(C0)s, "
+
+        if show_fan:
+            reps += "%(FSpeed)s{entry[fan.speed]:>3} %%%(C0)s, "
+
+        reps += "%(CUtil)s{entry[utilization.gpu]:>3} %%%(C0)s"
 
         if show_power:
             reps += ",  %(CPowU)s{entry[power.draw]:>3}%(C0)s "
@@ -300,6 +316,11 @@ def get_process_info(nv_process):
             except N.NVMLError:
                 temperature = None  # Not supported
 
+            try:
+                fan_speed = N.nvmlDeviceGetFanSpeed(handle)
+            except N.NVMLError:
+                fan_speed = None  # Not supported
+
             try:
                 memory = N.nvmlDeviceGetMemoryInfo(handle)  # in Bytes
             except N.NVMLError:
@@ -354,6 +375,7 @@ def get_process_info(nv_process):
                 'uuid': uuid,
                 'name': name,
                 'temperature.gpu': temperature,
+                'fan.speed': fan_speed,
                 'utilization.gpu': utilization.gpu if utilization else None,
                 'power.draw': power // 1000 if power is not None else None,
                 'enforced.power.limit': power_limit // 1000
@@ -403,7 +425,7 @@ def __repr__(self):
 
     def print_formatted(self, fp=sys.stdout, force_color=False, no_color=False,
                         show_cmd=False, show_user=False, show_pid=False,
-                        show_power=None, gpuname_width=16,
+                        show_power=None, show_fan=None, gpuname_width=16,
                         show_header=True,
                         eol_char=os.linesep,
                         **kwargs
@@ -453,6 +475,7 @@ def print_formatted(self, fp=sys.stdout, force_color=False, no_color=False,
                        show_user=show_user,
                        show_pid=show_pid,
                        show_power=show_power,
+                       show_fan=show_fan,
                        gpuname_width=gpuname_width,
                        term=t_color)
             fp.write(eol_char)

gpustat/test_gpustat.py

@@ -81,6 +81,12 @@ def _decorated(*args, **kwargs):
         mock_handles[2]: 71,
     }.get(handle, RuntimeError))
 
+    N.nvmlDeviceGetFanSpeed = _raise_ex(lambda handle: {
+        mock_handles[0]: 16,
+        mock_handles[1]: 53,
+        mock_handles[2]: 100,
+    }.get(handle, RuntimeError))
+
     N.nvmlDeviceGetPowerUsage = _raise_ex(lambda handle: {
         mock_handles[0]: 125000,
         mock_handles[1]: N.NVMLError_NotSupported(),  # Not Supported
@@ -154,9 +160,9 @@ def _MockedProcess(pid):
 """  # noqa: E501
 
 MOCK_EXPECTED_OUTPUT_FULL = """\
-[0] GeForce GTX TITAN 0 | 80'C,  76 %,  125 / 250 W |  8000 / 12287 MB | user1:python/48448(4000M) user2:python/153223(4000M)
-[1] GeForce GTX TITAN 1 | 36'C,   0 %,   ?? / 250 W |  9000 / 12189 MB | user1:torch/192453(3000M) user3:caffe/194826(6000M)
-[2] GeForce GTX TITAN 2 | 71'C,  ?? %,  250 /  ?? W |     0 / 12189 MB | (Not Supported)
+[0] GeForce GTX TITAN 0 | 80'C,  16 %,  76 %,  125 / 250 W |  8000 / 12287 MB | user1:python/48448(4000M) user2:python/153223(4000M)
+[1] GeForce GTX TITAN 1 | 36'C,  53 %,   0 %,   ?? / 250 W |  9000 / 12189 MB | user1:torch/192453(3000M) user3:caffe/194826(6000M)
+[2] GeForce GTX TITAN 2 | 71'C, 100 %,  ?? %,  250 /  ?? W |     0 / 12189 MB | (Not Supported)
 """  # noqa: E501
 
 
@@ -195,7 +201,7 @@ def test_new_query_mocked(self, N, Process):
         fp = StringIO()
         gpustats.print_formatted(
             fp=fp, no_color=False, show_user=True,
-            show_cmd=True, show_pid=True, show_power=True
+            show_cmd=True, show_pid=True, show_power=True, show_fan=True
         )
 
         result = fp.getvalue()