https://github.com/poloclub/energyvis
https://github.com/poloclub/energyvis
Last synced: 5 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/poloclub/energyvis
- Owner: poloclub
- License: mit
- Created: 2020-10-30T23:27:07.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2023-01-06T00:43:38.000Z (almost 3 years ago)
- Last Synced: 2024-05-12T00:47:37.505Z (over 1 year ago)
- Language: JavaScript
- Size: 6.75 MB
- Stars: 7
- Watchers: 9
- Forks: 1
- Open Issues: 16
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# EnergyVis
A tool for interactively tracking and exploring energy consumption for ML models
[](https://github.com/poloclub/EnergyVis/actions)
[](https://arxiv.org/abs/2103.16435)
For more information, check out our manuscript:
[**EnergyVis: Interactively Tracking and Exploring Energy Consumption for ML Models**](https://arxiv.org/abs/2103.16435).
Omar Shaikh, Jon Saad-Falcon, Austin P Wright, Nilaksh Das, Scott Freitas, Omar Asensio, and Duen Horng (Polo) Chau.
*Extended Abstracts of the 2021 CHI Conference on Human Factors in Computing Systems*
## Live Demo
For a live demo (without using the backend), visit: http://poloclub.github.io/EnergyVis/
## Running Locally
Clone or download this repository:
```bash
git clone git@github.com:poloclub/EnergyVis.git
# use degit if you don't want to download commit histories
degit poloclub/EnergyVis
```
Navigate to the frontend folder:
```bash
cd frontend
```
Install the dependencies:
```bash
yarn install
```
Then run EnergyVis:
```bash
yarn start
```
Navigate to [localhost:5000](https://localhost:5000). You should see EnergyVis running in your broswer :)
## Run Optional Backend
If you want to collect data on your model's energy profile, you can set up live-tracking by starting the EnergyVis backend.
Navigate to the backend folder:
```bash
cd backend
```
Install the backend module:
```bash
pip install --editable ./
```
Use the module in your training code, like documented below:
```python
from carbontracker.tracker import CarbonTracker
tracker = CarbonTracker(epochs=max_epochs)
# Training loop.
for epoch in range(max_epochs):
tracker.epoch_start()
# Your model training.
tracker.epoch_end()
# Optional: Add a stop in case of early termination before all monitor_epochs has
# been monitored to ensure that actual consumption is reported.
tracker.stop()
```
In the console, you'll see a backend URL being printed when you run your training code. Simply plug this URL into the EnergyVis frontend to live-track your model.
## Credits
CNN Explainer was created by
Omar Shaikh,
Jon Saad-Falcon,
Austin P Wright,
Nilaksh Das,
Scott Freitas,
Omar Asensio, and
Polo Chau
## Citation
```bibTeX
@inproceedings{shaikhEnergyVis2021,
author = {Shaikh, Omar and Saad-Falcon, Jon and Wright, Austin P and Das, Nilaksh and Freitas, Scott and Asensio, Omar and Chau, Duen Horng},
title = {EnergyVis: Interactively Tracking and Exploring Energy Consumption for ML Models},
year = {2021},
isbn = {9781450380959},
publisher = {Association for Computing Machinery},
address = {New York, NY, USA},
url = {https://doi.org/10.1145/3411763.3451780},
doi = {10.1145/3411763.3451780},
booktitle = {Extended Abstracts of the 2021 CHI Conference on Human Factors in Computing Systems},
articleno = {458},
numpages = {7},
keywords = {environmental sustainability, computational equity, machine learning, interactive visualization},
location = {Yokohama, Japan},
series = {CHI EA '21}
}
```
Also, cite carbontracker, which we rely on for our backend!
```bibTeX
@misc{anthony2020carbontracker,
title={Carbontracker: Tracking and Predicting the Carbon Footprint of Training Deep Learning Models},
author={Lasse F. Wolff Anthony and Benjamin Kanding and Raghavendra Selvan},
howpublished={ICML Workshop on Challenges in Deploying and monitoring Machine Learning Systems},
month={July},
note={arXiv:2007.03051},
year={2020}}
```
## License
The software is available under the [MIT License](https://github.com/poloclub/EnergyVis/blob/master/LICENSE).
## Contact
If you have any questions, feel free to [open an issue](https://github.com/poloclub/EnergyVis/issues/new/choose) or contact [Omar Shaikh](https://oshaikh.com).