-
Notifications
You must be signed in to change notification settings - Fork 83
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: Document Channel Summary Mixin #1972
Conversation
Codecov ReportBase: 98.24% // Head: 98.25% // Increases project coverage by
Additional details and impacted files@@ Coverage Diff @@
## master #1972 +/- ##
==========================================
+ Coverage 98.24% 98.25% +0.01%
==========================================
Files 68 68
Lines 4378 4416 +38
Branches 726 726
==========================================
+ Hits 4301 4339 +38
Misses 45 45
Partials 32 32
Flags with carried forward coverage won't be shown. Click here to find out more.
Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here. ☔ View full report at Codecov. |
5c68eb0
to
018ec28
Compare
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 might have misunderstood the purpose of the changes, but I do not see model.config.parameters
/ .par_order
mentioned in #1747 in https://pyhf--1972.org.readthedocs.build/en/1972/_generated/pyhf.pdf._ModelConfig.html. .par_names()
had already been included previously, and that is very useful, but I think .par_order
would also be needed. I think .parameters
is not particularly relevant and can be obtained by sorting .par_order
instead.
I would also suggest somehow pointing to _ModelConfig
from the pyhf.pdf.Model
page. The .config
API is not listed there, and it is not particularly intuitive for a user to look at _ModelConfig
to find out about that .config
attribute, where it says
_ModelConfig
should not be called directly. It should instead by accessed through theconfig
attribute ofModel
Given that _ModelConfig
implies internal API, I wonder whether all of this page should just live within the Model
API documentation page? This is where I would expect a user to look for it.
I'll add this in this PR. The fundamental reason that |
for more information, see https://pre-commit.ci
abd8cf5
to
f67179f
Compare
Looks like I was a bit too slow and created #1982 before the edit of the previous comment, so that would be another issue this PR closes. I see that |
I confused myself and was looking at |
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. 👍 Thanks @kratsg — this will help!
Pull Request Description
_ModelConfig
#1747model.config
property in thepyhf.pdf.Model
API documentation #1982.Checklist Before Requesting Reviewer
Before Merging
For the PR Assignees: