LSSTDESC / rail

Top level "umbrella" package for RAIL
MIT License
8 stars 3 forks source link

Rename all the things (that are outdated/confusing/inconsistent) #37

Closed eacharles closed 1 year ago

eacharles commented 1 year ago

From Alex's PR

The scope of changes is to standardize naming of classes (and hopefully their config parameters, although I'm not sure I understand them all well enough to do that alone) that are going to be isolated into standalone repos in LSSTDESC/RAIL#384, to be accompanied by PRs in the existing standalone repos as necessary. To prevent myself from getting distracted from the task at hand, I'm also adding TODO notes to give concrete starting points for https://github.com/LSSTDESC/rail/issues/22.

EDIT: Overall, the changes here pertain solely to consistency in class and module naming; apologies if this was unclear to anyone! The purpose is so we don't inadvertently ask users to guess at the syntax for a given stage with respect to the module it's in (occasionally risking namespace issues if they import common packages with the same as a RAIL module) and with respect to other stages that do similar things with other underlying algorithms, across creation and evaluation as well as within estimation (leaving open the possibility to distinguish algorithms that can be used for both estimation and summarization). It also addresses a common source of confusion among users trying to understand the idea of stages in general, due to naming standards we established before switching to ceci as a back-end: rather than being a function or method, if a stage is an object that takes an extra line of code to run, why are they sometimes named as actions or underlying algorithms (without indication of whether it's an estimator or summarizer)?

In any case, this PR affects formatting only, not content/meaning of any of the classes in question, so my hope is that the disruption is entirely degenerate with that anticipated for LSSTDESC/RAIL#384, if they happen at the same time. The changes include the following:

knnpz.py --> knnPZ.py
Inform_KNearNeighPDF --> KNNInformer
KNearNeighPDF --> KNNEstimator
NaiveStack --> NaiveStackSummarizer
Inform_NZDir --> NZDirInformer
NZDir.py --> nzDir.py
NZDir --> NZDirSummarizer
pointEstimateHist.py --> pointEst.py
PointEstimateHist --> PointEstSummarizer
Inform_PZFlowPDF --> PZFlowInformer
pzflow.py --> pzflowPZ.py
PZFlowPDF --> PZFlowEstimator
RandomPZ --> RandomPZEstimator
Inform_SimpleSOMSummarizer --> SimpleSOMInformer
sklearn_nn.py --> simpleNN.py
Inform_SimpleNN --> SimpleNNInformer
SimpleNN --> SimpleNNEstimator
Inform_somocluSOMSummarizer --> SOMocluInformer
somocluSOMSummarizer --> SOMocluSummarizer
Inform_trainZ --> TrainZInformer
TrainZ --> TrainZSummarizer
VarInferenceStack --> VarInfStackSummarizer

I can put together a block of import X as Y for backwards compatibility in case anyone finds the changes too hard to propagate through pipelines you've already written.

Note that the base classes are unaffected (though they will be in https://github.com/LSSTDESC/rail_base/issues/14, at least there aren't any Evaluators outside base RAIL), so stages that are not updated for consistency won't be broken. Propagation of consistent naming to the already standalone repos will be completed in subsequent PRs in those repos. However, I'd like to take advantage of the opportunity posed by the isolation-refactoring disruption to make similar changes to some of the degraders, on a separate issue/branch/PR akin to https://github.com/LSSTDESC/rail_base/issues/14.

sschmidt23 commented 1 year ago

Looks like the wrong issue got linked, reopening.

aimalz commented 1 year ago

@joezuntz made a good suggestion on LSSTDESC/rail_gpz_v1#6:

Feel free to say "no" to this, but have you considered using a prefix to help namespace the stage classes? In TXPipe all our stages start with "TX" and that really helps a) make it obvious what is a pipeline stage and what's just a helper class b) distinguish from RAIL stages.

I know this is just my pedantry coming through so please do ignore this if you prefer!

Thanks! Yeah, as you can see, that's indeed one of the problems we're running into. We had a prefix for Informers (that predated the ceci refactoring so was a bit confusing for people new to stages) but were inconsistent with Estimators/Summarizers (some ended in PDF, Summarizer, etc. but some were just the name of the method without specification). Is the proposal to always make it a prefix rather than a suffix?

joezuntz commented 1 year ago

Prefix is maybe a little more traditional (all the MacOS classes start with NS, for example), but suffix should work too, sure.