Some readme, bruh

This commit is contained in:
Abraham
2023-04-13 23:18:31 +05:00
parent e2903467f2
commit 61fd5c75b0

View File

@@ -1,12 +1,20 @@
# Jarvis 2.0 (aka KESHA voice assistant)
# Kesha v3.0 very early (aka Jarvis update)
Simple Voice Assistant made as an experiment using [Silero](https://github.com/snakers4/silero-models) & [Vosk](https://pypi.org/project/vosk/).
<br>Later on [Picovoice Porcupine Wake Word Detection](https://picovoice.ai/platform/porcupine/) & [ChatGPT](https://chat.openai.com/) was added.
![image](https://i.pinimg.com/originals/63/e9/b7/63e9b72b983793f64bffc07fd14a0e62.jpg)
`The code has NOT been polished and is provided "as is". There are a lot of code that are redundant and there are tons of improvements that can be made.`
# Installation
Everything is already configured, just run the `main.py` script.<br>
Just don't forget to put models of Vosk to main folder.<br>
You can get the latest from the [official website](https://alphacephei.com/vosk/models).
First, install the requirements, the file is just a `pip freeze` 'k.<br>
Second, check `config.py` and set required values.<br>
Next, just run the `main.py` script.<br><br>
And don't forget to put models of Vosk to main folder.<br>
You can get the latest from the [official website.](https://alphacephei.com/vosk/models)
<br>The one I was using is `small`.
# Author
(2022) Abraham Tugalov