naming consistency/clarity within src/rail/estimation

[aimalz]

Change Description

This PR (and other concurrent PRs in the other repos) include renamings of modules and stages within src/rail/estimation for consistency and transparency to users as outlined in LSSTDESC/rail#37. (Expect a few more PRs to address the smaller set of necessary consistency/clarity changes outside src/rail/estimation using the same branch.)

• My PR includes a link to the issue that I am addressing

I request that multiple reviewers please do not hesitate to suggest changes as needed! The goals are consistency, clarity, and longevity, so if something looks unclear, inconsistent, or insufficiently flexible to accommodate future development, now is the time to make adjustments.

Solution Description

The following changes were made across all the rail repos, along with updates to the contributing documentation (which should be propagated to the rail python project template so prompts regarding naming are included in future PR checklists).

files:
  delightPZ.py --> delight_hybrid.py
  GPz.py --> _gpz_util.py
  knnpz.py --> k_nearneigh.py
  naiveStack.py --> naive_stack.py
  NZDir.py --> nz_dir.py
  pointEstimateHist.py --> point_est_hist.py
  pzflow.py --> pzflow_nf.py
  randomPZ.py --> random_gauss.py
  simpleSOM.py --> minisom_som.py
  sklearn_nn.py --> skl_neurnet.py
  somocluSOM.py --> somoclu_som.py
  trainZ.py --> train_z.py
  varInference.py --> var_inf.py
classes:
  Inform_BPZ_lite --> BPZliteInformer
  BPZ_lite --> BPZliteEstimator
  Inform_CMNNPDF --> CMNNInformer
  CMNNPDF --> CMNNEstimator
  Inform_DelightPZ --> DelightInformer
  delightPZ --> DelightEstimator  
  Inform_GPz_v1 --> GPzInformer
  GPz_v1 --> GPzEstimator
  Inform_FZBoost --> FlexZBoostInformer
  FZBoost --> FlexZBoostEstimator
  Inform_KNearNeighPDF --> KNearNeighInformer
  KNearNeighPDF --> KNearNeighEstimator
  NaiveStack --> NaiveStackSummarizer
  NZDir --> NZDirSummarizer  
  Inform_NZDir --> NZDirInformer
  PointEstimateHist --> PointEstHistSummarizer
  Inform_PZFlowPDF --> PZFlowInformer
  PZFlowPDF --> PZFlowEstimator
  RandomPZ --> RandomGaussEstimator
  Inform_SimpleNN --> SklNeurNetInformer
  SimpleNN --> SklNeurNetEstimator
  Inform_SimpleSOMSummarizer --> MiniSOMInformer
  SimpleSOMSummarizer --> MiniSOMSummarizer
  Inform_somocluSOMSummarizer --> SOMocluInformer
  somocluSOMSummarizer --> SOMocluSummarizer
  Inform_trainZ --> TrainZInformer
  TrainZ --> TrainZEstimator
  VarInferenceStack --> VarInfStackSummarizer   

Code Quality

• I have read the Contribution Guide
• My code follows the code style of this project
• My code builds (or compiles) cleanly without any errors or warnings
• My code contains relevant comments and necessary documentation

Bug Fix Checklist

• My change includes a breaking change
  • My change includes backwards compatibility and deprecation warnings (if possible)

Given that we are still pre-v1, I have not explicitly included backward compatibility, but a block of import X as Y can be constructed from the above list of changes.

Other Change Checklist

• I have updated the tutorial to highlight my new feature (if appropriate)
• I have updated unit/End-to-End (E2E) test cases to cover any changes

I fixed some instances of outdated descriptions in the demo notebooks, but others require more substantial editing, e.g. when they describe code that has long since been removed from the demo in question or aspects of the API that have significantly changed since the descriptions were written. The demos require a thorough review before v1 that's out of scope for this series of PRs.

[aimalz]

I think the test failure isn't related to anything I changed. @sschmidt23 Can you confirm whether that's true?

[sschmidt23]

I wasn't sure what caused the test failure, looks like it's not finding h5py for some reason, so the pyproject.toml made need updating, given the big reorganization.

[sschmidt23]

Oh, it's because there's an outstanding PR that should be merged in first, but I was having some trouble getting the coverage to work for some reason. I asked @eacharles to have a look at that coverage issue, once we get that PR merged we'll need to rebase this PR with that one, then everything should work.

[aimalz]

Thanks @sschmidt23 for looking into it! Should I take this to mean I should hold off on merging all these PRs and making the releases until that's resolved?

[sschmidt23]

Delight is pretty self-contained (it's not used in any demos or anything), and it's not actively being used by anyone currently. If this repo is the only holdout then I think it would be fine to merge everything else and we can track this down next week or at the RAIL-fest the following week.

[aimalz]

Okay, thanks, that makes sense! I'm going to hit all the buttons and try not to break anything. . .

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (4707895) 0.00% compared to head (cecde80) 0.00%.
Report is 3 commits behind head on main.

Additional details and impacted files

@@          Coverage Diff          @@
##            main     #17   +/-   ##
=====================================
  Coverage   0.00%   0.00%           
=====================================
  Files          1       1           
  Lines          2       2           
=====================================
  Misses         2       2           

Flag	Coverage Δ
unittests	0.00% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[sschmidt23]

I commented out the pylint command that was choking, as once changes are propagated to the rail template we'll be replacing the workflow file with the updated one anyway.

[aimalz]

Thank you @sschmidt23 for taking care of this!