Add a lightning demo to the README.md #98
Conversation
nicholasjng
requested review from
AdrianoKF,
janwillemkl,
maxmynter and
leonpawelzik
nicholasjng
force-pushed
the
lightning-demo
branch
from
1c668c7 to
b1a064b
Compare
|
BTW this needs a change in the benchmark reporter's custom formatters, which is contained in #92. |
There was a problem hiding this comment.
From this example I understand how to set up a benchmark. I don't know if I would necessarily know why I would want to use it.
Should we add a sentence at the end along the lines of:
"To move beyond toy examples, you can pass your model object as a parameter to benchmarks which calculate the metrics you are interested in. For more advanced usages [...]"
|
Good idea - however, the setup with an actual model will likely make the example 4-5x larger, which is not what we want for a lightning demo. I agree with the note for real-world uses, though. Would you be happy with a link to a doc where we use models? (Suggestions welcome) |
Our package is so well-structured that this example is small, so it does not take lots of processing new information to understand.
The presented lightning demo is very lean and concise, but not really illustrative of how the project should be used. For further reading, we add links to the quickstart, which showcases a scikit-learn model, and to the examples, which give a variety of examples for different applications. Also adds the new(ish) examples guides to the index page as links with a more concise content summary each.
nicholasjng
force-pushed
the
lightning-demo
branch
from
b1a064b to
0ac0592
Compare
|
I added links to the quickstart and the examples, and added anchor links on the examples indexpage in 0ac0592. |
Our package is structured well enough that this example is small, so it does not take lots of processing new information to understand.
For reviewers:
sumbenchmark without changing therunner = nnbench.BenchmarkRunner()and subsequent lines?