README.md
1# Plot Benchmark Results
2
3This tool helps plot benchmark results, and compare them with past results. <br/>
4Just drag and drop benchmark results `json` files, to visualize & compare data.
5
6<br/>
7
8
9
10<br/>
11
12
13
14## Setup
15
16### Install FNM
17
18[FNM](https://github.com/Schniz/fnm) manages versions of `Node.js` installed.
19
20After you install `fnm` and add it to your `$PATH`, you should be able to do the following.
21
22```bash
23➜ plot-benchmarks git:(viz-benchmarks) ✗ fnm use
24Using Node v18.16.0
25```
26
27Note: `fnm use` might prompt you to install the version of Node.js being [used](.nvmrc).
28
29### Install Dependencies
30
31Now, you are ready to install all the dependencies.
32
33```bash
34# Installs the necessary dependencies.
35npm install
36```
37
38### Running Local Dev Server
39
40```bash
41# Compiles the code, and hot-deploys code to the local dev server.
42npm run-script dev
43
44VITE v4.3.9 ready in 168 ms
45
46➜ Local: http://localhost:5173/
47➜ Network: use --host to expose
48➜ press h to show help
49```
50
51Now navigate to the URL listed in the output.
52
53### Usage
54
55* Drag and drop benchmark results (`*.json`) files into the page.
56* Double clicking the items on the legend, toggles the visibility of the dataset in the chart.
57* You can also filter metrics to plot.
58* To compare benchmark runs, just load both results into the page, and select the ones you want to compare.
59
60Have fun !
61
62
