GPT-Brain/README.md
2023-02-11 22:59:45 +11:00

39 lines
1.7 KiB
Markdown

# 🧠 GPT Brain
[![python](https://img.shields.io/badge/python-3.11-blue)](https://www.python.org/downloads/release/python-3112/)
>[中文说明](./README_CN.md) | [English](./README.md)
*⭐️ Like this repo? please consider a star!*
*💡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!*
*💡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).*
### Feature
- [x] Configurable prompts for questions and summarization.
- [x] Customizable personal background information for more accurate answers
- [x] Integration with [Obsidian note](https://obsidian.md/) directory for easy updates
- [x] Section parsing using delimiters for targeted updates
- [x] Obsidian YAML metadata filtering with "is" and "is not" logic *(only a single field is currently supported.)*
- [ ] Multi metadata filtering
- [x] Language model selection for different needs
- [x] Basic parameter sliders for customizing configuration.
## Install
### 1. What you need
- Install [python 3.11](https://www.python.org/downloads)
- OpenAI [API keys](https://platform.openai.com/account/api-keys)
### 2. Set up the project for the first time
1. Run `setup.bat`
2. Enter your OpenAI API Key
### 3. Run
- Execute `run-webUI.bat`
## Screenshoots
### Main Page
![screenshot1](https://cdn.discordapp.com/attachments/998217078915997746/1073881233387429978/image.png)
### Brain Memory
![screenshot2](https://cdn.discordapp.com/attachments/998217078915997746/1073885430270922822/image.png)