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

Polish benchmarks page #1432

Merged
merged 5 commits into from
Nov 22, 2023

Conversation

philippmwirth
Copy link
Contributor

@philippmwirth philippmwirth commented Nov 22, 2023

Polish benchmarks page

Clean up the benchmarks page in the docs:

  • Use consistent names (e.g. CIFAR-10 and kNN).
  • Fix names (e.g. Imagenet100 -> ImageNet100).
  • Use consistent structure: Dataset and code on top, then a short description, and then the results table.
  • Order by relevancy (ImageNet, ImageNet100, Imagenette, CIFAR-10).
  • Point to the examples and tutorials in the next steps section.
  • Make README consistent with benchmarks page.

To review it's best to build the docs locally and go through the page:

git pull philipp-lig-3098-cleanup-pip-benchmark-docs
cd docs
make html-noplot
python -m http.server 1234

Copy link

codecov bot commented Nov 22, 2023

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (514ffd7) 85.24% compared to head (371da53) 85.24%.
Report is 1 commits behind head on master.

Additional details and impacted files
@@           Coverage Diff           @@
##           master    #1432   +/-   ##
=======================================
  Coverage   85.24%   85.24%           
=======================================
  Files         130      130           
  Lines        5517     5517           
=======================================
  Hits         4703     4703           
  Misses        814      814           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Copy link
Contributor

@guarin guarin left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks LGTM! Left some comments but feel free to resolve and merge!

README.md Show resolved Hide resolved
README.md Show resolved Hide resolved
docs/source/getting_started/benchmarks.rst Show resolved Hide resolved
docs/source/getting_started/benchmarks.rst Outdated Show resolved Hide resolved
docs/source/getting_started/benchmarks.rst Outdated Show resolved Hide resolved
docs/source/getting_started/benchmarks.rst Outdated Show resolved Hide resolved
@philippmwirth philippmwirth merged commit caf72c5 into master Nov 22, 2023
10 checks passed
@philippmwirth philippmwirth deleted the philipp-lig-3098-cleanup-pip-benchmark-docs branch November 22, 2023 10:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants