Skip to content

Commit 93e400d

Browse files
committed
docs: clarify performance gains for non-scheduler runs
1 parent 3bfa32e commit 93e400d

2 files changed

Lines changed: 9 additions & 0 deletions

File tree

modules/local/render_benchmark_report/bin/benchmark_report_template.html

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -470,6 +470,13 @@ <h1><svg class="h-icon"><use href="#ic-benchmark"/></svg> Performance gains</h1>
470470
&nbsp;&nbsp;&nbsp;&mdash; <em>Packing</em> shrinks the gap between <code>scheduler booked</code> and <code>VM capacity</code>.<br>
471471
&nbsp;&nbsp;&nbsp;&mdash; <em>Provisioning</em> shrinks <code>VM capacity</code> itself (picking smaller/cheaper instances).
472472
</p>
473+
<p class="section-desc">
474+
<strong>Interpretation for runs without a Scheduler compute environment:</strong><br>
475+
if a run does not use Scheduler-backed machine telemetry, the report falls back to
476+
request-derived booking instead of observed scheduler booking. In that case,
477+
<em>Scheduler rightsize will be zero by construction</em>, and the remaining bars are best read as
478+
task over-requesting versus VM slack rather than as evidence of scheduler decisions.
479+
</p>
473480
</div>
474481
</div>
475482

modules/local/render_benchmark_report/tests/test_render.py

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,8 @@ def test_render_html(tmp_path, minimal_report_data):
4242
assert "How process runtime is measured" in text
4343
assert "How task timing is measured" in text
4444
assert "How savings attribution is measured" in text
45+
assert "runs without a Scheduler compute environment" in text
46+
assert "Scheduler rightsize will be zero by construction" in text
4547
# VM metric charts
4648
assert 'id="chart-vm-alloc-cpu"' in text
4749
assert 'id="chart-vm-alloc-mem"' in text

0 commit comments

Comments
 (0)