Skip to content

Commit dd0fff5

Browse files
committed
Add proper global meta data
This is heavily based upon a draft by Kris Gesling, any errors are of course my own.
1 parent 475fa56 commit dd0fff5

File tree

1 file changed

+48
-2
lines changed

1 file changed

+48
-2
lines changed

snap/snapcraft.yaml

Lines changed: 48 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,53 @@
11
name: mycroft-precise
22
adopt-info: mycroft-precise
3-
summary: Mycroft Precise
4-
description: Mycroft Precise, a wake word spotter.
3+
license: Apache-2.0
4+
summary: A wake word listener from Mycroft AI
5+
description: >
6+
A lightweight, simple-to-use, RNN wake word listener, including all the tools to train your own custom wake word.
7+
8+
Mycroft Precise monitors an audio stream (usually a microphone) and when it recognizes a specific phrase it triggers an event. For example, by default users of the Mycroft Voice Assistant are using a Precise model trained to spot the phrase "Hey Mycroft". When Precise recognizes this phrase it puts the Mycroft Voice Assistant into command mode performing speech recognition on whatever is next said by the person using the device.
9+
10+
Mycroft Precise is fully open source and can be trained to recognize any short-phrase or sound, from a name to a cough.
11+
12+
The default "Hey Mycroft" model is included, to test it, try:
13+
`mycroft-precise.listen /snap/mycroft-precise/current/hey-mycroft/hey-mycroft.pb`
14+
15+
16+
**USAGE**
17+
18+
19+
Running the listener
20+
21+
mycroft-precise - Alias for mycroft-precise.engine
22+
mycroft-precise.engine - Run a model on raw audio data from stdin
23+
mycroft-precise.listen - Run a model on microphone audio input
24+
mycroft-precise.listen-pocketsphinx - Run the PocketSphinx listener
25+
26+
Data collection
27+
28+
mycroft-precise.collect - Record audio samples for use with Precise
29+
mycroft-precise.add-noise - Create a duplicate dataset with added noise
30+
31+
Training
32+
33+
mycroft-precise.train - Train a new model on a dataset
34+
mycroft-precise.train-generated - Train a model on infinitely generated batches
35+
mycroft-precise.train-incremental - Train a model to inhibit activation by marking false activations and retraining
36+
mycroft-precise.train-optimize - Use black box optimization to tune model hyperparameters
37+
mycroft-precise.train-sampled - Train a model, sampling data points with the highest loss from a larger dataset
38+
39+
Evaluation and analysis
40+
41+
mycroft-precise.test - Test a model against a dataset
42+
mycroft-precise.test-pocketsphinx - Test PocketSphinx against a dataset
43+
mycroft-precise.eval - Evaluate a list of models on a dataset
44+
mycroft-precise.calc-threshold - Update the threshold values of a model for a dataset to make the sensitivity more accurate and linear
45+
mycroft-precise.graph - Show ROC curves for a series of models
46+
mycroft-precise.simulate - Simulate listening to long chunks of audio to find unbiased false positive metrics
47+
48+
Model conversion
49+
50+
mycroft-precise.convert - Convert wake-word model from Keras to TensorFlow
551
base: core18
652
grade: stable
753
confinement: strict

0 commit comments

Comments
 (0)