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

Review docstring and possibly raise a userwarning for pearsonr based on preserve_dims=all #703

Open
tennlee opened this issue Sep 27, 2024 · 1 comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request good first issue Good for newcomers

Comments

@tennlee
Copy link
Collaborator

tennlee commented Sep 27, 2024

Issue: pearsonr may be mathematically undefined when all dimensions are preserved, resulting in NaNs being returned. This isn't exactly wrong, but is perhaps not what a user would be expecting and could be made clearer

Solution: This should at least be documented, and possibly a user warning should also be raised in the code

See also: KGE uses pearsonr in its calculation so is also affected - it has this described in the docstring

@nicholasloveday
Copy link
Collaborator

I think a user warning is a good idea

@tennlee tennlee added documentation Improvements or additions to documentation enhancement New feature or request good first issue Good for newcomers labels Nov 22, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

2 participants