maclenn77 commited on
Commit
094cc8d
·
unverified ·
1 Parent(s): bef36b3

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +10 -10
README.md CHANGED
@@ -1,5 +1,5 @@
1
  ---
2
- title: PDF Explainer
3
  emoji: 📝
4
  colorFrom: red
5
  colorTo: pink
@@ -9,21 +9,21 @@ pinned: false
9
  license: mit
10
  ---
11
 
12
- # PDF Explainer
13
- PDF Explainer is a tool that helps you to create your own knowledge base for retrieval information when interacting with a LLM. The app take advantage of the frameworks Streamlit and Langchain and uses a client-side ChromaDB.
14
 
15
  ## Features
16
 
17
- PDF Explainer offers you the following key features:
18
 
19
  - **Upload PDF files**: Upload PDF files until 200MB size. PDF files should be programmatically created or processed by an OCR tool.
20
  - **Extract and split text**: Extract the content of your PDF files and split them for a better querying.
21
- - **Store in a client-side VectorDB**: PDF Explainer uses ChromaDB for storing the content of your pdf files on vectors (ChromaDB use by default "all-MiniLM-L6-v2" for embeddings)
22
  - **Consult the info of your knowledge base": Ask questions to the Intelligent Assitant about the content of your knowledge base. The Langchain Agent will use the ChromaDB query functions as a tool.
23
 
24
  ## Demo
25
 
26
- [Try the PDF Explainer's demo](https://huggingface.co/spaces/maclenn77/pdf-explainer)!!!
27
 
28
  ## Prerrequisites
29
 
@@ -40,7 +40,7 @@ If you prefer to clone the project and run on your local environment, you will r
40
 
41
  ## Setup
42
 
43
- Follow the next steps to set up PDF Explainer in your local environment:
44
 
45
  1. Clone this repository
46
 
@@ -72,7 +72,7 @@ Follow the next steps to set up PDF Explainer in your local environment:
72
 
73
  ## Deployment
74
 
75
- PDF Explainer's repo includes workflows for deploying to HuggingFace.
76
 
77
  1. **Check file size**: Prevents you to merge and deploy files over the limit provided by HuggingFace 🤗.
78
  2. **Check lints**: Analize the code with pylint.
@@ -81,11 +81,11 @@ PDF Explainer's repo includes workflows for deploying to HuggingFace.
81
  For deploying, you need to add `HF_TOKEN` as secret in the settings of your fork and add yoyr HuggingFace user with the variable name `HF_USERNAME`.
82
 
83
  ## Feedback and Contributions
84
- If you have any feedback or would like to contribute to PDF Explainer's development, please feel free to open issues or submit pull requests in the GitHub repository.
85
 
86
  ## License
87
  This project is licensed under the MIT License. See the LICENSE file for details.
88
 
89
  ---
90
 
91
- Enjoy using PDF Explainer to create and consult your knowled base! If you have any questions or encounter issues during the setup process, please don't hesitate to reach out for assistance.
 
1
  ---
2
+ title: GnosisPages
3
  emoji: 📝
4
  colorFrom: red
5
  colorTo: pink
 
9
  license: mit
10
  ---
11
 
12
+ # GnosisPages
13
+ GnosisPages is a tool that helps you to create your own knowledge base for retrieval information when interacting with a LLM. The app take advantage of the frameworks Streamlit and Langchain and uses a client-side ChromaDB.
14
 
15
  ## Features
16
 
17
+ GnosisPages offers you the following key features:
18
 
19
  - **Upload PDF files**: Upload PDF files until 200MB size. PDF files should be programmatically created or processed by an OCR tool.
20
  - **Extract and split text**: Extract the content of your PDF files and split them for a better querying.
21
+ - **Store in a client-side VectorDB**: GnosisPages uses ChromaDB for storing the content of your pdf files on vectors (ChromaDB use by default "all-MiniLM-L6-v2" for embeddings)
22
  - **Consult the info of your knowledge base": Ask questions to the Intelligent Assitant about the content of your knowledge base. The Langchain Agent will use the ChromaDB query functions as a tool.
23
 
24
  ## Demo
25
 
26
+ [Try the GnosisPages's demo](https://huggingface.co/spaces/maclenn77/pdf-explainer)!!!
27
 
28
  ## Prerrequisites
29
 
 
40
 
41
  ## Setup
42
 
43
+ Follow the next steps to set up GnosisPages in your local environment:
44
 
45
  1. Clone this repository
46
 
 
72
 
73
  ## Deployment
74
 
75
+ GnosisPages's repo includes workflows for deploying to HuggingFace.
76
 
77
  1. **Check file size**: Prevents you to merge and deploy files over the limit provided by HuggingFace 🤗.
78
  2. **Check lints**: Analize the code with pylint.
 
81
  For deploying, you need to add `HF_TOKEN` as secret in the settings of your fork and add yoyr HuggingFace user with the variable name `HF_USERNAME`.
82
 
83
  ## Feedback and Contributions
84
+ If you have any feedback or would like to contribute to GnosisPages's development, please feel free to open issues or submit pull requests in the GitHub repository.
85
 
86
  ## License
87
  This project is licensed under the MIT License. See the LICENSE file for details.
88
 
89
  ---
90
 
91
+ Enjoy using GnosisPages to create and consult your knowled base! If you have any questions or encounter issues during the setup process, please don't hesitate to reach out for assistance.