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

feat: Promote modifications to public API #2339

Merged
merged 6 commits into from
Sep 21, 2023

Conversation

kratsg
Copy link
Contributor

@kratsg kratsg commented Sep 20, 2023

Pull Request Description

Resolves #1652.

Docs: https://pyhf--2339.org.readthedocs.build/en/2339/_generated/pyhf.pdf.Model.html#pyhf.pdf.Model

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
* Promote `pyhf.pdf._MainModel._modifications` to `pyhf.pdf._MainModel.modifications`.
* Promote `pyhf.pdf.Model._modifications` to `pyhf.pdf.Model.modifications`.
* Add `pyhf.pdf._MainModel` and `pyhf.pdf._ConstraintModel` to the docs.
* Add documentation for the `modifications()` functions.

@kratsg kratsg added feat/enhancement New feature or request docs Documentation related API Changes the public API labels Sep 20, 2023
@kratsg kratsg self-assigned this Sep 20, 2023
@review-notebook-app
Copy link

Check out this pull request on  ReviewNB

See visual diffs & provide feedback on Jupyter Notebooks.


Powered by ReviewNB

@codecov
Copy link

codecov bot commented Sep 20, 2023

Codecov Report

Patch coverage: 100.00% and project coverage change: +0.68% 🎉

Comparison is base (c096b33) 97.59% compared to head (6d6e93a) 98.28%.

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #2339      +/-   ##
==========================================
+ Coverage   97.59%   98.28%   +0.68%     
==========================================
  Files          69       69              
  Lines        4538     4538              
  Branches      803      803              
==========================================
+ Hits         4429     4460      +31     
+ Misses         65       45      -20     
+ Partials       44       33      -11     
Flag Coverage Δ
contrib 97.86% <100.00%> (?)
doctest 60.99% <75.00%> (ø)
unittests-3.10 96.29% <100.00%> (ø)
unittests-3.11 96.29% <100.00%> (ø)
unittests-3.8 96.31% <100.00%> (?)
unittests-3.9 96.34% <100.00%> (ø)

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

Files Changed Coverage Δ
src/pyhf/pdf.py 98.03% <100.00%> (ø)

... and 5 files with indirect coverage changes

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

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. I just have a docs styling comment, but other than that LGTM.

src/pyhf/pdf.py Outdated Show resolved Hide resolved
@matthewfeickert
Copy link
Member

(Though maybe we also wait to see if @alexander-held has any comments before merge, given that he opened up Issue #1652)

Copy link
Member

@alexander-held alexander-held left a comment

Choose a reason for hiding this comment

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

Nothing else from me, thanks for addressing this!

Co-authored-by: Matthew Feickert <matthew.feickert@cern.ch>
src/pyhf/pdf.py Outdated 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.

LGTM. Thanks @kratsg!

@matthewfeickert matthewfeickert merged commit ae29d4b into main Sep 21, 2023
19 checks passed
@matthewfeickert matthewfeickert deleted the feat/modificationsPublic branch September 21, 2023 04:55
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
API Changes the public API docs Documentation related feat/enhancement New feature or request
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

Promote model._modifications to public API
3 participants