NSAPH-Projects / topological-equivariant-networks

E(n)-Equivariant Topological Neural Networks
MIT License
19 stars 0 forks source link

refactor graph lifting & enhancements #5

Closed ekarais closed 8 months ago

ekarais commented 8 months ago

Objective

This branch began with the aim to refactor graph lifting functionality but evolved to encompass various improvements and fixes across the repository.

Key Changes

Refactoring:

Testing & Development:

Usability & Documentation:

Performance Monitoring & Code Optimization:

Additional Notes

The collective updates not only address the initial goal of refactoring but also introduce significant enhancements that improve the development workflow, code maintainability, and project scalability.

Request for Review

Feedback is highly encouraged to ensure these changes align with our project objectives and meet our quality standards.

ekarais commented 8 months ago

I decided to remove [all] after noticing that it would install the following:

doc = [
    "jupyter",
    "nbsphinx",
    "nbsphinx_link",
    "sphinx <= 5.3.0",
    "sphinx_gallery",
    "pydata-sphinx-theme"
]
lint = [
    "black < 23.0",
    "black[jupyter]",
    "flake8",
    "flake8-docstrings",
    "Flake8-pyproject",
    "isort",
    "pre-commit"
]
test = [
    "pytest",
    "pytest-cov",
    "coverage",
    "jupyter"
]

These are really only needed if we were to contribute to TopoNetX so I think it is fine to leave them out. We can consider adding black, isort etc. as pre-commit hooks but this would be a different issue. @mauriciogtec can you try creating the environment on your end before we merge this?