1
0
mirror of https://github.com/ARM-software/workload-automation.git synced 2024-10-05 18:31:12 +01:00
Commit Graph

184 Commits

Author SHA1 Message Date
setrofim
6d72a242ce doc: fix callback priority table
Correctly specify the decorator name that should be used to give an
instrument method appropriate priority when it's being invoked via
signal dispatch.

Previously, the table was listing the priority enum names in the column
that was labeled "decorator". Now both are shown and the distinction has
been made clearer.
2020-06-30 15:04:20 +01:00
Marc Bonnici
b8301640f7 docs/dev_ref: Fix incorrect attribute name 2020-06-25 13:01:28 +01:00
Marc Bonnici
c473cfa8fe docs/user_information: Fix references to Python 2.7
Remove references to Python 2.7 and update example paths
to Python3.
2020-06-25 13:01:28 +01:00
Marc Bonnici
ecbfe32b9d docs: Update python2 style print statements 2020-05-21 12:39:25 +01:00
Marc Bonnici
711bff6a60 docs/plugins: Fix formatting and typos 2020-04-27 13:53:29 +01:00
Marc Bonnici
2a8454db6a docs/how_tos: Update example workload creation
Clarify the workload creation example.
2020-04-27 13:53:29 +01:00
Sergei Trofimov
b93a8cbbd6 doc: fix Instrument documentation
Remove reference to `extract_results`, which does not exist for
Instruments (this only exists for Workloads.)
2020-02-04 12:49:14 +00:00
Sergei Trofimov
659e60414f fw/exec: Add add_classifier() method
Add add_classifier() method to context. Allow plugins to add classifiers
to the current job, or the run as a whole. This will ensure that the new
classifiers are propagated to all relevant current and future artifacts
and metrics.
2020-01-17 16:38:58 +00:00
Marc Bonnici
009fd831b8 docs/changelog: Update changelog for version 3.2 release. 2019-12-20 16:07:10 +00:00
Marc Bonnici
9556c3a004 docs: Fix typos 2019-11-05 08:35:57 +00:00
Marc Bonnici
1f4bae92bf docs/device_setup: Explicitly mention load_default_modules
This is becoming a commonly used parameter in the `device_config` so
explicitly list its functionality.
2019-11-05 08:35:57 +00:00
Marc Bonnici
dcbc00addd docs/faq: Add workaround for module initialisation failure 2019-11-05 08:35:57 +00:00
Marc Bonnici
4ee75be7ab docs/userguide: Update reference to outdated output_processor 2019-11-05 08:35:57 +00:00
Sergei Trofimov
2f231b5ce5 fw/target: detect module variations in TargetInfo
- Add modules entry to TargetInfo
- When retrieving TargetInfo from cache, make sure info modules match
  those for the current target, otherwise mark info as stale and
  re-generate.
2019-09-12 15:27:23 +01:00
Marc Bonnici
125cd3bb41 docs/changes: Changelog for v3.1.4 2019-07-19 16:37:00 +01:00
Marc Bonnici
75ea78ea4f docs/faq: Fix formatting 2019-07-19 16:37:00 +01:00
Marc Bonnici
98b787e326 fw/DatabaseOutput: Enabled retrieving of directory artifacts
To provide the same user experience of accessing a directory
artifact from a standard `wa_output` when attempting to retrieve the
path of the artifact extract the stored tar file and extract it to a
temporary location on the host returning the path.
2019-07-19 16:36:11 +01:00
Marc Bonnici
501d3048a5 requirements: Add initial version
Adds a "requirements.txt" to the project. This will not be used during a
standard installation however will be used to indicate which are known
working packages in cases of conflicts.

Update README and documentaion to reflect this.
2019-07-18 15:17:24 +01:00
Marc Bonnici
463840d2b7 docs/faq: Add question about non UTF-8 environments. 2019-07-12 13:32:28 +01:00
Pierre-Clément Tosi
52a0a79012 build_plugin_docs: Pylint fix
Fix various pylint warnings.
2019-06-04 14:53:20 +01:00
Pierre-Clément Tosi
60693e1b65 doc: Fix build_instrument_method_map script
Fix a wrong call to a function in the script execution path.
2019-06-04 14:53:20 +01:00
Pierre-Clément Tosi
8ddf16dfea doc: Patch for doc generation under Py3
Patch scripts with methods that are supported under Py2.7 and Py3.
2019-06-04 14:53:20 +01:00
Marc Bonnici
ec3d928b3b docs: Fix incorrect environment variable name 2019-04-26 08:05:51 +01:00
Marc Bonnici
ee8bab365b docs/revent: Clarify the naming conventions for revent recordings
As per https://github.com/ARM-software/workload-automation/issues/968
the current documentation for detailing the naming scheme for an revent
recording is unclear. Reword the descriptions focusing on the typical
usecase rather then based on a customized target class.
2019-04-26 08:05:51 +01:00
Marc Bonnici
dd44d6fa16 docs/api/workload: Update documentation for activity attribute 2019-04-18 10:44:50 +01:00
Marc Bonnici
984a74a6ca doc/changes: Update changelog for v3.1.2 2019-03-04 10:37:39 +00:00
Marc Bonnici
bedd3bf062 docs/faq: Add entry about missing kernel config errors
Although WA supports automatic updating during parsing of a serialized
`kernel_config` from devlib, if the installed versions of WA and devlib
have become out of sync where WA has "updated" the old implementation it
will not attempt to update it again when devlib is later updated to use
the new implementation and therefore will not trigger the existing
checks that are in place.
2019-02-21 11:57:32 +00:00
Marc Bonnici
03e463ad4a docs/installation: Add warning about using pip to install from github 2019-02-20 16:30:53 +00:00
Marc Bonnici
a1cecc0002 fw/workload: Add "support_versions" attribute to workloads
Allow for specifying a list of supported APK versions for a workload. If
a specific version is no specified then attempt to a resolve any valid
version for the workload.
2019-02-08 13:56:55 +00:00
Sergei Trofimov
462a5b651a fw/output: add label property to Metric
Add a "label" property to Metric that combines its name with its
classifiers into a single string.
2019-02-05 10:27:06 +00:00
Marc Bonnici
3f202205a5 doc/faq: Add answer on how to fall back to surfaceflinger 2019-01-28 12:45:10 +00:00
Marc Bonnici
78090bd94e doc/changes: Add change log for v3.1.1 2019-01-10 13:21:16 +00:00
Marc Bonnici
d21258e24d docs/changes: Update changelog for V3.1 2018-12-21 14:26:55 +00:00
Marc Bonnici
ea5ea90bb6 docs/dev_info/processing_output: Fix formatting 2018-12-21 14:26:55 +00:00
Marc Bonnici
06961d6adb docs/how_tos: Fix incorrect spacing 2018-12-14 07:44:44 +00:00
Marc Bonnici
7d8cd85951 doc/rt_params: Fix incorrect documentaion of parameter names 2018-12-14 07:44:44 +00:00
Marc Bonnici
916f7cbb17 docs: Update documentation about database output API and create command 2018-12-07 09:55:17 +00:00
Marc Bonnici
17bb0083e5 doc/installation: Update installation instructions
Update the instructions for installing WA from git not to use
pip as this method does not process dependency_links correctly and
results in an incompatible version of devlib being installed.
2018-10-25 10:32:28 +01:00
Marc Bonnici
c4ad7467e0 doc: Fix formatting and typo 2018-10-25 10:32:28 +01:00
Marc Bonnici
2f75261567 doc: Add WA icon to documentation 2018-10-25 10:32:28 +01:00
Marc Bonnici
891ef60f4d configuration: Add support for section groups
Now allows for specifying a `group` value for each section which will
cross product the sections within that group with the sections in each
other group. Additionally classifiers will automatically be added to
each job spec with the relevant group information.
2018-09-24 10:17:26 +01:00
Marc Bonnici
f5fed26758 doc/device_setup: Fix typo 2018-09-21 15:06:30 +01:00
Waleed El-Geresy
6239f6ab2f Update documentation
Update documentation with new API for Output Processors which includes
the context in the intialize and finalize methods.
2018-09-05 14:40:42 +01:00
Sergei Trofimov
7d833ec112 fw/config: add includes
Add the ability to include other YAML files inside agendas and config
files using "include#:" entries.
2018-07-23 16:47:10 +01:00
Marc Bonnici
915c363fd9 wa: 3.0.0 Release preparation
- Update 'setup.py' package name to 'wlauto' as 'wa' is already taken on
  PyPi and update documentation accordingly.
- Update old references to Python 2.7
2018-07-06 17:39:26 +01:00
Waleed El-Geresy
1c48589860 doc: Rename execution_model to framework_overview
An update to more aptly suit the new general title of the section.
2018-07-05 11:34:19 +01:00
Waleed El-Geresy
a3b02872ac 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
2018-07-05 11:34:19 +01:00
Marc Bonnici
60989ef66c doc/contributing: Add a guide to documentation styles
Add a documentation style guide to aid in keeping a consistent style
when adding new documentation.
2018-06-29 11:04:09 +01:00
Marc Bonnici
c67994260d doc: Update heading underlines
Ensure consistency for title levels throughout documentation.
2018-06-29 11:04:09 +01:00
Marc Bonnici
98bd3e09b2 doc/api: Make attribute listing a consistent style 2018-06-29 11:04:09 +01:00