xmos/vocalfusion-avs-setup

Support for Amazon Pryon wakeword engines

Closed this issue · 2 comments

Amazon advertise two KWD's, Keyword detectors, for the AVS device SDK: the AmazonLite KWD and Amazon KWD. Currently we have only the models, engine and adapters for the AmazonLite KWD and they are compatible with version 1.25.0 of the SDK. In the files provided by Amazon the WWE is called Pryon Lite.

The avs-device-sdk and the scripts in vocalfusion-avs-setup must have an option to configure the Amazon Lite KWD. The necessary files such as the models and the engine won't be part of the setup, but the user will need to request the necessary licenses and files from Amazon.

The documentation must include all the instructions to configure the Amazon Lite KWD, including where to store the licensed Amazon files.

The same changes must be extended to the Amazon Pryon KWD

List of actions:

  • Decide if we want to use avs-device-sdk v1.25.0 or v1.26.0
  • Request files from Amazon if necessary
  • Integrate AmazonLite KWD adapters, model and engine in the SDK
  • Enhance configuration scripts to support new AmazonLite KWD (Keyword Detector)
  • Perform some manual tests to check installation and behaviour of the AmazonLite KWD is correct
  • Integrate Amazon KWD adapters, model and engine in the SDK
  • Enhance configuration scripts to support new Amazon KWD (Keyword Detector)
  • Perform some manual tests to check installation and behaviour of the Amazon KWD is correct

@lucianomartin, @mbanth and @tomblackie-xmos agreed to revisit this issue. It could take some time before we get hold of the Amazon Pryon wakeword files. As a first attempt to address this issue we have limited the scope to:

  • Update setup scripts to make it easier for a customer to integrate the Amazon keyword detector
  • Update the documentation to list the steps necessary to compile and use the Amazon keyword detector

Documentation has been updated with #64