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

add validation function for psf norm #142

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Conversation

AMWMitchell
Copy link

No description provided.

@codecov
Copy link

codecov bot commented Mar 23, 2021

Codecov Report

Merging #142 (b61c2fb) into master (aa63141) will decrease coverage by 0.78%.
The diff coverage is 0.00%.

Impacted file tree graph

@@            Coverage Diff             @@
##           master     #142      +/-   ##
==========================================
- Coverage   87.35%   86.57%   -0.79%     
==========================================
  Files          38       39       +1     
  Lines        1329     1341      +12     
==========================================
  Hits         1161     1161              
- Misses        168      180      +12     
Impacted Files Coverage Δ
pyirf/validation.py 0.00% <0.00%> (ø)

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 aa63141...b61c2fb. Read the comment docs.

Copy link
Member

@HealthyPear HealthyPear left a comment

Choose a reason for hiding this comment

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

Thanks for this!

I think the code is OK, but before approving I would like this PR to have 2 small additional things,

  • a unit-test under pyirf/tests/test_validation.py in which a PSF table not completely normalized is fed to the validate_psf which asserts the failure
  • a section in the docs at the same level of e.g. docs/utils.rst called docs/irf_validation.rst or docs/output_validation.rst in which this contribution is explained - then we can use that docs page to describe any other DL3 validation tool we might introduce (you can copy/paste/edit any docs section at the same level to get the same layout)

@HealthyPear HealthyPear added data validation enhancement New feature or request input/output Format and file extensions of the input/output data. labels Apr 9, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
data validation enhancement New feature or request input/output Format and file extensions of the input/output data.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants