Build out docs - Githubissues

choderalab / mtenn

Modular Training and Evaluation of Neural Networks

MIT License

5 stars 1 forks source link

Build out docs #53

Closed kaminow closed 2 months ago

kaminow commented 4 months ago

Fully build out the docs, including more in-depth explanations of the different components and some how-to guides.

API Docs:

[x] combination
[x] config
[x] __init__
[x] model
[x] readout
[x] representation
[x] strategy
[x] conversion_utils/e3nn
[x] conversion_utils/gat
[x] conversion_utils/__init__
[x] conversion_utils/schnet
[x] conversion_utils/visnet

codecov-commenter commented 4 months ago

Codecov Report

Merging #53 (3ef6957) into main (b902fc6) will decrease coverage by 50.00%. The diff coverage is 4.76%.

Additional details and impacted files

ijpulidos commented 4 months ago

Docs are looking goooood! :)

mikemhenry commented 3 months ago

I think the install documentation needs to be updated. I don't think this file exists mtenn/devtools/conda-envs/mtenn.yaml. I would update with how to install on conda-forge, then I would explain how to install the development version.

Once you do that give me a ping on slack and I will give it a review :)

Let me know if you have any questions!

kaminow commented 2 months ago

@hmacdope and/or @mikemhenry I think these are done and ready for a review!