Skip to content

Commit 7bd8bf1

Browse files
authored
Add documentation on benchmarking report (llm-d#214)
* Rename BenchmarkRun to BenchmarkReport Signed-off-by: Nick Masluk <nick@randombytes.net> * Update docs Signed-off-by: Nick Masluk <nick@randombytes.net> * Add version check Signed-off-by: Nick Masluk <nick@randombytes.net> * Add JSON Schema Signed-off-by: Nick Masluk <nick@randombytes.net> * Correction Signed-off-by: Nick Masluk <nick@randombytes.net> * Update docs Signed-off-by: Nick Masluk <nick@randombytes.net> * Spelling corrections Signed-off-by: Nick Masluk <nick@randombytes.net> --------- Signed-off-by: Nick Masluk <nick@randombytes.net>
1 parent a498d26 commit 7bd8bf1

File tree

6 files changed

+1102
-907
lines changed

6 files changed

+1102
-907
lines changed

analysis/analysis.ipynb

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -205,11 +205,11 @@
205205
" ])\n",
206206
"\n",
207207
"\n",
208-
"def _get_replicas_and_parallelism(result: schema.BenchmarkRun) -> dict[str, int | None]:\n",
208+
"def _get_replicas_and_parallelism(result: schema.BenchmarkReport) -> dict[str, int | None]:\n",
209209
" \"\"\"Get the number of replicas and parallelisms.\n",
210210
"\n",
211211
" Args:\n",
212-
" result (BenchmarkRun): Benchmark run to evaluate.\n",
212+
" result (BenchmarkReport): Benchmark run to evaluate.\n",
213213
"\n",
214214
" Returns:\n",
215215
" dict[str, int | None]: Replicas and parallelisms for standalone or\n",
@@ -262,11 +262,11 @@
262262
" return rp\n",
263263
"\n",
264264
"\n",
265-
"def _make_name(result: schema.BenchmarkRun) -> str:\n",
265+
"def _make_name(result: schema.BenchmarkReport) -> str:\n",
266266
" \"\"\"Create a name based on the benchmark run's configuration.\n",
267267
"\n",
268268
" Args:\n",
269-
" result (BenchmarkRun): Benchmark run to create a name for.\n",
269+
" result (BenchmarkReport): Benchmark run to create a name for.\n",
270270
"\n",
271271
" Returns:\n",
272272
" str: Name of benchmark run, providing replica and parallelism details.\n",

0 commit comments

Comments
 (0)