update readme.md

README.md

@@ -10,4 +10,35 @@ pinned: false
 license: mit
 ---
 
-Check out the configuration reference at https://huggingface.co/docs/hub/spaces-config-reference
+# Own-Knowledge-GPT 
+## Introduction 
+Welcome to the Own-Knowledge-GPT, this is a demo project that allow you want your Chat bot can learn anything you want 
+
+This project is built by Python and integration with OpenAI API which use GPT-3.5-turbo model 
+
+## Getting Started 
+### 1. Environment Setup
+The project is built in python 3.9+. You need to install python 3.9 or later
+
+For install dependencies:
+```commandline
+ pip install -r requirements.txt
+```
+### How to use 
+This project use Gradio to build User Interface, please use: 
+```commandline
+ python app.py
+```
+Enjoy project with step by step follow this: 
+
+Bot Learning with URL 
+![Screenshot 2023-11-13 at 19.56.40.png](..%2F..%2F..%2F..%2Fvar%2Ffolders%2Fzc%2Fcsmhsgrd0bz3bbkycljwdk2c0000gn%2FT%2FTemporaryItems%2FNSIRD_screencaptureui_zJFx9p%2FScreenshot%202023-11-13%20at%2019.56.40.png)
+
+Please input URL and your file format and then press Training button, when the training process is finished, it's will notice you Training Completed 
+
+After that, you can starting chat with your custom bot about the topic in your URL
+![Screenshot 2023-11-13 at 20.00.10.png](..%2F..%2F..%2F..%2Fvar%2Ffolders%2Fzc%2Fcsmhsgrd0bz3bbkycljwdk2c0000gn%2FT%2FTemporaryItems%2FNSIRD_screencaptureui_xDIQGv%2FScreenshot%202023-11-13%20at%2020.00.10.png)
+
+The vector index storage by this structure: 
+
+![Screenshot 2023-11-13 at 20.03.04.png](..%2F..%2F..%2F..%2Fvar%2Ffolders%2Fzc%2Fcsmhsgrd0bz3bbkycljwdk2c0000gn%2FT%2FTemporaryItems%2FNSIRD_screencaptureui_ZTP7r9%2FScreenshot%202023-11-13%20at%2020.03.04.png)

learning_documents/combined_content_index/index.pkl

@@ -1,3 +1,3 @@
 version https://git-lfs.github.com/spec/v1
-oid sha256:7246a7c708997772e992539fa7cef62d0e33a4a77a03f6483be6a108106a7c1c
-size 100825
+oid sha256:bbc4c242c12ce0d77cdeb962c2854f6c0888ce56f6d098a40570e16caff75d52
+size 6059