2023-02-11 08:32:14 +00:00
# 🧠 GPT Brain
[](https://www.python.org/downloads/release/python-3112/)
2023-02-15 18:14:08 +00:00
> **[中文说明](./README_CN.md)** | **[English](./README.md)**
2023-02-11 11:59:45 +00:00
2023-02-11 09:26:48 +00:00
*⭐️ Like this repo? please consider a star!*
2023-02-11 08:32:14 +00:00
*💡This project is inspired by youtuber [All About AI ](https://www.youtube.com/@AllAboutAI )'s video on [Second Brain ](https://www.youtube.com/watch?v=1k2JpJRIoAA&ab_channel=AllAboutAI ). Please consider support him!*
2023-02-11 09:26:48 +00:00
*💡As I am not a professional programmer and am fairly new to Python, this project may contain bugs. If you encounter any issues, please suggest them in the [Issues section ](https://github.com/sean1832/GPT-Brain/issues ).*
2023-02-11 08:32:14 +00:00
### Feature
2023-02-15 17:14:47 +00:00
- [x] Use [OpenAI GPT-3 ](https://platform.openai.com/docs/models/gpt-3 ) to generate response.
2023-02-15 18:29:43 +00:00
- [x] Use [OpenAI embedding ](https://platform.openai.com/docs/guides/embeddings/what-are-embeddings ) for semetic comparison of question and note content for enhanced searching.
2023-02-15 17:14:47 +00:00
- [x] Configurable prompts.
- [x] Customizable personal background information for more accurate answers.
- [x] Integration with [Obsidian note ](https://obsidian.md/ ) local directory for easy note content updates.
2023-02-15 18:17:11 +00:00
- [x] Note content preview & content modification.
2023-02-15 17:14:47 +00:00
- [x] Section parsing using delimiters for targeted updates.
- [x] [Obsidian YAML frontmatter ](https://help.obsidian.md/Editing+and+formatting/Metadata ) filtering.
2023-02-15 18:23:58 +00:00
- [x] OpenAI API key management.
2023-02-15 17:14:47 +00:00
- [x] OpenAI Language model selection for different needs.
- [x] Basic & Advanced parameter sliders for OpenAI Language model configurations.
### Todo
2023-02-15 18:02:30 +00:00
- [x] ~~Batch script to update library.~~
2023-02-15 17:14:47 +00:00
- [ ] Versioning.
- [ ] Tooltips for parameters.
- [ ] Chinese support.
2023-02-15 18:23:58 +00:00
- [ ] Provide detail documentation for users.
2023-02-15 18:30:55 +00:00
- [ ] Automatic update for new version.
2023-02-15 17:14:47 +00:00
- [ ] Release for windows.
2023-02-11 08:32:14 +00:00
## Install
2023-02-11 08:40:57 +00:00
### 1. What you need
2023-02-15 18:14:08 +00:00
- Install ** [python 3.11 ](https://www.python.org/downloads )** | [python installation tutorial (YouTube) ](https://youtu.be/HBxCHonP6Ro?t=105 )
- OpenAI ** [API keys ](https://platform.openai.com/account/api-keys )**
2023-02-11 08:40:57 +00:00
### 2. Set up the project for the first time
2023-02-09 14:46:55 +00:00
1. Run `setup.bat`
2023-02-09 17:41:42 +00:00
2. Enter your OpenAI API Key
2023-02-09 14:46:55 +00:00
2023-02-11 08:40:57 +00:00
### 3. Run
2023-02-09 17:41:42 +00:00
- Execute `run-webUI.bat`
2023-02-11 08:32:14 +00:00
2023-02-11 08:40:57 +00:00
2023-02-15 17:14:47 +00:00
## Demo
2023-02-11 08:40:57 +00:00
### Main Page
### Brain Memory
