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

freq_sweep: Improved documentation

Browse Source 
- Added explanation that this instrument does not taskset workloads
 - Fixed formatting issue with the agenda example
This commit is contained in:
Sebastian Goscik 2016-03-09 16:10:03 +00:00
parent 11184750ec
commit 79554a2dbc
1 changed files with 19 additions and 17 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

36
wlauto/instrumentation/freqsweep/__init__.py
View File

@ -33,6 +33,9 @@ class FreqSweep(Instrument):
- Setting the runner to 'by_spec' increases the chance of successfully - Setting the runner to 'by_spec' increases the chance of successfully
completing an agenda without encountering hotplug issues completing an agenda without encountering hotplug issues
- If possible disable dynamic hotplug on the target device - If possible disable dynamic hotplug on the target device
- This instrument does not automatically pin workloads to the cores
being swept since it is not aware of what the workloads do.
To achieve this use the workload's taskset parameter (if it has one).
""" """
parameters = [ parameters = [
@ -44,24 +47,23 @@ class FreqSweep(Instrument):
can do so by specifying this parameter. can do so by specifying this parameter.
Sweeps should be a lists of dictionaries that can contain: Sweeps should be a lists of dictionaries that can contain:
- Cluster (mandatory): The name of the cluster this sweep will be - Cluster (mandatory): The name of the cluster this sweep
performed on. E.g A7 will be performed on. E.g `A7`
- Frequencies: A list of frequencies (in KHz) to use. If this is - Frequencies: A list of frequencies (in KHz) to use. If
not provided all frequencies available for this this is not provided all frequencies available for this
cluster will be used. cluster will be used. E.g: `[800000, 900000, 100000]`
E.g: [800000, 900000, 100000] - label: Workload specs will be named
- label: Workload specs will be named '{spec id}_{label}_{frequency}'. `{spec id}_{label}_{frequency}`. If a label is not
If a label is not provided it will be named 'sweep{sweep No.}' provided it will be named `sweep{sweep No.}`
Example sweep specification: ::
Example sweep specification: freq_sweep:
sweeps:
freq_sweep: - cluster: A53
sweeps: label: littles
- cluster: A53 frequencies: [800000, 900000, 100000]
label: littles - cluster: A57
frequencies: [800000, 900000, 100000] label: bigs
- cluster: A57
label: bigs
"""), """),
] ]