docs: Add docstrings and examples to infer fitting methods #849
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Codecov Report
@@ Coverage Diff @@
## master #849 +/- ##
=======================================
Coverage 96.09% 96.09%
=======================================
Files 54 54
Lines 3019 3019
Branches 424 424
=======================================
Hits 2901 2901
Misses 75 75
Partials 43 43
Continue to review full report at Codecov.
|
|
Currently failing due to floats and doctest. |
Nothing important is being checked, just showing another way
macOS diverges from Linux
kratsg
requested changes
May 1, 2020
paramters -> parameters
The example uses the return_uncertainties=True kwarg, but as that is not universally suported it is probably not a good idea to demo that in an example for the fit API
kratsg
approved these changes
May 1, 2020
lukasheinrich
approved these changes
May 1, 2020
|
LGTM! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Fix the docstrings for
infer.mle.fitandinfer.mle.fixed_poi_fit. Add examples toinfer.mlefit methods,infer.hypotest, andinfer.test_statistics.qmu.To get
doctestpassing on the macOS builds there is a small cheat in that the MINUIT example forpyhf.infer.mle.fithas its evaluations skipped. The SciPy optimizer evaluations before it pass though, so this small deviation should be fine.ReadTheDocs build: https://pyhf.readthedocs.io/en/docs-add-infer-mle-doc-strings/_generated/pyhf.infer.hypotest.html
Checklist Before Requesting Reviewer
Before Merging
For the PR Assignees: