Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
ToastyOfficial authored Aug 8, 2023
1 parent d3f17f8 commit b103dc0
Showing 1 changed file with 50 additions and 13 deletions.
63 changes: 50 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,23 +1,60 @@
# OpenAI Assistant
![ai](https://i.imgur.com/xwNwqD9.png)<br><br>
![Maintenance](https://img.shields.io/badge/Maintained%3F-yes-green.svg) [![Latest release](https://badgen.net/github/release/ToastyOfficial/OpenAI_GPT4_Assistant)](https://github.com/ToastyOfficial/OpenAI_GPT4_Assistant/releases) [![GitHub latest commit](https://badgen.net/github/last-commit/ToastyOfficial/OpenAI_GPT4_Assistant)](https://GitHub.com/ToastyOfficial/OpenAI_GPT4_Assistant/commit/) [![GitHub stars](https://badgen.net/github/stars/ToastyOfficial/OpenAI_GPT4_Assistant)](https://GitHub.com/ToastyOfficial/OpenAI_GPT4_Assistant/stargazers/)<br>
![Maintenance](https://img.shields.io/badge/Maintained%3F-yes-green.svg) ![Maintainer](https://img.shields.io/badge/maintainer-Toasty-blue) [![Latest release](https://badgen.net/github/release/ToastyOfficial/gpt4_assistant)](https://github.com/ToastyOfficial/gpt4_assistant/releases) [![GitHub release](https://img.shields.io/github/release/ToastyOfficial/gpt4_assistant.svg)](https://GitHub.com/ToastyOfficial/gpt4_assistant/releases/) [![GitHub latest commit](https://badgen.net/github/last-commit/ToastyOfficial/gpt4_assistant)](https://GitHub.com/ToastyOfficial/gpt4_assistant/commit/) [![GitHub stars](https://badgen.net/github/stars/ToastyOfficial/gpt4_assistant)](https://GitHub.com/ToastyOfficial/gpt4_assistant/stargazers/) <br>
An AI assistant powered by OpenAI ChatGPT4
- Type to `F.R.I.D.A.Y.` and get typed responses
- Talk to `F.R.I.D.A.Y.` and get verbal responses
## Installation
First, clone the the repo to your machine.<br>
Next, install [Anaconda](https://www.anaconda.com/download) and run as `administrator` to install dependencies.<br>
Then, install [GPT4All](https://gpt4all.io/) desktop app & dwonload `GPT4All Falcon` wait until done to continue.<br><br>

## Dependencies
- Anaconda
- GPT4All Plugin
- Whisper Plugin
- Speech Recognition Plugin
- Play Sound Plugin
- PyAudio Plugin
- SoundFile Plugin

# Installation
First install [Anaconda](https://www.anaconda.com/download) and run as `administrator`

Next install [GPT4All](https://gpt4all.io/) desktop app
Install the GPT4All Library:
```
python -m pip install gpt4all
```

Install the OpenAI Whisper Library:
```
python -m pip install openai-whisper
```

Install the Speech Recognition Library:
```
python -m pip install SpeechRecognition
```

Install the PlaySound Library
```
python -m pip install playsound
```

Install the `PyAudio` Library
```
python -m pip install PyAudio
```

Install the Sound File Library
```
python -m pip install soundfile
```

Install ffmpeg for Windows using Chocolatey
```
choco install ffmpeg
```

For MacOS Users
```
brew install portaudio
```

For Windows/Linux Users
```
python -m pip install pyttsx3
```

## Configuration
> To use Friday you need to app your OpenAI API Key `openai.api_key = "KEY_HERE"`
Expand Down

0 comments on commit b103dc0

Please sign in to comment.