pyRAPL 0.2.3

No project description provided

PyRAPL

About

pyRAPL is a toolkit that measures the energy consumption of a machine during the execution of a python code.

pyRAPL uses the intel "Running Average Power Limit" (RAPL) technology that estimate power consumption of internal devices. This technology is only available on Intel CPU with Sandy Bridge architecture or higher.

pyRAPL can measure the energy consumption of the following devices :

• CPU socket package
• RAM (only on Xeon CPU architecture)

Installation

You can install pyRAPL with pip : pip install pyRAPL

Basic usage

Here are some basic usages of pyRAPL. Please understand that the measured energy consumption is not only the energy consumption of the code you are running. It's the global energy consumption of all the process running on the machine during this period. This includes also the operating system and other applications. That's why we recommend eliminating any extra programs that may alter the energy consumption of the machine where we run the experiments and keep only the code we want to measure its energy consumption (no extra applications such as graphical interface, background running task ...). This will give the closest measure to the real energy consumption of the measured code.

Decorate a function to measure its energy consumption

To measure the energy consumed by the machine during the execution of the function fun() run the following code :

import pyRAPL

pyRAPL.setup() 

@pyRAPL.measure
def fun():
	# Some stuff ...

fun()

This will print the recorded energy consumption of all the monitorable devices of the machine during the execution of function fun.

Configure the decorator specifying the device to monitor

You can easly specify which device and which socket to monitor using the parameters of the pyRAPL.setup function. For example, here, we only monitor the CPU power consumption on the socket 1. By default, pyRAPL monitors all the available devices of the machine's sockets.

import pyRAPL

pyRAPL.setup(devices=[pyRAPL.Device.PKG], socket_ids=[1])

@pyRAPL.measure
def fun():
	# Some stuff ...

fun()	

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.

As an example if you want to write the recorded energy consumption in a csv file :

import pyRAPL

pyRAPL.setup()

csv_output = pyRAPL.outputs.CSVOutput('result.csv')

@pyRAPL.measure(output=csv_output)
def fun():
	# Some stuff ...

for _ in range(100):
	fun()

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. Other predefined Output classes exist to export data to Mongodb and Panda dataframe. You can also create your own Output class (see the documentation)

Measure the energy consumption of a piece of code

To measure the energy consumed by the machine during the execution of a given piece of code, run the following code :

import pyRAPL

pyRAPL.setup()
measure = pyRAPL.Measurement('toto')
measure.begin()

# ...
# Piece of code to measure energy consumption 
# ...

measure.end()

You can get the result of the measures using the property : measure.result this will return a Result instance.

You can also use an output to handle this results, for example with the csv output : measure.export(csv_output)

Measure the energy consumption of a block

Pyarpl allows also to measure a block with of instructions using the keyword with as the example below:

import pyRAPL

pyRAPL.setup()

whith pyRAPL.Measurement('toto'):

	# ...
	# Piece of code to measure energy consumption 
	# ...

This will print the energy consumption of the block. To handle the measures instead of just printing them you can use any Output class that you pass to the Measurement object

import pyRAPL
pyRAPL.setup()

dataoutput= pyRAPL.outputs.DataFrameOutput()

whith pyRAPL.Measurement('toto',output=dataoutput):

	# ...
	# Piece of code to measure energy consumption 
	# ...

dataoutput.data.head()

Miscellaneous

About

PyRAPL is an open-source project developed by the Spirals research group (University of Lille and Inria) that take part of the powerapi project.

The documentation is available here.

Mailing list

You can follow the latest news and asks questions by subscribing to our mailing list.

Contributing

If you would like to contribute code you can do so through GitHub by forking the repository and sending a pull request.

When submitting code, please make every effort to follow existing conventions and style in order to keep the code as readable as possible.

MIT License

Copyright (c) 2018, INRIA Copyright (c) 2018, University of Lille All rights reserved.

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.