Issue/152/model - Githubissues

LSSTDESC / rail_base

Base classes for RAIL

MIT License

0 stars 1 forks source link

Issue/152/model #153

Closed eacharles closed 1 month ago

eacharles commented 1 month ago

Problem & Solution Description (including issue #)

Code Quality

[ ] My code follows the code style of this project
[ ] I have written unit tests or justified all instances of #pragma: no cover; in the case of a bugfix, a new test that breaks as a result of the bug has been added
[ ] My code contains relevant comments and necessary documentation for future maintainers; the change is reflected in applicable demos/tutorials (with output cleared!) and added/updated docstrings use the NumPy docstring format
[ ] Any breaking changes, described above, are accompanied by backwards compatibility and deprecation warnings

codecov[bot] commented 1 month ago

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 98.47%. Comparing base (c1d42e1) to head (443612a). Report is 1 commits behind head on main.

Additional details and impacted files

```diff @@ Coverage Diff @@ ## main #153 +/- ## ========================================== + Coverage 98.44% 98.47% +0.02% ========================================== Files 44 45 +1 Lines 2438 2485 +47 ========================================== + Hits 2400 2447 +47 Misses 38 38 ```

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

ztq1996 commented 1 month ago

This is a good way to track the creating class of the model, version of the code, etc. I have one concern though: is it correct that if we (1) save a model file with this Model class, (2) for some reason change some variable names in this class, (3) try to open the model file with the new code, we will get an error because the underlying class is modified?

The reason I am asking: we should be pretty sure about the variable names in this class, and in the longer future we probably want to freeze this, in case people be yelling "why can't I open my model now"

eacharles commented 1 month ago

I think we have a few choice for dealing with that. 1) we can always convert the class_name in the files.
2) we can have the new class check both the new name and the old name.