Simulation Object Restructure (First Phase) #2212
Conversation
|
@Rodot- Please have a look at this PR now. Tried to maintain a fixed commit history. Three files have been modified, including the mailmap |
|
|
||
|
|
||
| class ConvergencePlot: | ||
| @staticmethod |
There was a problem hiding this comment.
if it's a static method, you don't need self as an argument.
There was a problem hiding this comment.
@sonachitchyan Tried to remove it. But, few tests were breaking
There was a problem hiding this comment.
Did you remove the self from the calls in the simulation as well? What was the error?
There was a problem hiding this comment.
@Rodot- I think now it's resolved. Please have a look!
Codecov Report
@@ Coverage Diff @@
## master #2212 +/- ##
==========================================
+ Coverage 71.81% 71.82% +0.01%
==========================================
Files 133 134 +1
Lines 12355 12360 +5
==========================================
+ Hits 8873 8878 +5
Misses 3482 3482
📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more |
| def damped_converge(value, estimated_value, damping_factor): | ||
| return value + damping_factor * (estimated_value - value) | ||
|
|
||
| def _get_convergence_status( |
There was a problem hiding this comment.
Is this meant to be a static method?
There was a problem hiding this comment.
@Rodot-
I thought, since damped_converge does not depend on any instance variables or attributes of the ConvergencePlot class, we can make it a static method instead of an instance method. Also this can allow it to be used more flexibly outside the context of ConvergencePlot class (If needed).
Please let me know if I need to make any changes!
| logger = logging.getLogger(__name__) | ||
|
|
||
|
|
||
| class ConvergencePlot: |
There was a problem hiding this comment.
This class seems to be able to do everything with static methods and there's no init. Does this actually need to be a class or could the whole thing just be a module? If it is a class, what attributes does it have and keep track of?
There was a problem hiding this comment.
@Rodot-
Yeah we can refactor this class as a module with standalone functions. But, even though the current implementation of ConvergencePlot does not have any instance variables, it may be useful to keep it as a class if there is a possibility that instance variables may be added in the future to track and store the convergence data across multiple function calls.
Please let me know if there's any changes required!
There was a problem hiding this comment.
I think you should include the plotting part of advance_state in the ConvergencePlot class as well. Ideally, the class should entirely handle all of the convergence information and calculations and simply give back the results to be incorporated into the simulation
📝 Description
Type: 🚀
featureCreated a new class ConvergencePlot under the file name tardis/simulation/convergence_plot.py and move damped_converge and _get_convergence_status methods in that. Changes are there in tardis/simulation/base.py and tardis/simulation/convergence_plot.py
📌 Resources
Examples, notebooks, and links to useful references.
🚦 Testing
How did you test these changes?
☑️ Checklist
build_docslabel