Several names for reduced X^2

LSSTDESC / snmachine

Machine learning code for photometric supernova classification

BSD 3-Clause "New" or "Revised" License

9 stars 5 forks source link

Several names for reduced X^2 #91

Open Catarina-Alves opened 5 years ago

Catarina-Alves commented 5 years ago

Over snmachine there are different references to the reduced X^2. I think it would be better to always call it in the same way. So far I have seen (this is not an exhaustive list):

rchi2 - snfeatures line 141
rcs - snfeatures line 594
chi2 - snfeatures line 597 (this appears in several places and I think it is dangerous as X^2 is different from reduced X^2)
redChi2 - gps line 150
reduced_chi_squared - sndata line 474
reducedChi2 - gps line 289

I propose to call it ~~reduced_chi2~~ reduced_chi_squared for variable name.

Catarina-Alves commented 5 years ago

This change can be gradual but once we touch a function/ class that has one of these names, we can change it to the accorded one.

Catarina-Alves commented 5 years ago

Files changed to this convention:

~~gps_test.py (except line 30 as it uses something from sndata)~~

tallamjr commented 5 years ago

I personally would prefer to not have numbers in variable names, so something like reduced_chi_square is preferable to me

Catarina-Alves commented 5 years ago

I personally would prefer to not have numbers in variable names, so something like reduced_chi_square is preferable to me

I am okay with that. It is a bit longer and it was because of that that I choose the other.

tallamjr commented 5 years ago

Can we close this, or does this relate to this https://github.com/LSSTDESC/snmachine/pull/122#issuecomment-493093270 ?