You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
We consider the neural networks (not the layers, the full networks) implemented for the simplicial domain. These neural networks are currently implemented as Python classes in the tutorials notebooks.
We should, instead, port their implementation into the core code base, specifically into: topomodelx/nn/simplicial/.
Why?
The neural networks are "hidden" in the tutorials.
They might also be less unit-tested than what they could be if they were inside the core codebase.
Where?
The files to modify are:
tutorials/simplicial/*_train.ipynb
topomodelx/nn/simplicial/
NOTE: This issue only focus on layers within the simplicial domain. There will be other issues to port the neural network python code into the core code base for the other domains.
How?
For each file tutorials/simplicial/[model-name]_train.ipynb:
Locate the code of the Python class that defines the neural network within the ipynb notebook,
Create a new file topomodelx/nn/simplicial/[model-name].py (note the absence of any _layer suffix).
Copy the code of the Python class that defines the neural network there.
Create a new file test/nn/simplicial/test_[model-name].py (note the absence of any _layer suffix).
Add unit-tests: one test for each of the method of the neural network's Python class.
Make sure that the unit-tests pass and that the methods are correctly documented.
The text was updated successfully, but these errors were encountered:
ninamiolane
changed the title
Simplicial: Bring Neural Network's Class inside topomodelx/nn
Simplicial: Migrate Neural Network's Class inside topomodelx/nn
Aug 31, 2023
What?
We consider the neural networks (not the layers, the full networks) implemented for the simplicial domain. These neural networks are currently implemented as Python classes in the tutorials notebooks.
We should, instead, port their implementation into the core code base, specifically into:
topomodelx/nn/simplicial/
.Why?
The neural networks are "hidden" in the tutorials.
They might also be less unit-tested than what they could be if they were inside the core codebase.
Where?
The files to modify are:
NOTE: This issue only focus on layers within the simplicial domain. There will be other issues to port the neural network python code into the core code base for the other domains.
How?
For each file
tutorials/simplicial/[model-name]_train.ipynb
:topomodelx/nn/simplicial/[model-name].py
(note the absence of any_layer
suffix).test/nn/simplicial/test_[model-name].py
(note the absence of any_layer
suffix).The text was updated successfully, but these errors were encountered: