Skip to content

Improve the documentation #130

@pawel-czyz

Description

@pawel-czyz

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).

Additionally, the following tutorial sections in documentation would be useful to add:

A possible suggestion how to structure things: https://omnibenchmark.org/

Metadata

Metadata

Assignees

No one assigned

    Labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions