-
Notifications
You must be signed in to change notification settings - Fork 79
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
hypotest documentation not clear on return types depending on test statistic chosen #2262
Comments
To summarize briefly from offline with @phinate and @alexander-held (some bullet points):
|
One more thing, |
We do state this in the pyhf/src/pyhf/infer/__init__.py Lines 108 to 112 in 852a224
with a special note as well pyhf/src/pyhf/infer/__init__.py Lines 115 to 122 in 852a224
Although the place that I've found it to be the most clear (and I should update this as well in the docs) is in Appendix A.1.2 and Table 11 in the Procedure for the LHC Higgs boson search combination in Summer 2011 — which actually describes what ATLAS and CMS did for the Higgs discovery. (This reference document has been quite useful before, as we used it as a reference check in PR #1610). |
Summary
If we have
return_tail_probs=True
, then fortest_stat
in['qmu', 'qtilde']
, we return[CLs, CLsb, CLb]
; while fortest_stat=q0
we return[CLsb, CLb]
only.Documentation Page Link
https://scikit-hep.org/pyhf/_generated/pyhf.infer.hypotest.html#pyhf.infer.hypotest
Code of Conduct
The text was updated successfully, but these errors were encountered: