DOC - Enhance installation, running and visualizing benchmarks #629
Conversation
Badr-MOUFAD
changed the title
Codecov Report
❗ Your organization is not using the GitHub App Integration. As a result you may experience degraded service beginning May 15th. Please install the Github App Integration for your organization. Read more. @@ Coverage Diff @@
## main #629 +/- ##
=======================================
Coverage 55.73% 55.73%
=======================================
Files 44 44
Lines 2869 2869
Branches 528 528
=======================================
Hits 1599 1599
Misses 1153 1153
Partials 117 117 |
…hopt into doc-get-started
…o doc-get-started
doc/get_started.rst
Outdated
|
|
||
| With benchopt being installed, you get access to the :ref:`Command Line Interface (CLI) <cli_ref>`, | ||
| which enables simple and easy manipulation of benchmarks just from the terminal. |
There was a problem hiding this comment.
| which enables simple and easy manipulation of benchmarks just from the terminal. | |
| which enables running benchmarks from the terminal. |
There was a problem hiding this comment.
The CLI is not only for running benchmarks, it is also for installation, publishing ...
I would keep
| which enables simple and easy manipulation of benchmarks just from the terminal. | |
| which enables a simple manipulation of benchmarks from the terminal. |
There was a problem hiding this comment.
I'm -1 with removing this part. It is important to hint that the proper way to use benchopt is through the CLI.
As a side note, getting feedback from one user is to be considered not to be directly implemented. It is tricky to please everyone.
There was a problem hiding this comment.
yes, that's why I asked to remove the "running a benchmark through a python file" :) all the doc uses the benchopt cli tool
readding a removed sentence on the benchopt CLI :)
doc/get_started.rst
Outdated
|
|
||
| benchopt install --env ./benchmark_lasso | ||
| Benchopt community maintains :ref:`several optimization benchmarks <available_benchmarks>` |
There was a problem hiding this comment.
IMO this information can be ommitted here, documentation should go straight to the point.
There was a problem hiding this comment.
I think it prepares well the floor for using Benchmark Lasso?
Also, It points to the ecosystem of benchopt benchmark, which IMO valuable for the visibility of the benchmark repos.
There was a problem hiding this comment.
yesterday's experience with Nelly hinted that there was too much information on the page, which make critical information harder to find. I'll remove this part
The other benchmarks are exposed on the repo's readme
Followup of #619. It brings the following changes
Checks before merging PR
added documentation for any new featureadded unit test