mirror of
https://github.com/ARM-software/workload-automation.git
synced 2025-10-01 01:22:35 +01:00
Docs: Run Output - Clarification and Additions
Clarification of the meanings of and the distinction between the output-related terms iteration, job, workload and section for those unfamiliar - Add entries to the glossary and references to the glossary - Added section on Configuration parameter hierarchy - Added section on the number and names of directories generated for jobs in the run output folder
This commit is contained in:
committed by
Marc Bonnici
parent
4098c0623b
commit
a3b02872ac
@@ -90,7 +90,7 @@ to describe every single thing that happens.
|
||||
communication between the core framework and plugins. After this any required
|
||||
instruments and output processors are initialized and installed.
|
||||
#. Finally, the Executor instantiates a :class:`wa.framework.execution.Runner`,
|
||||
initializes its job queue with workload specs from the RunConfiguraiton, and
|
||||
initializes its job queue with workload specs from the RunConfiguration, and
|
||||
kicks it off.
|
||||
#. The Runner performs the run time configuration of the device and goes
|
||||
through the workload specs (in the order defined by ``execution_order``
|
||||
|
@@ -37,6 +37,9 @@ This section contains reference information common to plugins of all types.
|
||||
The Context
|
||||
~~~~~~~~~~~
|
||||
|
||||
.. note:: For clarification on the meaning of "workload specification" ("spec"), "job"
|
||||
and "workload" and the distiction between them, please see the :ref:`glossary <glossary>`.
|
||||
|
||||
The majority of methods in plugins accept a context argument. This is an
|
||||
instance of :class:`wa.framework.execution.ExecutionContext`. It contains
|
||||
information about the current state of execution of WA and keeps track of things
|
||||
@@ -86,7 +89,7 @@ Notable attributes of the context are:
|
||||
This is the output object for the current iteration which
|
||||
is an instance of :class:`wa.framework.output.JobOutput`. It contains
|
||||
the status of the iteration as well as the metrics and artifacts
|
||||
generated by the workload.
|
||||
generated by the job.
|
||||
|
||||
|
||||
In addition to these, context also defines a few useful paths (see below).
|
||||
@@ -153,7 +156,7 @@ irrespective of the host's path notation. For example:
|
||||
self.command = "{} -a -b -c {}".format(target_binary, result_file)
|
||||
|
||||
.. note:: Output processors, unlike workloads and instruments, do not have their
|
||||
own target attribute as they are designed to be able to be ran offline.
|
||||
own target attribute as they are designed to be able to be run offline.
|
||||
|
||||
.. _plugin-parmeters:
|
||||
|
||||
|
Reference in New Issue
Block a user