sascha/workload-automation
1
0
Fork 0
mirror of https://github.com/ARM-software/workload-automation.git synced 2025-02-07 13:41:24 +00:00
Code Issues Releases Wiki Activity

doc: Fix instrument documentation

Browse Source 
Fixed outdated `update_results` method references.
This commit is contained in:
Marc Bonnici 2018-06-04 17:27:22 +01:00 committed by setrofim
parent e80feef486
commit 3839da166d
1 changed files with 3 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
doc/source/developer_reference/writing_plugins.rst
View File

@ -884,7 +884,7 @@ The full interface of WA instruments is shown below::
def setup(self, context): def setup(self, context):
""" """
This method is invoked after the workload is setup. All the This method is invoked after the workload is setup. All the
necessary setups should go inside this method. Setup, includes necessary setup should go inside this method. Setup, includes
operations like clearing logs, additional configuration etc. operations like clearing logs, additional configuration etc.
""" """
pass pass
@ -903,7 +903,7 @@ The full interface of WA instruments is shown below::
""" """
pass pass
def update_result(self, context): def update_output(self, context):
""" """
It is invoked after the workload updated its result. It is invoked after the workload updated its result.
update_result is where the taken measures are added to the result so it update_result is where the taken measures are added to the result so it
@ -1008,7 +1008,7 @@ Below is a simple instrument that measures the execution time of a workload::
def stop(self, context): def stop(self, context):
self.end_time = time.time() self.end_time = time.time()
def update_result(self, context): def update_output(self, context):
execution_time = self.end_time - self.start_time execution_time = self.end_time - self.start_time
context.add_metric('execution_time', execution_time, 'seconds') context.add_metric('execution_time', execution_time, 'seconds')