SaranRaj-12 commited on
Commit
3c2142a
·
verified ·
1 Parent(s): 99a0a80

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +57 -58
README.md CHANGED
@@ -1,58 +1,57 @@
1
- ---
2
- title: PDF Chatbot
3
- emoji: 🌍
4
- colorFrom: blue
5
- colorTo: green
6
- sdk: gradio
7
- sdk_version: 5.16.1
8
- app_file: app.py
9
- pinned: true
10
- ---
11
-
12
-
13
- [![](https://img.shields.io/badge/python-3.10+-blue.svg)](https://www.python.org/downloads/)
14
- [![code style](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
15
- [![linting: pylint](https://img.shields.io/badge/linting-pylint-yellowgreen)](https://github.com/pylint-dev/pylint)
16
-
17
-
18
-
19
- **Aim: PDF-based AI chatbot with retrieval augmented generation**
20
-
21
-
22
- **Architecture / Tech stack:**
23
- - Front-end:
24
- - user interface via Gradio library
25
- - Back-end:
26
- - HuggingFace embeddings
27
- - HuggingFace Inference API for open-source LLMs
28
- - Chromadb vector database
29
- - LangChain conversational retrieval chain
30
-
31
-
32
- You can try out the deployed [Hugging Face Space](https://huggingface.co/spaces/cvachet/pdf-chatbot)!
33
-
34
-
35
- ----
36
-
37
- ### Overview
38
-
39
- **Description:**
40
- This AI assistant, using Langchain and open-source LLMs, performs retrieval-augmented generation (RAG) from your PDF documents. The user interface explicitely shows multiple steps to help understand the RAG workflow. This chatbot takes past questions into account when generating answers (via conversational memory), and includes document references for clarity purposes. It leverages small LLM models to run directly on CPU hardware.
41
-
42
-
43
- **Available open-source LLMs:**
44
- - Meta Llama series
45
- - Alibaba Qwen2.5 series
46
- - Mistral AI models
47
- - Microsoft Phi-3.5 series
48
- - Google Gemma models
49
- - HuggingFace zephyr and SmolLM series
50
-
51
-
52
- ### Local execution
53
-
54
- Command line for execution:
55
- > python3 app.py
56
-
57
- The Gradio web application should now be accessible at http://localhost:7860
58
-
 
1
+ ---
2
+ title: PDF Chatbot
3
+ emoji: 🌍
4
+ colorFrom: blue
5
+ colorTo: green
6
+ sdk: gradio
7
+ sdk_version: 5.25.2
8
+ app_file: app.py
9
+ pinned: true
10
+ ---
11
+
12
+
13
+ [![](https://img.shields.io/badge/python-3.10+-blue.svg)](https://www.python.org/downloads/)
14
+ [![code style](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
15
+ [![linting: pylint](https://img.shields.io/badge/linting-pylint-yellowgreen)](https://github.com/pylint-dev/pylint)
16
+
17
+
18
+
19
+ **Aim: PDF-based AI chatbot with retrieval augmented generation**
20
+
21
+
22
+ **Architecture / Tech stack:**
23
+ - Front-end:
24
+ - user interface via Gradio library
25
+ - Back-end:
26
+ - HuggingFace embeddings
27
+ - HuggingFace Inference API for open-source LLMs
28
+ - Chromadb vector database
29
+ - LangChain conversational retrieval chain
30
+
31
+
32
+ You can try out the deployed [Hugging Face Space](https://huggingface.co/spaces/cvachet/pdf-chatbot)!
33
+
34
+
35
+ ----
36
+
37
+ ### Overview
38
+
39
+ **Description:**
40
+ This AI assistant, using Langchain and open-source LLMs, performs retrieval-augmented generation (RAG) from your PDF documents. The user interface explicitely shows multiple steps to help understand the RAG workflow. This chatbot takes past questions into account when generating answers (via conversational memory), and includes document references for clarity purposes. It leverages small LLM models to run directly on CPU hardware.
41
+
42
+
43
+ **Available open-source LLMs:**
44
+ - Meta Llama series
45
+ - Alibaba Qwen2.5 series
46
+ - Mistral AI models
47
+ - Microsoft Phi-3.5 series
48
+ - Google Gemma models
49
+ - HuggingFace zephyr and SmolLM series
50
+
51
+
52
+ ### Local execution
53
+
54
+ Command line for execution:
55
+ > python3 app.py
56
+
57
+ The Gradio web application should now be accessible at http://localhost:7860