sascha/workload-automation
1
0
Fork 0
mirror of https://github.com/ARM-software/workload-automation.git synced 2025-02-21 20:38:57 +00:00
Code Issues Releases Wiki Activity

doc: Improve description of context methods

Browse Source
This commit is contained in:
Marc Bonnici 2018-05-09 15:30:43 +01:00 committed by setrofim
parent 48a7ad9415
commit 86cc449203
1 changed files with 5 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
doc/source/developer_reference/writing_extensions.rst
View File

@ -46,9 +46,10 @@ like which workload is currently running.
Notable methods of the context are: Notable methods of the context are:
context.add_artifact(name, path, kind, description=None, classifier=None) context.add_artifact(name, host_file_path, kind, description=None, classifier=None)
This is how plugins can add :ref:`artifacts <artifact>` of various types to Plugins can add :ref:`artifacts <artifact>` of various kinds to the run
the run output folder for WA. output folder for WA and associate them with a description and/or
:ref:`classifier <classifiers>`.
context.add_metric(name, value, units=None, lower_is_better=False, classifiers=None) context.add_metric(name, value, units=None, lower_is_better=False, classifiers=None)
This method should be used to add :ref:`metrics <metrics>` that have been This method should be used to add :ref:`metrics <metrics>` that have been
@ -83,7 +84,7 @@ context.current_job.current_iteration
context.current_job_output context.current_job_output
This is the result object for the current iteration. This is an instance This is the result object for the current iteration. This is an instance
of :class:`wa.framework.output.JobOutput`. It contains the status of :class:`wa.framework.output.JobOutput`. It contains the status
of the iteration as well as the metrics and artefacts generated by the of the iteration as well as the metrics and artifacts generated by the
workload. workload.