Make consistent behavior when denom is 0 and add docstrings #206
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
@DragaDoncila I was going to just add docstrings and type annotations, and then I noticed that the behavior was inconsistent between the different metrics for what happens when the denomintor is 0.
In this PR I change them all to warn and return np.nan, whereas previously the TRA raised a RuntimeError, the LNK warned and returned np.nan, and the DET did not check. I don't think I have strong opinions about which of these options is better, other than that checking for a zero denominator is good, so this is just a suggestion of one possible solution.
I didn't fix the tests, since I wanted your opinion on what the "correct" solution is first. Feel free to just pull the bits of code you want and treat this as a review rather than a PR - I just already wrote the code so I figured I would provide it.