benchopt / benchopt/benchopt

DOC consistent objective description

Open
#259 5 comments 0 reactions 0 assignees View on GitHub
Dominant language
Python
Stars
326
Forks
74
Avg merge
47m
Merged PRs (30d)
1

Description

There is several issue with the description of the objective in each benchmark:

- The latex equations are not rendered in the `README.rst`
- We need to maintain them at several places (benchmark README, list of objective in the doc, it would be nice to include in benchmark result page, ...)

A potential solution would be to have a small file `objective.rst` in the benchmark folder that describe the objective. We could include it when generating the doc, and use sphinx to convert it to HTML for the results and the README.

This requires significant developments effort so it is clearly not a priority.

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.