From 88e4650e1381129fb20c620e90171265cd0d8bea Mon Sep 17 00:00:00 2001 From: root Date: Mon, 20 Nov 2023 12:15:10 +0100 Subject: [PATCH] adding docstring on __init__.py --- deep_learning_power_measure/__init__.py | 3 +++ 1 file changed, 3 insertions(+) diff --git a/deep_learning_power_measure/__init__.py b/deep_learning_power_measure/__init__.py index 3d84785..f2cf564 100644 --- a/deep_learning_power_measure/__init__.py +++ b/deep_learning_power_measure/__init__.py @@ -6,6 +6,9 @@ def main(): + """small function mainly used to record power consumption of a command by calling directly the module deep_learning_power_measure + for an example, please see the end section in the quickstart documentation : "TIPS and use cases" + """ parser = argparse.ArgumentParser() parser.add_argument("--cmd", help="the running command you want to monitor",type=str) parser.add_argument("--output_folder", help="directory to save the energy consumption records",type=str, default="power_measure")