Fabel
/
Fabelous-Ai-Chat
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

updated readme File

This commit is contained in:
Falko Victor Habel 2024-05-19 21:18:30 +02:00
parent 353457c850
commit d723b051c6
1 changed files with 2 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
README.md
View File

@ -8,7 +8,7 @@ This is my Final Project for CS50P. A implementation of a RAG System using Chrom
## Features ## Features
1. Custom GUI built with customtkinter and standard tkinter user interface. 1. Custom GUI built with customtkinter and standard tkinter user interface.
- optional `terminal` mode, with nice colors provided by the `termcolor` libary - optional `terminal` mode, with nice colors provided by the `termcolor` libary
2. RAG system to retrieve and process files from various sources (CSV, HTML, JSON, MD, PDF) using ChromaDB. 2. RAG system to retrieve and process files from various sources (CSV, HTML, MD, PDF and Webpages) using ChromaDB.
3. Seamless integration with Ollama API for generating responses based on the input text. 3. Seamless integration with Ollama API for generating responses based on the input text.
4. Supports both context-based and context-free conversations. 4. Supports both context-based and context-free conversations.
5. Code Highlighting: Either highlighted in red within the `terminal` or displayed in a separate widget using the `GUI`, this improves the readability and understanding of code snippets 5. Code Highlighting: Either highlighted in red within the `terminal` or displayed in a separate widget using the `GUI`, this improves the readability and understanding of code snippets
@ -19,6 +19,7 @@ This is my Final Project for CS50P. A implementation of a RAG System using Chrom
```bash ```bash
pip install -r requirements.txt pip install -r requirements.txt
``` ```
3. If you have installed Python 3 via Homebrew on MacOS you are required to use `brew install python-tk` in order to run this project properly.
## Configuration ## Configuration
@ -69,7 +70,6 @@ python project.py
You can provide the following files / links as context to Ollama: You can provide the following files / links as context to Ollama:
- .csv - .csv
- .html - .html
- .json
- .md - .md
- .pdf - .pdf
- links to websites - links to websites