Spaces:
Runtime error
Runtime error
readme updated with HF info
Browse files
README.md
CHANGED
@@ -10,4 +10,39 @@ pinned: false
|
|
10 |
license: apache-2.0
|
11 |
---
|
12 |
|
13 |
-
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
10 |
license: apache-2.0
|
11 |
---
|
12 |
|
13 |
+
# Talk to Your Data
|
14 |
+
|
15 |
+
## Overview
|
16 |
+
|
17 |
+
This code provides a simple chat interface that uses OpenAI's GPT-3.5-Turbo to answer questions related to a document.
|
18 |
+
|
19 |
+
## Features
|
20 |
+
|
21 |
+
- **Upload Documents**: Users can upload PDF or text files.
|
22 |
+
- **Conversational Interface**: Engage in a chat-like conversation with the AI.
|
23 |
+
- **Real-time Messages**: Messages from the user and AI are displayed in real-time.
|
24 |
+
|
25 |
+
## Usage
|
26 |
+
|
27 |
+
1. Set your OpenAI API key in a `.env` file.
|
28 |
+
```bash
|
29 |
+
OPENAI_API_KEY=sk-...
|
30 |
+
```
|
31 |
+
2. Install the dependencies.
|
32 |
+
```bash
|
33 |
+
pip install -r requirements.txt
|
34 |
+
```
|
35 |
+
3. Run the app using
|
36 |
+
```bash
|
37 |
+
streamlit run chat.py
|
38 |
+
```
|
39 |
+
4. Upload a document through the app's sidebar.
|
40 |
+
5. Start a conversation with the AI by sending a message.
|
41 |
+
|
42 |
+
## Deploy to Hugging Face Spaces
|
43 |
+
huggingface-cli login
|
44 |
+
git remote add huggingface https://huggingface.co/spaces/qmaruf/talk-to-data
|
45 |
+
|
46 |
+
|
47 |
+
## Author
|
48 |
+
Quazi Marufur Rahman | maruf.csdu@gmail.com
|