Skip to content

Commit 66b9f47

Browse files
Revise README for clarity and formatting, add compatibility matrix
Updated README to improve clarity and correct typos.
1 parent 908c142 commit 66b9f47

File tree

1 file changed

+19
-7
lines changed

1 file changed

+19
-7
lines changed

README.md

Lines changed: 19 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,21 @@
11
# GPUscout-GUI
22

3-
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).
44

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).
66

7-
## Requirements
7+
## Compatibilty Matrix
8+
9+
| GPUscout-GUI version | GPUscout version range | MT4G version range | Notes |
10+
|---|:---:|:---:|:---:|
11+
|0.1.0 | >= 0.3.0 | <= 0.1.0 | NVIDIA-only GPUscout, NVIDIA-only GUI, NVIDIA-only and CSV-based MT4G |
12+
13+
## Building and Running
14+
### Requirements
815
- [NodeJS](https://nodejs.org/en) (23.9.0+)
916
- NPM (11.1.0+)
1017

11-
## Installation
18+
### Installation
1219
```bash
1320
npm install
1421

@@ -19,22 +26,27 @@ npm run build:win # build for windows
1926
```
2027
The resulting executable will be located inside the generated `dist` folder
2128

22-
## Run Development Server
29+
### Run Development Server
2330
```bash
2431
npm run dev
2532
```
2633

27-
# Project structure
34+
## Project structure
2835

2936
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.
3037
The only relevant folders in the root directory are:
3138
- dist: Generated executables are located here
3239
- src: Contains the source code of the application.
3340

34-
## Source Code Directories
41+
### Source Code Directories
3542

3643
The `src` directory is split into four modules:
3744
- config: Contains configuration files for all aspects of the UI. Used to add/remove/modify metrics, analyses, texts, colors, ...
3845
- main: Contains code related to the electron framework. Does not need to be modified further
3946
- preload: Contains code connecting the electron backend to the frontend. Does not need to be modified further.
4047
- 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

Comments
 (0)