Skip to content

Commit

Permalink
adding docstring on __init__.py
Browse files Browse the repository at this point in the history
  • Loading branch information
sekkariaamer12 committed Nov 20, 2023
1 parent ac3bba4 commit 88e4650
Showing 1 changed file with 3 additions and 0 deletions.
3 changes: 3 additions & 0 deletions deep_learning_power_measure/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -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")
Expand Down

0 comments on commit 88e4650

Please sign in to comment.