Update README.md
Browse files
README.md
CHANGED
|
@@ -1,96 +1,13 @@
|
|
| 1 |
-
|
| 2 |
-
|
| 3 |
-
|
| 4 |
-
|
| 5 |
-
|
| 6 |
-
|
| 7 |
-
|
| 8 |
-
|
| 9 |
-
|
| 10 |
-
|
| 11 |
-
|
| 12 |
-
|
| 13 |
-
|
| 14 |
-
|
| 15 |
-
To get started with this project, follow the steps below.
|
| 16 |
-
|
| 17 |
-
### Prerequisites π οΈ
|
| 18 |
-
|
| 19 |
-
Before using the chatbot, ensure you have the following installed:
|
| 20 |
-
|
| 21 |
-
- Python 3.x π
|
| 22 |
-
- pip (Python package manager) π¦
|
| 23 |
-
|
| 24 |
-
### Installation βοΈ
|
| 25 |
-
|
| 26 |
-
1. Clone the repository:
|
| 27 |
-
|
| 28 |
-
```shell
|
| 29 |
-
git clone https://github.com/yesbhautik/Talk-with-PDF.git
|
| 30 |
-
```
|
| 31 |
-
2. Navigate to the project directory:
|
| 32 |
-
|
| 33 |
-
```shell
|
| 34 |
-
cd Talk-with-PDF
|
| 35 |
-
```
|
| 36 |
-
3. Install the required Python packages using pip:
|
| 37 |
-
```shell
|
| 38 |
-
pip install -r requirements.txt
|
| 39 |
-
```
|
| 40 |
-
|
| 41 |
-
4. Copy .env.example to .env and set your OpenAI & Hugging Face API keys:
|
| 42 |
-
|
| 43 |
-
```shell
|
| 44 |
-
cp .env.example .env
|
| 45 |
-
```
|
| 46 |
-
|
| 47 |
-
## Usage π
|
| 48 |
-
|
| 49 |
-
1. Run the chatbot using the following command:
|
| 50 |
-
|
| 51 |
-
```shell
|
| 52 |
-
streamlit run app.py
|
| 53 |
-
```
|
| 54 |
-
3. The chatbot interface will open in your default web browser π
|
| 55 |
-
4. Upload one or more PDF files for processing π
|
| 56 |
-
5. Start a conversation by asking questions or making inquiries about the PDF content π¬
|
| 57 |
-
6. The chatbot will provide responses based on the content of the uploaded PDFs π§
|
| 58 |
-
|
| 59 |
-
## Features π
|
| 60 |
-
|
| 61 |
-
- Upload and process multiple PDF documents π
|
| 62 |
-
- Query and discuss the contents of PDFs using natural language π¬
|
| 63 |
-
- Integrates with powerful language models for accurate responses π‘
|
| 64 |
-
- User-friendly web interface powered by Streamlit π₯οΈ
|
| 65 |
-
|
| 66 |
-
## Contributing π€
|
| 67 |
-
Contributions are welcome! Please follow these steps to contribute to the project:
|
| 68 |
-
|
| 69 |
-
1. Fork the repositoryπ΄
|
| 70 |
-
2. Create a new branch for your feature or bug fix πΏ
|
| 71 |
-
3. Make your changes and commit them π»
|
| 72 |
-
4. Push your changes to your fork π
|
| 73 |
-
5. Create a pull request to the main repository π₯
|
| 74 |
-
|
| 75 |
-
## π₯ Show some support | Donation
|
| 76 |
-
|
| 77 |
-
If you find this repository helpful, show your support by giving it a π! Your support means a lot to me and helps me keep contributing to the open-source community.
|
| 78 |
-
|
| 79 |
-
Also, if you'd like to support me financially, you can do so via my donation link: [https://go.yesbhautik.co.in/8i6wdu](https://go.yesbhautik.co.in/8i6wdu)
|
| 80 |
-
<br><br>
|
| 81 |
-
<a href="https://go.yesbhautik.co.in/8i6wdu">
|
| 82 |
-
<img src="https://www.pngall.com/wp-content/uploads/2016/05/PayPal-Donate-Button-Free-Download-PNG.png" alt="Donate" width="100">
|
| 83 |
-
</a>
|
| 84 |
-
|
| 85 |
-
## π¬ Let's Connect
|
| 86 |
-
|
| 87 |
-
Feel free to reach out to us if you have questions, ideas, or simply want to chat. We're here to help and connect with the community.
|
| 88 |
-
|
| 89 |
-
- Website: [https://yesbhautik.co.in/](https://yesbhautik.co.in/)
|
| 90 |
-
- Another One: [https://yesbhautikx.co.in/](https://yesbhautikx.co.in/)
|
| 91 |
-
- LinkedIn profile: [https://www.linkedin.com/in/yesbhautik](https://www.linkedin.com/in/yesbhautik)
|
| 92 |
-
- Instagram page: [https://www.instagram.com/yesbhautik](https://www.instagram.com/yesbhautik)
|
| 93 |
-
|
| 94 |
-
## π License
|
| 95 |
-
|
| 96 |
-
This repository is under the MIT License. For more information, see the [LICENSE](LICENSE) file.
|
|
|
|
| 1 |
+
---
|
| 2 |
+
title: Test1
|
| 3 |
+
emoji: π
|
| 4 |
+
colorFrom: gray
|
| 5 |
+
colorTo: purple
|
| 6 |
+
sdk: streamlit
|
| 7 |
+
sdk_version: 1.38.0
|
| 8 |
+
app_file: app.py
|
| 9 |
+
pinned: false
|
| 10 |
+
license: mit
|
| 11 |
+
---
|
| 12 |
+
|
| 13 |
+
Check out the configuration reference at https://huggingface.co/docs/hub/spaces-config-reference
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|