benchmark
¶
Compare results from a reference simulator against one or more challengers.
Benchmark
¶
Compare expectation traces from a reference and challenger simulators.
Source code in shadowsim/benchmarking/benchmark.py
51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 | |
__init__
¶
Initialize a Benchmark for simulators on the same time grid.
Source code in shadowsim/benchmarking/benchmark.py
get_tlist
¶
run
¶
Run the reference and all challenger simulators.
Source code in shadowsim/benchmarking/benchmark.py
get_results
¶
Return matching result traces from the reference and each challenger.
error_metrics
¶
Return L∞ / L2 / MAE / RMSE vs reference for each challenger.
For each selected observable, with error series e = y_ref − y_challenger:
linf:max |e|l2: Euclidean norm||e||_2mae:mean(|e|)rmse:sqrt(mean(e²))
challenger_id is that simulator's id. When the same id appears more
than once in the benchmark, it is reported as id#1, id#2, and so
on, counting the reference and challengers in order.
Source code in shadowsim/benchmarking/benchmark.py
resource_metrics
¶
Return wall-clock time and shot budget for each simulator.
Requires run() first. Shot fields are None when neither the circuit
backend nor the simulator stores an integer shots count (for example
QuTiP). Otherwise num_jobs is len(tlist) and total_shots is
shots_per_job * num_jobs. depth, width, gate_count,
t_count, and toffoli_count come from the final-time circuit.
Each is "N/A" when the backend cannot measure that circuit.
simulator_id is that simulator's id. When the same id appears more
than once, it is reported as id#1, id#2, and so on, in benchmark
order. title is the class display title with that same suffix, or
the id with _simulator removed when the class sets no title. Each
row keeps the wall time of that run.
Source code in shadowsim/benchmarking/benchmark.py
save_error_metrics
¶
save_error_metrics(
indices: list[int] | None = None,
*,
path: Path | None = None,
output_dir: str | Path = "results",
) -> Path
Write error and resource metrics to JSON.
When path is set, that file is written and output_dir is ignored.
Otherwise the timestamped JSON is written under output_dir (default
results/), which is created if it does not exist.
Payload shape: {"errors": error_metrics(...), "resources": resource_metrics()}.
Source code in shadowsim/benchmarking/benchmark.py
save_result_plot
¶
save_result_plot(
indices: list[int] | None = None,
*,
dpi: float = 150,
labels: list[str] | None = None,
titles: list[str] | None = None,
title: str | None = None,
output_dir: str | Path = "results",
) -> list[Path]
Save plots for each simulator and abs-diff vs the reference.
Every file from this call is written under output_dir (default
results/), which is created if it does not exist.
Returns [ref_plot, *challenger_plots, *diff_plots].
Source code in shadowsim/benchmarking/benchmark.py
__str__
¶
Return a string representation of the Benchmark.