-
Notifications
You must be signed in to change notification settings - Fork 246
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
Add more benchmarking documentation #822
Conversation
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## master #822 +/- ##
==========================================
- Coverage 95.67% 95.63% -0.04%
==========================================
Files 102 102
Lines 9654 9655 +1
==========================================
- Hits 9236 9234 -2
- Misses 418 421 +3 ☔ View full report in Codecov by Sentry. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM!
(for other reviewers: this is what the link in the README looks like when rendered)
|
||
# -- Download the latest benchmark summary ------------------------------------- | ||
download_url = ( | ||
"https://github.com/HumanCompatibleAI/imitation/releases/latest/" |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
using /latest
redirects to the most recent release, which I think means we'll need to provide benchmark_runs.zip
on every subsequent release — is that something we're committed to doing?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I would be. What do you think @AdamGleave ? I eventually would love to make this part of the release pipeline.
Btw I only did type annotation changes in |
Adds the benchmarking README and the Benchmark Summary to the Sphinx documentation.