Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Python interrupt fix #27

Merged
merged 9 commits into from
Jan 2, 2025
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 15 additions & 0 deletions recipes/llm-voice-assistant/python/cli/README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
# LLM Voice Assistant CLI Demo

A voice assistant using Porcupine, Cheetah, picoLLM, and Orca with a text based interface.
matt200-ok marked this conversation as resolved.
Show resolved Hide resolved

## 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)
Expand Down Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion recipes/llm-voice-assistant/python/cli/requirements.txt
Original file line number Diff line number Diff line change
@@ -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
Expand Down
15 changes: 15 additions & 0 deletions recipes/llm-voice-assistant/python/windows_gui/README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
# LLM Voice Assistant GUI Demo

A voice assistant using Porcupine, Cheetah, picoLLM, and Orca with a console based graphical interface.
matt200-ok marked this conversation as resolved.
Show resolved Hide resolved

## Compatibility
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think we should either have a title with a quick summary of what this demo is. Or, we could also put a readme at llm-voice-assistant/python that summarizes the differences between the demos (like we do in https://github.com/Picovoice/porcupine/tree/master/demo/android)


- Python 3.8+
Expand Down Expand Up @@ -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
Expand Down
Original file line number Diff line number Diff line change
@@ -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
Expand Down
Loading