lfwa / carbontracker

Track and predict the energy consumption and carbon footprint of training deep learning models.
MIT License
374 stars 27 forks source link

Added docs through MKDocs, hosted on Github Pages #72

Closed Snailed closed 3 months ago

Snailed commented 4 months ago

This PR adds type hints and docs through mkdocs and mkdocstrings. The docs are hosted on Github Pages through Github Actions. A current version can be seen on https://snailed.github.io/carbontracker/ and the final version will be seen on http://lfwa.github.io/carbontracker/. I plan to change the DNS settings such that the page is accessible through docs.carbontracker.info or similar and then make a link at carbontracker.info.