-
Notifications
You must be signed in to change notification settings - Fork 6
Open
Labels
📖 type: documentationImprovements or additions to documentationImprovements or additions to documentation
Description
There's room for improvement for documentation:
- Add a picture of the benchmark to the ReadMe/docs.
- Explicitly list estimators and cite their resources (See Improve list of estimators #135). Some ideas:
- Add
estimator.cite()method. - Add the citations to the documentation (e.g., to the webpage listing the existing estimators by including them in the docstrings).
- Add
Additionally, the following tutorial sections in documentation would be useful to add:
- How to use the samplers
- How to use the tasks.
- How to use the estimators. (See Improve list of estimators #135)
- How to add a new estimator. (See Improve documentation #134, Improve list of estimators #135)
- How to define and use the fine distributions. (See Documentation of fine distributions #138)
- How to use Snakemake workflows.
A possible suggestion how to structure things: https://omnibenchmark.org/
Metadata
Metadata
Assignees
Labels
📖 type: documentationImprovements or additions to documentationImprovements or additions to documentation