Skip to content

Commit 6b6dcbc

Browse files
authored
Merge pull request #82 from bernalde/fix/issue-71-tutorial-scope
Clarify repeat reliability tutorial scope
2 parents 91d053c + aadcf67 commit 6b6dcbc

2 files changed

Lines changed: 17 additions & 0 deletions

File tree

examples/Simulated_Annealing/reliability_analysis.ipynb

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3012,6 +3012,19 @@
30123012
"display(after_changed_rows.reset_index(drop=True))\n",
30133013
"reference_alignment\n"
30143014
]
3015+
},
3016+
{
3017+
"cell_type": "markdown",
3018+
"metadata": {},
3019+
"source": [
3020+
"## Relationship to the Other Tutorials\n",
3021+
"\n",
3022+
"This repeat-reliability tutorial does not invalidate the other Window Sticker tutorials. Those tutorials still demonstrate cross-instance benchmarking: bootstrapped Response and PerfRatio curves, interpolation across resource levels, train/test splits, virtual-best references, and parameter-recommendation strategies for unseen instances from the same problem family.\n",
3023+
"\n",
3024+
"The reliability analysis here answers a different per-instance question: whether a solver, parameter setting, and resource level has enough repeated stochastic runs to support a Bernoulli success probability and derived `R_c`, RTT/TTS, and CETS estimates. Continuous Response and PerfRatio curves remain bootstrap-based unless the workflow converts them into thresholded success events.\n",
3025+
"\n",
3026+
"Use this tutorial as an additional diagnostic layer when benchmark conclusions depend on stochastic repeat counts, especially for low-success-probability or close-comparison regions. Use the other tutorials for the core Window Sticker workflow and add repeat reliability only when the question is about per-instance repeat sufficiency.\n"
3027+
]
30153028
}
30163029
],
30173030
"metadata": {

tests/test_verify_tutorials.py

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -141,6 +141,10 @@ def test_simulated_annealing_companion_reliability_notebook_is_self_contained():
141141
assert "load_targeted_rerun_runs" in source
142142
assert "targeted_sa_reruns.npz" in source
143143
assert "after_rerun_reliable_sweeps" in source
144+
assert "Relationship to the Other Tutorials" in source
145+
assert "does not invalidate the other Window Sticker tutorials" in source
146+
assert "cross-instance benchmarking" in source
147+
assert "per-instance question" in source
144148

145149

146150
def test_load_manifest_requires_skip_reason(tmp_path):

0 commit comments

Comments
 (0)