Skip to content

Commit

Permalink
Tweak readme comments to illustrate two-step process
Browse files Browse the repository at this point in the history
  • Loading branch information
nicholasjng committed Dec 21, 2024
1 parent 7eb6481 commit 65ae1b6
Showing 1 changed file with 2 additions and 1 deletion.
3 changes: 2 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down

0 comments on commit 65ae1b6

Please sign in to comment.