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

docs: Add learn notebook on using calculators #1258

Merged
merged 16 commits into from
Jan 15, 2021
Merged

Conversation

kratsg
Copy link
Contributor

@kratsg kratsg commented Jan 14, 2021

Description

This is the last thing from #709 that we don't have in pyhf by now.

Render: https://pyhf.readthedocs.io/en/docs-usingcalculators/examples/notebooks/learn/UsingCalculators.html

Checklist Before Requesting Reviewer

  • Tests are passing
  • "WIP" removed from the title of the pull request
  • Selected an Assignee for the PR to be responsible for the log summary

Before Merging

For the PR Assignees:

  • Summarize commit messages into a comprehensive review of the PR
* Add learn notebook on using calculators (asymptotics, toy-based)
   - Add notebook to notebook tests
* Update Sphinx Makefile to correctly raise warnings as errors
   - c.f. https://www.sphinx-doc.org/en/master/man/sphinx-build.html
   - Amends PR #1257

Co-authored-by: Lukas Heinrich <[email protected]>

@kratsg kratsg added the docs Documentation related label Jan 14, 2021
@kratsg kratsg self-assigned this Jan 14, 2021
@review-notebook-app
Copy link

Check out this pull request on  ReviewNB

See visual diffs & provide feedback on Jupyter Notebooks.


Powered by ReviewNB

@kratsg kratsg mentioned this pull request Jan 14, 2021
4 tasks
@codecov
Copy link

codecov bot commented Jan 14, 2021

Codecov Report

Merging #1258 (f0b37ba) into master (316ff79) will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##           master    #1258   +/-   ##
=======================================
  Coverage   97.47%   97.47%           
=======================================
  Files          63       63           
  Lines        3716     3716           
  Branches      525      525           
=======================================
  Hits         3622     3622           
  Misses         55       55           
  Partials       39       39           
Flag Coverage Δ
unittests 97.47% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.


Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 316ff79...f0b37ba. Read the comment docs.

@kratsg kratsg force-pushed the docs/usingCalculators branch from 1562e5c to a517085 Compare January 14, 2021 21:51
docs/Makefile Show resolved Hide resolved
Copy link
Member

@matthewfeickert matthewfeickert left a comment

Choose a reason for hiding this comment

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

Thanks @kratsg. Just a quick suggestion from me and then I'll review later today when I'm finished with current work.

docs/Makefile Show resolved Hide resolved
Co-authored-by: Matthew Feickert <[email protected]>
@matthewfeickert matthewfeickert added the tests pytest label Jan 15, 2021
Copy link
Member

@matthewfeickert matthewfeickert left a comment

Choose a reason for hiding this comment

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

@kratsg I made some small formatting changes (tried to make it easy to revert any that you didn't like) and added this notebook to the notebook tests, but all LGTM! 👍

@kratsg kratsg merged commit e64e87b into master Jan 15, 2021
@kratsg kratsg deleted the docs/usingCalculators branch January 15, 2021 12:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Documentation related tests pytest
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants