From 65ae1b672e57ca75929e80e06f2947ae83d347e1 Mon Sep 17 00:00:00 2001 From: Nicholas Junge Date: Sat, 21 Dec 2024 18:02:34 +0100 Subject: [PATCH] Tweak readme comments to illustrate two-step process --- README.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 9b83770..8b6a83f 100644 --- a/README.md +++ b/README.md @@ -44,8 +44,9 @@ def power(a: int, b: int) -> int: reporter = nnbench.ConsoleReporter() -# run the above benchmarks with the parameters `a=2, b=10`... +# first, collect the above benchmarks directly from the current module... benchmarks = nnbench.collect("__main__") +# ... then run the benchmarks with the parameters `a=2, b=10`... record = nnbench.run(benchmarks, params={"a": 2, "b": 10}) reporter.display(record) # ...and print the results to the terminal.