mirror of
https://github.com/sean1832/GPT-Brain
synced 2024-11-18 21:25:53 +00:00
update README.md
This commit is contained in:
parent
263a51fa10
commit
210801bf77
29
README.md
29
README.md
@ -1,4 +1,27 @@
|
||||
# Setup
|
||||
|
||||
# 🧠 GPT Brain
|
||||
[![python](https://img.shields.io/badge/python-3.11-blue)](https://www.python.org/downloads/release/python-3112/)
|
||||
|
||||
*⭐️ Like this repo? please consider 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!*
|
||||
|
||||
### 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.)*
|
||||
- [x] Language model selection for different needs
|
||||
- [x] Basic parameter sliders for customizing configuration.
|
||||
|
||||
## Screenshoots
|
||||
### Main Page
|
||||
![screenshot1](https://cdn.discordapp.com/attachments/998217078915997746/1073881233387429978/image.png)
|
||||
### Brain Memory
|
||||
![screenshot2](https://cdn.discordapp.com/attachments/998217078915997746/1073883842840104990/image.png)
|
||||
|
||||
## Install
|
||||
### What you need
|
||||
- Install [python 3.11](https://www.python.org/downloads)
|
||||
- OpenAI [API keys](https://platform.openai.com/account/api-keys)
|
||||
@ -7,6 +30,8 @@
|
||||
1. Run `setup.bat`
|
||||
2. Enter your OpenAI API Key
|
||||
|
||||
# How to use
|
||||
## How to use
|
||||
### Run
|
||||
- Execute `run-webUI.bat`
|
||||
|
||||
## Contributer
|
||||
|
Loading…
Reference in New Issue
Block a user