1
0
mirror of https://github.com/ARM-software/workload-automation.git synced 2024-10-06 10:51:13 +01:00
workload-automation/doc/source/changes.rst
Marc Bonnici bc87eacde2 Documentation: Update WA3 Documentation
Update the documentation and build system for producing documentation for
WA3 with support for automatic building on readthedocs.

Note: This is currently a WIP.
2018-04-24 09:59:57 +01:00

28 lines
1.3 KiB
ReStructuredText

=================================
What's New in Workload Automation
=================================
-------------
Version 3.0
-------------
WA3 is a re-write of WA2 therefore please note that while backwards compatibility
has attempted to be maintained where possible, there maybe breaking
changes moving from WA2 to WA3.
- Changes:
- Configuration files ``config.py`` are now specified in YAML format in
``config.yaml``. WA3 has support for automatic conversion of the default
config file and will be performed upon first invocation of WA3.
- The "config" and "global" sections in an agenda are not interchangeable so can all be specified in a "config" section.
- "Results Processors" are now known as "Output Processors" and can now be ran offline.
- "Instrumentation" is now know as "Instruments" for more consistent naming.
- "Both "Output Processor" and "Instrument" configuration has been merged into "Augmentations" (support for the old naming schemes have been retained for backwards compatibility)
- New features:
- There is a new Output API which can be used to aid in post processing a run's output. For more information please see :ref:`output-api`.
- All "augmentations" can now be enabled on a per workload basis.
For more information on migrating from WA2 to WA3 please see the :ref:`migration-guide`.