ml-energy / zeus

Deep Learning Energy Measurement and Optimization
https://ml.energy/zeus
Apache License 2.0
180 stars 24 forks source link

Chore: Clean up docs and READMEs #6

Closed jaywonchung closed 1 year ago

jaywonchung commented 1 year ago

This PR cleans up docstrings, example READMEs, and the homepage documentation. Also, the zeus docker image will build and hold the zeus monitor at image build time.

Rosie-m commented 1 year ago

Thanks a lot for the review and suggestions!

I didn't get your comment about the link in https://ml.energy/zeus/getting_started/environment/. In the page, there's only two links: docker and nvidia-docker2. Where's the link to our Docker image?

I was talking about the link right after the section title "Zeus Docker image": image

jaywonchung commented 1 year ago

Oh wow, I completely missed that! Thanks for pointing out. Just pushed a fix!