Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Simplicial: Migrate Neural Network's Class inside topomodelx/nn #171

Closed
ninamiolane opened this issue Aug 24, 2023 · 3 comments
Closed

Simplicial: Migrate Neural Network's Class inside topomodelx/nn #171

ninamiolane opened this issue Aug 24, 2023 · 3 comments
Assignees

Comments

@ninamiolane
Copy link
Collaborator

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:

  • 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.
@ninamiolane 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
@ninamiolane
Copy link
Collaborator Author

Potentially consider: https://nbdev.fast.ai/

@ninamiolane
Copy link
Collaborator Author

@maneel1995 -> Need to accept the invitation

@ninamiolane
Copy link
Collaborator Author

Completed through PR #158 and PR #189

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants