From 210801bf77958bf87c730945e76155dbfa33e7dd Mon Sep 17 00:00:00 2001 From: sean1832 Date: Sat, 11 Feb 2023 19:32:14 +1100 Subject: [PATCH] update README.md --- README.md | 29 +++++++++++++++++++++++++++-- 1 file changed, 27 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 5a04e66..2521ded 100644 --- a/README.md +++ b/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