From f48cfe9b9bab16b6e92fe98706502f1b479d8034 Mon Sep 17 00:00:00 2001 From: Raghav <8407225+raghavian@users.noreply.github.com> Date: Sun, 25 Aug 2024 18:45:40 +0200 Subject: [PATCH] Add cli desc. --- README.md | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/README.md b/README.md index 6c24484..9d0197b 100644 --- a/README.md +++ b/README.md @@ -31,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.