Skip to content

Commit

Permalink
Merge pull request #79 from lfwa/master
Browse files Browse the repository at this point in the history
Update dev from master
  • Loading branch information
Snailed authored Sep 13, 2024
2 parents a547f9e + f48cfe9 commit 1722394
Showing 1 changed file with 10 additions and 0 deletions.
10 changes: 10 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@
[![Python](https://img.shields.io/badge/python-%3E%3D3.7-blue)](https://www.python.org/downloads/)
[![Unit Tests](https://github.com/lfwa/carbontracker/actions/workflows/test.yml/badge.svg)](https://github.com/lfwa/carbontracker/actions)
[![License](https://img.shields.io/github/license/lfwa/carbontracker)](https://github.com/lfwa/carbontracker/blob/master/LICENSE)
[![Downloads](https://static.pepy.tech/badge/carbontracker)](https://pepy.tech/project/carbontracker)

[Website](https://carbontracker.info)

Expand All @@ -30,6 +31,13 @@ pip install carbontracker

## Basic usage

### Command Line Mode
Wrap any of your scripts (python, bash, etc.):

`carbontracker python script.py
`
### Embed into Python Scripts

#### Required arguments
- `epochs`:
Total epochs of your training loop.
Expand Down Expand Up @@ -179,6 +187,8 @@ Measured GPU devices: ['Tesla T4']
## Extending **carbontracker**
See [CONTRIBUTING.md](CONTRIBUTING.md).

## Star History
[![Star History Chart](https://api.star-history.com/svg?repos=lfwa/carbontracker&type=Date)](https://star-history.com/#lfwa/carbontracker&Date)

## carbontracker in media
* Official press release from University of Copenhagen can be obtained here: [en](https://news.ku.dk/all_news/2020/11/students-develop-tool-to-predict-the-carbon-footprint-of-algorithms/) [da](https://nyheder.ku.dk/alle_nyheder/2020/11/studerende-opfinder-vaerktoej-der-forudsiger-algoritmers-co2-aftryk/)
Expand Down

0 comments on commit 1722394

Please sign in to comment.