Skip to content

Commit cce7c8f

Browse files
authored
docs: update reproducibility capsule README (#15)
1 parent ef5a620 commit cce7c8f

File tree

3 files changed

+26
-5
lines changed

3 files changed

+26
-5
lines changed

pyproject.toml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,7 @@ dependencies = [
2121
# CLI tool
2222
"typer>=0.9.0",
2323
"rich>=13.0.0",
24+
"inquirerpy>=0.3.4",
2425
"ipykernel>=7.1.0",
2526
]
2627

reproducibility-capsule/README.md

Lines changed: 25 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -26,18 +26,38 @@ make logs-simulator
2626

2727
## Generating Plots
2828

29-
Use the interactive plot generator to create publication-ready figures:
29+
First, activate the virtual environment:
30+
31+
```bash
32+
source .venv/bin/activate
33+
```
34+
35+
Then use the interactive plot generator to create publication-ready figures:
3036

3137
```bash
3238
python reproducibility-capsule/generate_plot.py
3339
```
3440

3541
The script will:
3642

37-
1. Ask which experiment to generate a plot for
43+
1. Ask which experiment to generate plots for
3844
2. Show available data sources (completed or in-progress runs)
39-
3. Generate a PDF comparing Ground Truth, FootPrinter, and OpenDT
40-
4. Display MAPE (Mean Absolute Percentage Error) for both FootPrinter and OpenDT
45+
3. Let you select which plots to generate using an interactive checkbox
46+
47+
### Available Plots
48+
49+
**Experiment 1** (no calibration):
50+
51+
- **Power Prediction Accuracy** - Ground Truth vs FootPrinter vs OpenDT
52+
- **Sustainability/Performance/Efficiency Overview** - 3-panel plot with power, performance, and efficiency
53+
- **Job Completion Efficiency** - Jobs per kWh over time
54+
55+
**Experiment 2** (with calibration):
56+
57+
- **MAPE Over Time** - Compares calibrated vs non-calibrated MAPE
58+
- All Experiment 1 plots
59+
60+
> Note that for Experiment 2's MAPE Over Time plot, you need data from both experiment 1 and experiment 2.
4161
4262
You can run the plot generator **during** an experiment to visualize intermediate results.
4363

@@ -46,7 +66,7 @@ You can run the plot generator **during** an experiment to visualize intermediat
4666
Generated plots are saved to:
4767

4868
```
49-
reproducibility-capsule/output/experiment_<number>_<workload>.pdf
69+
reproducibility-capsule/output/experiment_<number>/<workload>_<plot_type>.pdf
5070
```
5171

5272
## Baseline Data
Binary file not shown.

0 commit comments

Comments
 (0)