search

kilometersvi / EnergySymbolicRegression

MIT License
0 stars 2 forks source link

Document Code & Rename files #3

Open minnayu opened 10 months ago

minnayu commented 10 months ago

Since the code is comprehensive, I would suggest adding comments to the source code files in src/energysymbolicregression/model/ to note what each function does to help us understand how everything works. I notice the classes are documented, but the functions within the classes are not. I also suggest renaming the source code files for better clarity to accurately display what each file contributes to the model. This will help us understand your project's purpose as a whole.

kilometersvi commented 10 months ago

This is a good idea Minna. Further documentation will be added before the next peer review, particularly with functions. If you have suggestions for new file names, let me know. Issue will be closed after further documentation pushed.