updated readme

Picovoice · Jan 2, 2025 · 7faf7d9 · 7faf7d9
1 parent 7062731
commit 7faf7d9
Show file tree

Hide file tree

Showing 4 changed files with 32 additions and 2 deletions.
diff --git a/recipes/llm-voice-assistant/python/cli/README.md b/recipes/llm-voice-assistant/python/cli/README.md
@@ -1,3 +1,7 @@
+# LLM Voice Assistant CLI Demo
+
+A voice assistant using Porcupine, Cheetah, picoLLM, and Orca with a text based interface.
+
 ## See It In Action!
 
 [![LLM VA in Action](https://img.youtube.com/vi/06K_YtUr8mc/0.jpg)](https://www.youtube.com/watch?v=06K_YtUr8mc)
@@ -43,6 +47,17 @@ To see all available options, type the following:
 python main.py --help
 ```
 
+## Config File
+
+In addition to command line arguments a config file can be used to pass arguments to the demo. By default the demo looks for `config.json` in the same directory as `main.py` but an alternative path can be passed using the `--config` option. Below is an example config file.
+
+```json
+{
+    "access_key": "${ACCESS_KEY}",
+    "picollm_model_path": "${PICOLLM_MODEL_PATH}"
+}
+```
+
 ## Custom Wake Word
 
 The demo's default wake phrase is `Picovoice`. You can generate your custom (branded) wake word using Picovoice  Console by following [Porcupine Wake Word documentation (https://picovoice.ai/docs/porcupine/). Once you have the model trained, simply pass it to the demo

diff --git a/recipes/llm-voice-assistant/python/cli/requirements.txt b/recipes/llm-voice-assistant/python/cli/requirements.txt
@@ -1,5 +1,5 @@
 picollm==1.2.3
-pvcheetah==2.0.1
+pvcheetah==2.1.0
 pvorca==1.0.0
 pvporcupine==3.0.2
 pvrecorder==1.2.2

diff --git a/recipes/llm-voice-assistant/python/windows_gui/README.md b/recipes/llm-voice-assistant/python/windows_gui/README.md
@@ -1,3 +1,7 @@
+# LLM Voice Assistant GUI Demo
+
+A voice assistant using Porcupine, Cheetah, picoLLM, and Orca with a console based graphical interface.
+
 ## Compatibility
 
 - Python 3.8+
@@ -39,6 +43,17 @@ To see all available options, type the following:
 python main.py --help
 ```
 
+## Config File
+
+In addition to command line arguments a config file can be used to pass arguments to the demo. By default the demo looks for `config.json` in the same directory as `main.py` but an alternative path can be passed using the `--config` option. Below is an example config file.
+
+```json
+{
+    "access_key": "${ACCESS_KEY}",
+    "picollm_model_path": "${PICOLLM_MODEL_PATH}"
+}
+```
+
 ## Custom Wake Word
 
 The demo's default wake phrase is `Jarvis`. You can generate your custom (branded) wake word using Picovoice  Console by following [Porcupine Wake Word documentation (https://picovoice.ai/docs/porcupine/). Once you have the model trained, simply pass it to the demo

diff --git a/recipes/llm-voice-assistant/python/windows_gui/requirements.txt b/recipes/llm-voice-assistant/python/windows_gui/requirements.txt
@@ -1,5 +1,5 @@
 picollm==1.2.3
-pvcheetah==2.0.1
+pvcheetah==2.1.0
 pvorca==1.0.0
 pvporcupine==3.0.2
 pvrecorder==1.2.2