Reworking the repo structure #67
Merged
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR proposes a major restructuring of the model repository, to move away from utopya-based models and instead offering a toolbox of neural network machinery, numerical solvers, and inference algorithms and are illustrated using various models. Each model folder should contain model-specific equations and solvers, a Jupyter notebook to illustrate usage and simple inference, and a utopya model to allow for ensemble training.
The goal is to allow users unfamiliar with either machine learning, Python, or in general with low coding ability to be able to easily experiment with ML-based parameter inference methodologies in Jupyter notebooks, and for the utopya models to be aimed at those with more advanced application requirements in mind.
Major changes
model.pyfile for each model, which contains the differential equation RHS (for ODEs and SDEs), which can then be plugged into a numerical solver of choicetorchdiffeqas a requirement, and usestorchdiffeqsolvers for ODEsTo-Dos: