Update README.md
Browse files
README.md
CHANGED
|
@@ -1,3 +1,41 @@
|
|
| 1 |
---
|
| 2 |
license: apache-2.0
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 3 |
---
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
---
|
| 2 |
license: apache-2.0
|
| 3 |
+
language:
|
| 4 |
+
- en
|
| 5 |
+
- zh
|
| 6 |
+
- de
|
| 7 |
+
- fr
|
| 8 |
+
- ar
|
| 9 |
+
- pl
|
| 10 |
+
- ja
|
| 11 |
+
- ko
|
| 12 |
---
|
| 13 |
+
|
| 14 |
+
Copy from this [model card](https://huggingface.co/MyPdfChat/MyPdfChat)
|
| 15 |
+
|
| 16 |
+
# MyPdfChat - Private PDF Chat based on LLM can run on any PC.
|
| 17 |
+
|
| 18 |
+
**MyPdfChat** is using a private 7B RWKV language model designed to run locally and facilitate secure PDF-based chat conversations. With RWKV, you can have confidential and encrypted conversations in PDF format, ensuring the privacy of your discussions.
|
| 19 |
+
## Features
|
| 20 |
+
- **Privacy**: MyPdfChat runs locally on your machine, ensuring that your conversations remain private and secure.
|
| 21 |
+
- **PDF Chat**: MyPdfChat enables you to have chat conversations within PDF documents, providing a unique and secure communication method.
|
| 22 |
+
- **Encryption**: All chat messages are encrypted to protect the confidentiality of your discussions.
|
| 23 |
+
- **Offline Access**: Since RWKV runs locally, you can use it even without an internet connection.
|
| 24 |
+
## Installation
|
| 25 |
+
- To install MyPdfChat from the release, follow these instructions:
|
| 26 |
+
- ### Step 1:
|
| 27 |
+
- Download the Release1. Go to the [Mychatpdf huggingface repo](https://huggingface.co/MyPdfChat/MyPdfChat).2. Download the latest release zip (`mychatpdf-vX.X.X.zip`).
|
| 28 |
+
- ### Step 2:
|
| 29 |
+
- Extract the Release1. Locate the downloaded `mychatpdf-vX.X.X.zip` file on your system.2. Extract the contents of the zip file to a directory of your choice.
|
| 30 |
+
- ### Step 3:
|
| 31 |
+
- double click the MyPdfchat.exe
|
| 32 |
+
## Usage1.
|
| 33 |
+
- chat with you PDF file
|
| 34 |
+
## Contributions
|
| 35 |
+
- Contributions to MyPdfChat are welcome! If you encounter any issues or have suggestions for improvements, please open an issue on the [GitHub repository](https://github.com/mypdfchat/MypdfChat).
|
| 36 |
+
## License
|
| 37 |
+
- MyPdfChat is released under the [MIT License](https://opensource.org/licenses/MIT).
|
| 38 |
+
## Acknowledgements
|
| 39 |
+
- We would like to thank the open-source community for their invaluable contributions to the development of MyPdfChat.
|
| 40 |
+
## Contact
|
| 41 |
+
- For any inquiries or support, please contact us at [email protected]---Thank you for using RWKV! We hope you enjoy your private and secure PDF chat experience.
|