You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Repository for Stochastic Optimization Solvers Benchmark code
9
-
=======
10
8
Repository for Stochastic Optimization Solvers Benchmark implementation of the Window Sticker framework.
11
9
12
10
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
18
16
-[Background](#background)
19
17
-[Installation](#installation)
20
18
-[Examples](#examples)
19
+
-[Documentation](#documentation)
21
20
-[Testing](#testing)
22
21
-[Contributors](#contributors)
23
22
-[Acknowledgements](#acknowledgements)
@@ -99,6 +98,15 @@ The current package implements the following functionality:
99
98
100
99
For a full demonstration of the stochastic-benchmark analysis in action, refer to the example notebooks located in the `examples` folder of this repository.
101
100
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) forlocal 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
+
102
110
## Testing
103
111
104
112
Tests can be executed using the helper script `run_tests.py`. Specify the type of
0 commit comments