update : doccumentation

Author: chakib-belgaid

README.md

@@ -57,6 +57,24 @@ By default, **pyRAPL** monitors all the available devices of the machine's socke
 
 You can append the device `pyRAPL.Device.DRAM` to the `devices` parameter list to monitor RAM device too. 
 
+## Running the test multiple times 
+
+For short functions, you can configure the number of runs and it will calculate the mean energy consumption of all runs. 
+As an example if you want to run the test 100 times :
+
+	import pyRAPL
+
+	pyRAPL.setup()
+	
+	
+	@pyRAPL.measure(number=100)
+	def fun():
+		# Some stuff ...
+
+	for _ in range(100):
+		fun()
+	
+
 ## Configure the output of the decorator
 
 If you want to handle data with different output than the standard one, you can configure the decorator with an `Output` instance from the `pyRAPL.outputs` module.
@@ -77,7 +95,7 @@ As an example if you want to write the recorded energy consumption in a csv file
 	for _ in range(100):
 		fun()
 		
-	csv_output.save() 
+	csv_output.save()
 
 This will produce a csv file of 100 lines. Each line containing the energy
 consumption recorded during one execution of the function `fun`.

docs/quickstart.rst

@@ -49,6 +49,25 @@ By default, **pyRAPL** monitors all the available devices of the machine's socke
 
 You can append the device ``pyRAPL.Device.DRAM`` to the ``devices`` parameter list to monitor RAM device too. 
 
+Running the test multiple times
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+For short functions, you can configure the number of runs and it will calculate the mean energy consumption of all runs. 
+As an example if you want to run the test 100 times :
+
+	import pyRAPL
+
+	pyRAPL.setup()
+	
+	
+	@pyRAPL.measure(number=100)
+	def fun():
+		# Some stuff ...
+
+	for _ in range(100):
+		fun()
+
+
 Configure the output of the decorator
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 

pyRAPL/measurement.py

@@ -96,7 +96,7 @@ def result(self) -> Result:
 
 def measureit(_func=None, *, output: Output = None, number: int = 1):
     """
-    Measure the energy consumption of monitored devices during the execution of the decorated function
+    Measure the energy consumption of monitored devices during the execution of the decorated function (if multiple runs it will measure the mean energy)
 
     :param output: output instance that will receive the power consummation data
     :param number: number of iteration in the loop in case you need multiple runs or the code is too fast to be measured