Skip to content

Commit f0d808b

Browse files
committed
Improve QAOA reproducibility and docs navigation
1 parent 4ef36c6 commit f0d808b

2 files changed

Lines changed: 13 additions & 2 deletions

File tree

README.md

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,6 @@
55
[![Python 3.10+](https://img.shields.io/badge/python-3.10+-blue.svg)](https://www.python.org/downloads/release/python-3100/)
66
[![License](https://img.shields.io/github/license/bernalde/stochastic-benchmark)](LICENSE)
77

8-
Repository for Stochastic Optimization Solvers Benchmark code
9-
=======
108
Repository for Stochastic Optimization Solvers Benchmark implementation of the Window Sticker framework.
119

1210
The benchmarking approach is described in this [preprint](https://arxiv.org/abs/2402.10255) titled: *Benchmarking the Operation of Quantum Heuristics and Ising Machines: Scoring Parameter Setting Strategies on Optimization Applications*.
@@ -18,6 +16,7 @@ Details of the implementation and an illustrative example for Wishart instances
1816
- [Background](#background)
1917
- [Installation](#installation)
2018
- [Examples](#examples)
19+
- [Documentation](#documentation)
2120
- [Testing](#testing)
2221
- [Contributors](#contributors)
2322
- [Acknowledgements](#acknowledgements)
@@ -99,6 +98,15 @@ The current package implements the following functionality:
9998

10099
For a full demonstration of the stochastic-benchmark analysis in action, refer to the example notebooks located in the `examples` folder of this repository.
101100

101+
## Documentation
102+
103+
Use the root README as the entry point, then follow the focused documents for the part of the workflow you need:
104+
105+
- [examples/general_workflow.md](examples/general_workflow.md) for the end-to-end benchmark flow
106+
- [CI-TESTING.md](CI-TESTING.md) for local CI reproduction and environment setup
107+
- [TESTING.md](TESTING.md) for the test suite overview
108+
- [examples/wishart_n_50_alpha_0.5/README.md](examples/wishart_n_50_alpha_0.5/README.md) for the Wishart example details
109+
102110
## Testing
103111

104112
Tests can be executed using the helper script `run_tests.py`. Specify the type of

examples/QAOA_iterative/qaoa_demo.ipynb

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -352,6 +352,9 @@
352352
"# ============================================================\n",
353353
"# Execute Statistics Computation\n",
354354
"# ============================================================\n",
355+
"# Fix the seed so the train/test split is reproducible across runs\n",
356+
"np.random.seed(42)\n",
357+
"\n",
355358
"# This will:\n",
356359
"# 1. Add 'train' column to sb.interp_results (True/False for each instance)\n",
357360
"# 2. Compute aggregate statistics for training and testing sets separately\n",

0 commit comments

Comments
 (0)