DOC - Explain benchopt internals when running a benchmark #636
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
It is possible to write diagrams directly into the documentation without using dedicated software + export as SVG.
This can be achieved with mermaid combined with its sphinx extension.
I crafted a diagram to explain the flow of instructions when running a benchmark.
If you are +1 with the render I shall complete the page with explanations of each part.
Checks before merging PR
added documentation for any new featureadded unit test