### repo sanitization - assess the structure of the repo to: - include `docstring` style documentation for all models, utils - include style guidelines, automated tests for linting - include git conventions, branch creation strategies, recommended good practices for contribution - include `ISSUE_TEMPLATE`, and guidelines for creating PR's to contributors ### docs and auto-deployment - modify the `README` to provide higher level idea, description, and example script to get started - include necessary documentation resources within `README` and point to the docs site for elaborate usage/explanations of `HydraGNN` - mention about `HPC` component of running `HydraGNN` on exascale compute clusters like `Frontier`, etc. - test the feasibility of either using `pdoc3` or `readthedocs` to ensure documentation of the website is automatically pushed to a connected web endpoint
repo sanitization
docstringstyle documentation for all models, utilsISSUE_TEMPLATE, and guidelines for creating PR's to contributorsdocs and auto-deployment
READMEto provide higher level idea, description, and example script to get startedREADMEand point to the docs site for elaborate usage/explanations ofHydraGNNHPCcomponent of runningHydraGNNon exascale compute clusters likeFrontier, etc.pdoc3orreadthedocsto ensure documentation of the website is automatically pushed to a connected web endpoint