You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
A companion application for visualizing results of GPUscout.
3
+
A companion visual user interface for analyzing and understanding findingd made by [GPUscout](https://github.com/caps-tum/GPUscout).
4
4
5
-
GPUscout-GUI provides a graphical representation of analysis results computed by the [GPUscout](https://github.com/caps-tum/GPUscout) application. Users are able to view kernel-wide metrics, compare the kernel source and intermediate codes, and investigate findings in more detail than only using GPUscout's output.
5
+
GPUscout-GUI provides a graphical representation of analysis results computed by the [GPUscout](https://github.com/caps-tum/GPUscout) application. Users are able to view kernel-wide metrics, compare the kernel source and intermediate codes, and investigate findings in more detail than only using GPUscout's output. Optionally, users can add GPU topology information through [MT4G](https://github.com/caps-tum/mt4g).
6
6
7
-
## Requirements
7
+
## Compatibilty Matrix
8
+
9
+
| GPUscout-GUI version | GPUscout version range | MT4G version range | Notes |
@@ -19,22 +26,27 @@ npm run build:win # build for windows
19
26
```
20
27
The resulting executable will be located inside the generated `dist` folder
21
28
22
-
## Run Development Server
29
+
###Run Development Server
23
30
```bash
24
31
npm run dev
25
32
```
26
33
27
-
# Project structure
34
+
##Project structure
28
35
29
36
GPUscout-GUI uses both the [electron](https://www.electronjs.org/) and [vueJS](https://vuejs.org/) frameworks to create the user interface as a standalone application.
30
37
The only relevant folders in the root directory are:
31
38
- dist: Generated executables are located here
32
39
- src: Contains the source code of the application.
33
40
34
-
## Source Code Directories
41
+
###Source Code Directories
35
42
36
43
The `src` directory is split into four modules:
37
44
- config: Contains configuration files for all aspects of the UI. Used to add/remove/modify metrics, analyses, texts, colors, ...
38
45
- main: Contains code related to the electron framework. Does not need to be modified further
39
46
- preload: Contains code connecting the electron backend to the frontend. Does not need to be modified further.
40
47
- renderer: Contains the definition and source code of the user interface. New features need to be implemented here. `src/components` Defines all components visible in the user interface, organized by page. `src/stores` defines Vue stores, which handle reactive data accessible from all components (Modifications here should be made carefully). `src/utils` defines all JS classes used in the code.
48
+
49
+
## About
50
+
GPUscout-GUI has been initially developed by Tobias Struckenberger, and is further maintained by Stepan Vanecek (stepan.vanecek(at)tum.de) and the [CAPS TUM](https://www.ce.cit.tum.de/en/caps/homepage/). Please contact us in case of questions, bug reporting etc.
51
+
52
+
GPUscout-GUI is available under the Apache-2.0 license. (see [License](https://github.com/caps-tum/sys-sage/blob/master/LICENSE))
0 commit comments