FauziIsyrinApridal commited on
Commit
3ba68a8
Β·
1 Parent(s): ea1ba01

update readme

Browse files
Files changed (1) hide show
  1. README.md +30 -47
README.md CHANGED
@@ -1,60 +1,43 @@
1
- # Pnp-Bot
 
 
 
 
 
 
 
 
 
2
 
3
- Pnp-Bot is a web-based chatbot application to answer questions about Politeknik Negeri Padang using LLM Model (Sahabat-AI) with Retrieval-Augmented Generation method
4
 
5
- (Deployed):
6
 
7
- - Chatbot App :
8
- - Admin Dashboard : <span style="color:yellow;">Limited Access</span>, contact me for more details.
9
 
10
- ### Chatbot app
 
11
 
12
- #### Technologies
13
 
14
  - Python
15
- - Langchain
16
  - Streamlit
17
- - Sahabat-AI (LLM)
 
 
18
 
19
- #### Create virtual environment
20
 
21
- ```bash
22
- python -m venv venv
23
- ```
24
 
25
- #### Activate virtual environment
 
26
 
27
- On windows
28
 
29
- ```bash
30
- .\venv\Scripts\activate
31
-
32
- ```
33
-
34
- On linux
35
-
36
- ```bash
37
- source venv/Scripts/activate
38
- ```
39
-
40
- #### Install dependencies
41
-
42
- ```bash
43
- pip install -r requirements.txt
44
- ```
45
-
46
- #### Setup env
47
-
48
- Create env using env.example file
49
-
50
- ```bash
51
- cp .env.example .env
52
- ```
53
-
54
- Fill the variable with your own API keys from https://replicate.com/ and https://huggingface.co/
55
-
56
- #### Running
57
-
58
- ```bash
59
- streamlit run app.py
60
- ```
 
1
+ ---
2
+ title: "Pnp-Bot - Politeknik Negeri Padang Chatbot"
3
+ emoji: "πŸŽ“"
4
+ colorFrom: "blue"
5
+ colorTo: "indigo"
6
+ sdk: "streamlit"
7
+ sdk_version: "1.29.0"
8
+ app_file: "app.py"
9
+ pinned: true
10
+ ---
11
 
12
+ # PNP-Bot πŸ€–
13
 
14
+ A web-based chatbot for Politeknik Negeri Padang using Sahabat-AI LLM with Retrieval-Augmented Generation (RAG) technology.
15
 
16
+ ## 🌐 Live Deployments
 
17
 
18
+ - **Chatbot App**: [![Hugging Face Spaces](https://img.shields.io/badge/πŸ€—-Hugging%20Face%20Space-blue)](YOUR_HF_SPACE_LINK)
19
+ - **Admin Dashboard**: <span style="color: orange; font-weight: bold;">Limited Access</span> (Contact maintainer for access)
20
 
21
+ ## πŸ› οΈ Technologies
22
 
23
  - Python
24
+ - LangChain
25
  - Streamlit
26
+ - Sahabat-AI LLM
27
+ - Hugging Face (Embeddings)
28
+ - Replicate (LLM API)
29
 
30
+ ## πŸš€ Quick Start
31
 
32
+ ### Prerequisites
 
 
33
 
34
+ - Python 3.8+
35
+ - Git
36
 
37
+ ### Installation
38
 
39
+ 1. Clone repository:
40
+ ```bash
41
+ git clone https://github.com/your-username/pnp-bot.git
42
+ cd pnp-bot
43
+ ```