duythduong commited on
Commit
e3f036e
·
verified ·
1 Parent(s): db06678

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +6 -81
README.md CHANGED
@@ -1,81 +1,6 @@
1
- # RAG
2
-
3
- This project provides a web interface to upload PDF documents and ask questions about their content. It uses a FastAPI backend to process the documents and provide summarized responses, and a Streamlit frontend to create an interactive user interface.
4
-
5
- ## Table of Contents
6
-
7
- - [Installation](#installation)
8
- - [Usage](#usage)
9
- - [Contributing](#contributing)
10
- - [License](#license)
11
-
12
- ## Installation
13
-
14
- ### Prerequisites
15
-
16
- - Python 3.7+
17
- - `pip` (Python package installer)
18
-
19
- ### Steps
20
-
21
- 1. Clone the repository:
22
-
23
- ```bash
24
- git clone https://github.com/dtduy77/RAG.git
25
- cd RAG
26
- ```
27
-
28
- 2. Create and activate a virtual environment:
29
-
30
- ```bash
31
- python -m venv env
32
- source env/bin/activate # On Windows use `env\Scripts\activate
33
- ```
34
-
35
- 3. Install the required dependencies:
36
-
37
- ```bash
38
- pip install -r requirements.txt
39
- ```
40
-
41
- 4. Run the FastAPI server:
42
-
43
- ```bash
44
- uvicorn main:app --reload
45
- ```
46
-
47
- 5. Run the Streamlit app in another terminal:
48
-
49
- ```bash
50
- streamlit run app.py
51
- ```
52
-
53
- ## Usage
54
-
55
- 1. Open your web browser and go to http://localhost:8501.
56
-
57
- 2. Use the file uploader to select a PDF document.
58
-
59
- 3. Enter a question related to the content of the document.
60
-
61
- 4. Click on "Get Summary" to receive a summarized response.
62
-
63
- ## Contributing
64
-
65
- 1. Fork the repository.
66
-
67
- 2. Create a new branch (git checkout -b feature/your-feature).
68
-
69
- 3. Make your changes.
70
-
71
- 4. Commit your changes (git commit -m 'Add your message').
72
-
73
- 5. Push to the branch (git push origin feature/your-feature).
74
-
75
- 6. Open a Pull Request.
76
-
77
- ## License
78
-
79
- This project is open-source.
80
-
81
- Feel free to contribute and enhance the functionality!
 
1
+ title: ChatFPT
2
+ emoji: ❤
3
+ colorFrom: pink
4
+ colorTo: red
5
+ sdk: docker
6
+ pinned: false