Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve the documentation #130

Open
4 of 8 tasks
pawel-czyz opened this issue Jan 12, 2024 · 0 comments
Open
4 of 8 tasks

Improve the documentation #130

pawel-czyz opened this issue Jan 12, 2024 · 0 comments
Labels
📖 type: documentation Improvements or additions to documentation

Comments

@pawel-czyz
Copy link
Member

pawel-czyz commented Jan 12, 2024

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/

@pawel-czyz pawel-czyz added the 📖 type: documentation Improvements or additions to documentation label Jan 12, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
📖 type: documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant