Plugin system for stt, tts and audioservices #2594
Conversation
devs-mycroft
added
the
CLA: Yes
|
Voight Kampff Integration Test Succeeded (Results) |
|
Voight Kampff Integration Test Failed (Results) |
|
Voight Kampff Integration Test Succeeded (Results) |
|
Hey sorry it's taken some time to get back to this. I really like it though. I think it will be great if we can keep mycroft-core to what is actually "core" to running any instance of Mycroft, and then provide the tooling to build up what's needed on top of that for specific implementations. The example plugin doesn't seem to be working for me. Looks like @chrisveilleux if you agree with the addition of the plugin system, it would be good to merge it in pretty soon so it can be tested in the wild. Even though this isn't a breaking change itself, it will mean for 20.08 we can confidently remove non-core services and provide them as plugins instead. |
|
You're right that the requirement was a bit old. I've now updated it to track core's and for me it works [TM]. Do you get any error in the audio.log? If the plug is loaded it should show |
|
Hooray, working now. I think it was using a cached wheel when I tried to update it. |
forslund
force-pushed
the
feature/plugin-system
branch
from
7d6181d
to
eaaae2a
Compare
|
Voight Kampff Integration Test Succeeded (Results) |
There was a problem hiding this comment.
I like the idea of a plugin system to keep the core code cleaner.
@krisgesling Our documentation should be updated to explain how to use this. I would prefer not to deploy it until the documentation is ready.
Some sort of automated testing should be added for this code.
forslund
force-pushed
the
feature/plugin-system
branch
from
eaaae2a
to
340515c
Compare
|
I've updated the code styling changes requested and tried to answer the comments. I still think the small wrapper functions makes sense to have from a readability point of view but if you really like them gone I can inline them. I'll write some unit tests and an entry for the documentation this weekend to go with this update. |
forslund
force-pushed
the
feature/plugin-system
branch
from
340515c
to
4f3af19
Compare
|
Voight Kampff Integration Test Succeeded (Results) |
1 similar comment
|
Voight Kampff Integration Test Succeeded (Results) |
|
Documentation for the plugin system is now available at: |
forslund
force-pushed
the
feature/plugin-system
branch
from
4f3af19
to
5c6e5d6
Compare
|
Voight Kampff Integration Test Failed (Results) |
Entrypoints registered under "mycroft.plugin.tts" will be detected and able to run.
pip packages registering entrypoints under 'mycroft.plugin.stt' will be detected.
All modules registered under the entrypoint group "mycroft.plugin.audioservice" These shall refer to a module with either an autodetect function or a load_service function.
forslund
force-pushed
the
feature/plugin-system
branch
from
5c6e5d6
to
bb4e705
Compare
|
I've rebased this and fixed the conflict. I've also added some unittests for the plugins util. Documentation is available here: https://mycroft-ai.gitbook.io/docs/mycroft-technologies/mycroft-core/plugins |
|
Voight Kampff Integration Test Failed (Results) |
|
Hmm, must have messed up the rebase in audioservice...will invesigate Edit: No...locally working... |
|
Voight Kampff Integration Test Failed (Results) |
|
Voight Kampff Integration Test Succeeded (Results) |
krisgesling
added
Status: To be reviewed
|
I'm thinking we need this for wake words and enclosures |
|
Wakewords is something I've planned for as well but wanted to make as a follow up PR since this is enough to review. Enclosures is a nice idea I didn't think of. Previously the idea was to extract the enclosure system from core entirely and just use the messagebus connection for it (mycroft-messagebus-client + a base enclosure module) but including it as a pluggable system should work quite well also. |
wake words plugin
|
Voight Kampff Integration Test Succeeded (Results) |
There was a problem hiding this comment.
This all looks great, working as expected, and I've updated the docs for the addition of Wake Word Plugins:
https://mycroft-ai.gitbook.io/docs/mycroft-technologies/mycroft-core/plugins
krisgesling
dismissed
chrisveilleux’s stale review
Requested changes have been made and comments resolved.
Description
This adds a simple plugin system for loading external stt, tts and audioservices. The "plugins" are pip install-able modules presenting one or more entrypoints with a entrypoint group defined in setup.py (Example)
TTS group: "mycroft.plugin.tts"
STT group: "mycroft.plugin.stt"
Audioservice group: "mycroft.plugin.audioservice"
Wake-word group: "mycroft.plugin.wake_word"
STT and TTS loads a single object for the specified module (as specified in the config), while audioservice loads all found audioservices and append to the list of builtins services.
This system makes it easier to quickly add third-party services without changing core, it also makes it easier for users to select things like Polly where the requirement will automatically be installed together with the TTS module.
The detection system is based on the documentation for python packaging. Link
-Future work: hotword engines. Can the same system be leveraged for skills? Update and reloading needs to be considered...-
@JarbasAl contributed an implementation of hot/wake-word engine plugins. There is a test plugin available here
How to test
mycroft-pip install git+https://github.com/forslund/mycroft-tts-plugin-gtts.gitThen set the tts module to
google_tts_plugassert that the google tts voice is heardContributor license agreement signed?
CLA [ Yes ]