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.

Sign up for GitHub

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

Jump to bottom

Promote model._modifications to public API #1652

Closed
1 task done
alexander-held opened this issue Oct 19, 2021 · 0 comments · Fixed by #2339
Closed
1 task done

Promote model._modifications to public API #1652

alexander-held opened this issue Oct 19, 2021 · 0 comments · Fixed by #2339
Assignees
@kratsg
Labels
API Changes the public API feat/enhancement New feature or request

Comments

@alexander-held
Copy link
Member

Summary

pyhf.pdf._MainModel._modifications is useful for model visualization and debugging. See for example #1639 (comment). It also came up in the discussion #1414. This function is currently not part of the public API. Given its usefulness, I propose changing that. This suggestion also came up in #1461 (comment).

Two alternatives are possible: using the _modifications API even though it signals it is not public (accepting a possible breaking change in the future), or re-implementing it externally.

Additional Information

See #1639 (comment) for example usage, this API could presumably also be used for pyhf-validation/scripts/validate_systs.py.

Code of Conduct

  • I agree to follow the Code of Conduct
@alexander-held alexander-held added feat/enhancement New feature or request needs-triage Needs a maintainer to categorize and assign labels Oct 19, 2021
@alexander-held alexander-held mentioned this issue Oct 19, 2021
Open
4 tasks
@alexander-held alexander-held mentioned this issue Feb 25, 2022
Closed
@kratsg kratsg self-assigned this Sep 20, 2023
@kratsg kratsg added API Changes the public API and removed needs-triage Needs a maintainer to categorize and assign labels Sep 20, 2023
@kratsg kratsg mentioned this issue Sep 20, 2023
Merged
4 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@kratsg kratsg

Labels
API Changes the public API feat/enhancement New feature or request
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

feat: Promote modifications to public API scikit-hep/pyhf
2 participants
@kratsg @alexander-held