-
Notifications
You must be signed in to change notification settings - Fork 22
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 Citation for covariance calculation #176
Comments
What kind of reference are you looking for? The computation is standard error propagation |
I guess a reference isn't needed, but maybe a more specific docstring and/or in line documentation would be helpful. I spent a while trying to see how the equation in this function related to just the covariance-variance matrix, not recognizing that the calculation on line 75 and 76 is actually the error propagation formula. Additionally this function is called compute_covariance, so that is misleading unless what is happening in 78-83 is somehow converting it back to a covariance? |
I agree the documentation around this is rather confusing. I'd propose the following:
I could see changing the name to something more descriptive, but it is actually computing the covariance matrix from the ground sigmas. Maybe something like compute_rect_covariance? I think it would be better to just improve the documentation instead of trying to rename it. |
I agree with just upping the documentation, I don't think there needs to be a name change. I am also a bit worried about changing the return. Wouldn't that be considered API breaking? |
That is a fuzzy part of API breaks. I would lean towards yes, and that likely makes it not worth it unless we have other breaks we want to do. |
I am fine with just a documentation update! I will try throwing up a PR tomorrow |
Could we add a reference describing the calculation of the covariance?
https://github.com/USGS-Astrogeology/plio/blob/47af64c6f217210ad3409e58d8b0b5e7efd2e6fa/plio/utils/covariance.py#L4
The text was updated successfully, but these errors were encountered: