bug fix

.gitignore

@@ -3,6 +3,8 @@
 __pycache__/
 *.py[cod]
 *$py.class
+try.py
+.vscode/
 
 # C extensions
 *.so

README.md

@@ -5,24 +5,56 @@ A naive tool for observing gpu status and auto set visible gpu in python code.
 ## How to use
 
 1. install the package.
-```
-pip install https://git.zmy.pub/zmyme/gpuutil/archive/v0.0.1.tar.gz
+```shell
+pip install https://git.zmy.pub/zmyme/gpuutil/archive/v0.0.3.tar.gz
 ```
 
 2. for observing gpu status, just input
-```
+```shell
 python -m gpuutil <options>
 ```
-where options can either be "brief" or "detail", and you will get something like
+when directly running ```python -m gpuutil```, you would probably get:
+```text
++----+------+------+----------+----------+------+----------------+
+| ID | Fan  | Temp |   Pwr    |   Freq   | Util |      Vmem      |
++----+------+------+----------+----------+------+----------------+
+| 0  | 22 % | 21 C |  9.11 W  | 300 MHz  | 0 %  | 3089/11019 MiB |
+| 1  | 22 % | 23 C |  6.28 W  | 300 MHz  | 0 %  | 786/11019 MiB  |
+| 2  | 38 % | 59 C | 92.04 W  | 1890 MHz | 6 %  | 3608/11019 MiB |
+| 3  | 40 % | 67 C | 246.38 W | 1740 MHz | 93 % | 3598/11019 MiB |
++----+------+------+----------+----------+------+----------------+
+|                          Process Info                          |
++----------------------------------------------------------------+
+| [26107|0] user1(737 MiB) python                                |
+| [34033|0,1] user2(1566 MiB) python                             |
+| [37190|0] user2(783 MiB) python                                |
+| [37260|0] user2(783 MiB) python                                |
+| [30356|2] user3(3605 MiB) python train.py --args --some really |
+| long arguments                                                 |
+| [34922|3] user3(3595 MiB) python train.py --args --some really |
+| long arguments version 2                                       |
++----------------------------------------------------------------+
 ```
-================== GPU INFO ==================
-[0] Utils: 94 % | Mem: 10166/11019 MiB(853MiB free)  user1(10163MiB,pid=14018)
-[1] Utils: 89 % | Mem: 6690/11019 MiB(4329MiB free)  user2(6687MiB,pid=19855)
-[2] Utils: 0 % | Mem: 1/11019 MiB(11018MiB free)
-[3] Utils: 0 % | Mem: 1/11019 MiB(11018MiB free)
-================ PROCESS INFO ================
-[14018] user1(10163 MiB) python train.py --some -args
-[19855] user2(6687 MiB) python train.py --some --different --args
+To get more information, run ```python -m gpuutil -h```, you would get:
+```text
+usage: __main__.py [-h] [--profile PROFILE] [--cols COLS] [--style STYLE]
+                   [--show-process SHOW_PROCESS] [--vertical VERTICAL] [--save]
+
+optional arguments:
+  -h, --help            show this help message and exit
+  --profile PROFILE, -p PROFILE
+                        profile keyword, corresponding configuration are saved in ~/.gpuutil.conf
+  --cols COLS, -c COLS  colums to show.(Availabel cols: ['ID', 'Fan', 'Temp', 'TempMax', 'Pwr',
+                        'PwrMax', 'Freq', 'FreqMax', 'Util', 'Vmem', 'UsedMem', 'TotalMem', 'FreeMem',
+                        'Users']
+  --style STYLE, -sty STYLE
+                        column style, format: |c|l:15|r|c:14rl:13|, c,l,r are align methods, | is line
+                        and :(int) are width limit.
+  --show-process SHOW_PROCESS, -sp SHOW_PROCESS
+                        whether show process or not
+  --vertical VERTICAL, -v VERTICAL
+                        whether show each user in different lines. (show user vertically)
+  --save                save config to profile
 ```
 
 3. To auto set visible gpu in your python code, just use the following python code.
@@ -43,4 +75,5 @@ def auto_set(num, allow_nonfree=True, ask=True, blacklist=[], show=True):
 ```
 
 ## ps:
-you can get more detailed via accessing gpuutil.GPUStat class, for more information, just look the code.
+1. you can get more detailed gpu info via accessing gpuutil.GPUStat class, for more information, just look the code.
+2. Since it use ps command to get detailed process info, it can only be used on linux.

gpuutil/__main__.py

@@ -1,18 +1,112 @@
 from gpuutil import GPUStat
 import sys
+import json
+import argparse
+import os
+
+def csv2list(csv):
+    l = [col.strip() for col in csv.split(',')]
+    return [col for col in l if col != '']
+def str2bool(s):
+    if s.lower() in ['t', 'yes', 'y', 'aye', 'positive', 'true']:
+        return True
+    else:
+        return False
+
+def load_config():
+    home_dir = os.path.expanduser('~')
+    configpath = os.path.join(home_dir, '.gpuutil.conf')
+    if not os.path.isfile(configpath):
+        return {}
+    with open(configpath, 'r', encoding='utf-8') as f:
+        return json.load(f)
+def save_config(config):
+    home_dir = os.path.expanduser('~')
+    configdir = os.path.join(home_dir, '.gpuutil.conf')
+    with open(configdir, 'w+', encoding='utf-8') as f:
+        json.dump(config, f, ensure_ascii=False, indent=4)
+
+# style format: |c|l:15|r|c:14rl:13|
+def parse_style(style):
+    if style is None:
+        return None, None
+    components = []
+    limits = []
+    while len(style) > 0:
+        ch = style[0]
+        if ch == '|':
+            components.append(ch)
+            style = style[1:]
+            continue
+        elif ch in ['l', 'r', 'c']:
+            limit = None
+            style = style[1:]
+            if style[0] == ':':
+                style = style[1:]
+                digits = ''
+                while style[0].isdigit():
+                    digits += style[0]
+                    style = style[1:]
+                if digits != '':
+                    limit = int(digits)
+            components.append(ch)
+            limits.append(limit)
+    style = ''.join(components)
+    return style, limits
 
 if __name__ == '__main__':
     stat = GPUStat()
-    show_types = ['brief', 'detail']
-    default_type = 'brief'
-    show_type = default_type
-    if len(sys.argv) > 1:
-        show_type = str(sys.argv[1])
-    if show_type in show_types:
-        stat.show(disp_type=show_type)
-    else:
-        print('The given type is \"{0}\" not understood, and it should be choosen from {1}\nUsing default type \"{2}\".'.format(show_type, show_types, default_type))
-        show_type = default_type
-        stat.show(disp_type=show_type)
 
-    # auto_set(1, ask=True, blacklist=[], show=True)
+    avaliable_cols = ['ID', 'Fan', 'Temp', 'TempMax', 'Pwr', 'PwrMax', 'Freq', 'FreqMax', 'Util', 'Vmem', 'UsedMem', 'TotalMem', 'FreeMem', 'Users']
+    recommended_cols = ['ID', 'Fan', 'Temp', 'Pwr', 'Freq', 'Util', 'Vmem']
+
+    parser = argparse.ArgumentParser()
+    parser.add_argument('--profile', '-p', default=None, type=str, help='profile keyword, corresponding configuration are saved in ~/.gpuutil.conf')
+    parser.add_argument('--cols', '-c', type=csv2list, help='colums to show.(Availabel cols: {0}'.format(avaliable_cols))
+    parser.add_argument('--style', '-sty', type=str, default=None, help='column style, format: |c|l:15|r|c:14rl:13|, c,l,r are align methods, | is line and :(int) are width limit.')
+    parser.add_argument('--show-process', '-sp', default=True, type=str2bool, help='whether show process or not')
+    parser.add_argument('--vertical', '-v', default=False, type=str2bool, help='whether show each user in different lines. (show user vertically)')
+    parser.add_argument('--save', default=False, action="store_true", help='save config to profile')
+    args = parser.parse_args()
+    cols = args.cols if args.cols is not None else recommended_cols
+    show_process = args.show_process
+    style, limit = parse_style(args.style)
+    vertical = args.vertical
+    unexpected_cols = []
+    for col in cols:
+        if col not in avaliable_cols:
+            unexpected_cols.append(col)
+    if len(unexpected_cols) > 0:
+        raise ValueError('Unexpected cols {0} occured. Cols must be chosen from {1}'.format(unexpected_cols, ','.join(avaliable_cols)))
+
+    if args.save:
+        params = {
+            "cols": cols,
+            "style": style,
+            "limit": limit,
+            "show-process": show_process,
+            "vertical": vertical
+        }
+        profile = args.profile if args.profile is not None else input('Please input your profile name:\n>>> ')
+        config = load_config()
+        config[profile] = params
+        save_config(config)
+    elif args.profile is not None:
+        config = load_config()
+        if args.profile in config:
+            params = config[args.profile]
+            cols = params["cols"]
+            show_process = params["show-process"]
+            style = None
+            limit = None
+            vertical = False
+            if "style" in params:
+                style = params["style"]
+            if "limit" in params:
+                limit = params["limit"]
+            if "vertical" in params:
+                vertical = params["vertical"]
+
+        else:
+            raise ValueError('Profile do not exist.\nAvaliable Profiles:{0}'.format(','.join(list(config.keys()))))
+    stat.show(enabled_cols = cols, colsty=style, colsz=limit, vertical=vertical, show_command=show_process)

gpuutil/gpuutil.py

@@ -1,8 +1,14 @@
+from io import StringIO
+from sys import platform
 import xml.etree.ElementTree as ET
 import os
 import json
 import random
 import sys
+import csv
+import platform
+
+osname = platform.system()
 
 
 def xml2dict(node):
@@ -121,13 +127,14 @@ def short_gpu_info(stat, disp_type='brief'):
             util=stat_disp['util'],
             mem=stat_disp['mem']
         )
-    
+
     if len(process_info) > 0:
         info += '  '
         info += process_info
     return info
 
-def get_basic_process_info():
+
+def get_basic_process_info_linux():
     pipe = os.popen('ps axo user:20,pid,args:1024')
     output = pipe.read()
     lines = output.split('\n')[1:]
@@ -145,6 +152,111 @@ def get_basic_process_info():
         }
     return processes
 
+def get_basic_process_info_windows():
+    pipe = os.popen("tasklist /FO CSV")
+    content = StringIO(pipe.read())
+    reader = csv.reader(content, delimiter=',', quotechar='"')
+    content = []
+    for row in reader:
+        content.append(list(row))
+    processes = {}
+    for line in content[1:]:
+        name, pid, _, _, _ = line
+        processes[pid] = {
+            "user": None,
+            "command": name
+        }
+    return processes
+
+def draw_table(table, rowsty=None, colsty=None, colsz = None):
+    def justify(s, align, width):
+        if align == 'c':
+            s = s.center(width)
+        elif align == 'r':
+            s = s.rjust(width)
+        elif align == 'l':
+            s = s.ljust(width)
+        return s
+
+    num_cols = len(table[0])
+    if rowsty is None:
+        rowsty = '|' + '|'.join(['c']*len(table)) + '|'
+    if colsty is None:
+        colsty = '|' + '|'.join(['c']*num_cols) + '|'
+    # check tables.
+    for row in table:
+        if len(row) != num_cols:
+            raise ValueError('different cols!')
+    col_width = [0] * num_cols
+    if colsz is None:
+        colsz = [None] * num_cols
+    
+    # collect widths.
+    for row in table:
+        for i, col in enumerate(row):
+            col = str(col)
+            width = max([len(c) for c in col.split('\n')])
+            if colsz[i] is not None and colsz[i] < width:
+                width = colsz[i]
+            if width > col_width[i]:
+                col_width[i] = width
+    # prepare vline.
+    vline = []
+    colaligns = []
+    col_pos = 0
+    line_delemeter = '-'
+    content_delemeter = ' '
+    for ch in colsty:
+        if ch == '|':
+            vline.append('+')
+        elif ch in ['c', 'l', 'r']:
+            colaligns.append(ch)
+            vline.append('-' * col_width[col_pos])
+            col_pos += 1
+    vline = line_delemeter.join(vline)
+    table_to_draw = []
+    row_pos = 0
+    for ch in rowsty:
+        if ch == '|':
+            table_to_draw.append("vline")
+        elif ch in ['c', 'l', 'r']:
+            table_to_draw.append(table[row_pos])
+            row_pos += 1;
+    strings = []
+    for row in table_to_draw:
+        if type(row) is str:
+            strings.append(vline)
+            continue
+        new_row = []
+        max_cols = 1
+        for word, align, width in zip(row, colaligns, col_width):
+            cols = []
+            lines = word.split('\n')
+            for line in lines:
+                while len(line) > 0:
+                    cols.append(line[:width])
+                    line = line[width:]
+            cols = [justify(col, align, width) for col in cols]
+            if len(cols) > max_cols:
+                max_cols = len(cols)
+            new_row.append(cols)
+        for cols, width in zip(new_row, col_width):
+            empty = ' ' * width
+            while len(cols) < max_cols:
+                cols.append(empty)
+        rows = list(zip(*new_row))
+        for row in rows:
+            cols_to_drawn = []
+            col_pos = 0
+            for ch in colsty:
+                if ch == '|':
+                    cols_to_drawn.append('|')
+                elif ch in ['c', 'r', 'l']:
+                    cols_to_drawn.append(row[col_pos])
+                    col_pos += 1
+            strings.append(content_delemeter.join(cols_to_drawn))
+    return '\n'.join(strings)
+
 class GPUStat():
     def __init__(self):
         self.gpus = []
@@ -155,6 +267,11 @@ class GPUStat():
         self.cuda_version = ''
         self.attached_gpus = ''
         self.driver_version = ''
+    def get_process_info(self):
+        if osname == 'Windows':
+            return get_basic_process_info_windows()
+        elif osname == 'Linux':
+            return get_basic_process_info_linux()
     def parse(self):
         self.raw_info = parse_nvsmi_info('nvidia-smi -q -x')
         self.detailed_info = {}
@@ -165,16 +282,19 @@ class GPUStat():
                 if type(value) is not list:
                     value = [value]
                 self.detailed_info[key] = [parse_gpu_info(info) for info in value]
-        self.process_info = get_basic_process_info()
-        self.simplified_info = {
-            "driver_version": self.detailed_info["driver_version"],
-            "cuda_version": self.detailed_info["cuda_version"],
-            "attached_gpus": self.detailed_info["attached_gpus"],
-            "gpus": [simplify_gpu_info(stat) for stat in self.detailed_info["gpu"]]
-        }
-        self.cuda_version = self.simplified_info["cuda_version"]
-        self.driver_version = self.simplified_info["driver_version"]
-        self.attached_gpus = self.simplified_info["attached_gpus"]
+        self.process_info = self.get_process_info()
+        self.simplified_info = {}
+        for key in self.detailed_info:
+            if key != "gpu":
+                self.simplified_info[key] = self.detailed_info[key]
+            else:
+                self.simplified_info["gpus"] = [simplify_gpu_info(stat) for stat in self.detailed_info["gpu"]]
+        if "cuda_version" in self.simplified_info:
+            self.cuda_version = self.simplified_info["cuda_version"]
+        if "driver_version" in self.simplified_info:
+            self.driver_version = self.simplified_info["driver_version"]
+        if "attached_gpus" in self.simplified_info:
+            self.attached_gpus = self.simplified_info["attached_gpus"]
         self.gpus = []
         for i, gpu in enumerate(self.simplified_info["gpus"]):
             for process in gpu['processes']:
@@ -182,31 +302,100 @@ class GPUStat():
             gpu['id'] = i
             self.gpus.append(gpu)
 
-    def show(self, disp_type='brief', command=True):
+    def show(self, enabled_cols = ['ID', 'Fan', 'Temp', 'Pwr', 'Freq', 'Util', 'Vmem', 'Users'], colsty=None, colsz=None, show_command=True, vertical=False):
         self.parse()
-        lines = [short_gpu_info(info, disp_type=disp_type) for info in self.gpus]
-        print('================== GPU INFO ==================')
-        print('\n'.join(lines))
-        if command:
-            print('================ PROCESS INFO ================')
+        gpu_infos = []
+        # stats = {
+        #     "id": stat['id'],
+        #     "fan": stat['fan_speed'].split(' ')[0].strip(),
+        #     "temp_cur":  stat['temperature']['current'].split(' ')[0].strip(),
+        #     "temp_max":  stat['temperature']['max'].split(' ')[0].strip(),
+        #     "power_cur": stat['power']['current'].split(' ')[0].strip(),
+        #     "power_max": stat['power']['max'].split(' ')[0].strip(),
+        #     "clock_cur": stat['clocks']['current'].split(' ')[0].strip(),
+        #     "clock_max": stat['clocks']['max'].split(' ')[0].strip(),
+        #     "util":      stat['utilization'],
+        #     "mem_used":  stat['memory']['used'].split(' ')[0].strip(),
+        #     "mem_total": stat['memory']['total'].split(' ')[0].strip(),
+        #     "mem_free":  stat['memory']['free'].split(' ')[0].strip()
+        # }
+        for gpu in self.gpus:
+            # process_fmt = '{user}({pid})'
+            # process_info = ','.join([process_fmt.format(
+            #     user = proc['user'],
+            #     pid = proc['pid']
+            # ) for proc in gpu['processes']])
+            process_fmt = '{user}({pids})'
+            users_process = {}
+            for proc in gpu['processes']:
+                user = proc['user']
+                pid = proc['pid']
+                if user not in users_process:
+                    users_process[user] = []
+                users_process[user].append(pid)
+            delemeter = ','
+            if vertical:
+                delemeter = '\n'
+            process_info = delemeter.join(process_fmt.format(user=user, pids = '|'.join(users_process[user])) for user in users_process)
+            info_gpu = {
+                'ID': '{0}'.format(str(gpu['id'])),
+                'Fan': '{0} %'.format(gpu['fan_speed'].split(' ')[0].strip()),
+                'Temp': '{0} C'.format(gpu['temperature']['current'].split(' ')[0].strip()),
+                'TempMax': '{0} C'.format(gpu['temperature']['max'].split(' ')[0].strip()),
+                'Pwr': '{0} W'.format(gpu['power']['current'].split(' ')[0].strip()),
+                'PwrMax': '{0} W'.format(gpu['power']['max'].split(' ')[0].strip()),
+                'Freq': '{0} MHz'.format(gpu['clocks']['current'].split(' ')[0].strip()),
+                'FreqMax': '{0} MHz'.format(gpu['clocks']['max'].split(' ')[0].strip()),
+                'Util': '{0} %'.format(gpu['utilization'].split(' ')[0]),
+                'Vmem': '{0}/{1} MiB'.format(
+                    gpu['memory']['used'].split(' ')[0].strip(),
+                    gpu['memory']['total'].split(' ')[0].strip(),
+                ),
+                'UsedMem': '{0} MiB'.format(gpu['memory']['used'].split(' ')[0].strip()),
+                'TotalMem': '{0} MiB'.format(gpu['memory']['total'].split(' ')[0].strip()),
+                'FreeMem': '{0} MiB'.format(gpu['memory']['free'].split(' ')[0].strip()),
+                'Users': process_info
+            }
+            gpu_infos.append(info_gpu)
+        align_methods = {key:'r' for key in gpu_infos[0]}
+        align_methods['Users'] = 'l'
+        if enabled_cols is None:
+            enabled_cols = list(align_methods.keys())
+        c_align = [align_methods[col] for col in enabled_cols]
+        info_table = [enabled_cols]
+        for info in gpu_infos:
+            this_row = [info[key] for key in enabled_cols]
+            info_table.append(this_row)
+        info = draw_table(info_table, rowsty='|c|{0}|'.format('c'*(len(info_table)-1)), colsty=colsty, colsz=colsz) + '\n'
+        if show_command:
             procs = {}
             for gpu in self.gpus:
                 for proc in gpu['processes']:
                     pid = proc['pid']
+                    proc['gpu'] = [str(gpu['id'])]
+                    if type(proc['vmem']) is str:
+                        proc['vmem'] = int(proc['vmem'].split(' ')[0])
                     if pid not in procs:
                         procs[pid] = proc
-            proc_fmt = '[{pid}] {user}({vmem} MiB) {cmd}'
+                    else:
+                        procs[pid]['gpu'].append(str(gpu['id']))
+                        procs[pid]['vmem'] += proc['vmem']
+            proc_fmt = '[{pid}|{gpus}] {user}({vmem} MiB) {cmd}'
             proc_strs = []
             for pid in procs:
                 this_proc_str = proc_fmt.format(
                     user = procs[pid]['user'],
-                    vmem = procs[pid]['vmem'].split(' ')[0],
-                    pid = procs[pid]['pid'], 
-                    cmd = procs[pid]['command']
+                    vmem = procs[pid]['vmem'],
+                    pid = procs[pid]['pid'].rjust(5),
+                    cmd = procs[pid]['command'],
+                    gpus = ','.join(procs[pid]['gpu'])
                 )
                 proc_strs.append(this_proc_str)
             proc_info = '\n'.join(proc_strs)
-            print(proc_info)
+            table_width = info.find('\n')
+            proc_info = draw_table([['Process Info'.center(table_width-4)], [proc_info]], rowsty="c|c|", colsty="|l|", colsz=[table_width-4])
+            info += proc_info
+        print(info)
 
 class MoreGPUNeededError(Exception):
     def __init__(self):
@@ -284,4 +473,6 @@ def auto_set(num, allow_nonfree=True, ask=True, blacklist=[], show=True):
     else:
         raise MoreGPUNeededError
     set_gpu(selected_gpu, show=show)
-    
+
+if __name__ == '__main__':
+    print(get_basic_process_info_windows())

setup.py

@@ -2,15 +2,15 @@ from setuptools import setup, find_packages
 
 setup(
     name = 'gpuutil',
-    version = '0.0.1',
+    version = '0.0.3',
     keywords='gpu utils',
     description = 'A tool for observing gpu stat and auto set visible gpu in python code.',
     license = 'MIT License',
-    url = '',
+    url = 'https://git.zmy.pub/zmyme/gpuutil',
     author = 'zmy',
     author_email = 'izmy@qq.com',
     packages = find_packages(),
     include_package_data = True,
-    platforms = 'any',
+    platforms = 'All',
     install_requires = [],
 )