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

docs: Note shapesys and staterror modifier set to 1 for modifier data of 0 #1740

Merged
merged 5 commits into from
Jan 5, 2022
Merged

docs: Note shapesys and staterror modifier set to 1 for modifier data of 0 #1740

merged 5 commits into from
Jan 5, 2022

Conversation

matthewfeickert
Copy link
Member

@matthewfeickert matthewfeickert commented Dec 24, 2021 •
edited
Loading

Description

Resolves #1717

Note in warning that for shapesys and staterror modifier data with bins of 0 will result in the modifier being fixed to 1 (changed in PR #1639).

Also move description of example before the example for clarity and simplicity.

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
* Update warning note for shapesys modifier, and add similar warning for
staterror modifier, that bins that have a modifier data value of 0 will
result in a nuisance parameter being allocated resulting in a fixed modifier
of 1.
   - These changes occurred in PR #1639
* Move descriptions of modifier examples before example is given for clarity.

@matthewfeickert matthewfeickert added the docs Documentation related label Dec 24, 2021
@matthewfeickert matthewfeickert self-assigned this Dec 24, 2021
@matthewfeickert matthewfeickert changed the title docs: Add Docs/clarify warning shapesys staterror docs: Note shapesys and staterror modifier set to 1 for modifier data of 0 Dec 24, 2021
@codecov
Copy link

codecov bot commented Dec 24, 2021 •
edited
Loading

Codecov Report

Merging #1740 (c512236) into master (56dcf45) will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##           master    #1740   +/-   ##
=======================================
  Coverage   98.12%   98.12%           
=======================================
  Files          64       64           
  Lines        4270     4270           
  Branches      683      683           
=======================================
  Hits         4190     4190           
  Misses         46       46           
  Partials       34       34
Flag Coverage Δ
contrib 26.25% <ø> (ø)
doctest 60.58% <ø> (ø)
unittests 96.18% <ø> (ø)

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

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 56dcf45...c512236. Read the comment docs.

@matthewfeickert
Copy link
Member Author

Relevant RTD build page for review: https://pyhf--1740.org.readthedocs.build/en/1740/likelihood.html#modifiers

@matthewfeickert matthewfeickert force-pushed the docs/clarify-warning-shapesys-staterror branch from cecadd4 to c512236 Compare January 4, 2022 08:33
@kratsg kratsg merged commit f94e72f into master Jan 5, 2022
@kratsg kratsg deleted the docs/clarify-warning-shapesys-staterror branch January 5, 2022 20:07
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@kratsg kratsg kratsg approved these changes

@lukasheinrich lukasheinrich Awaiting requested review from lukasheinrich

Assignees

@matthewfeickert matthewfeickert

Labels
docs Documentation related
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Clarify warning for shapesys (and staterror) in documentation
2 participants
@matthewfeickert @kratsg