ctankso_americas_corpdir_net commited on
Commit
966a2b3
1 Parent(s): 6798371

minor: Updated README

Browse files
Files changed (1) hide show
  1. README.md +33 -1
README.md CHANGED
@@ -9,5 +9,37 @@ 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
 
9
  pinned: false
10
  license: mit
11
  ---
12
+ # Mercedes-Benz Owner's Manual Chatbot
13
+
14
+ This is a chatbot that uses excerpts from the Mercedes-Benz S-Class and EQE owner's manuals to answer questions related to the vehicle's features, functions, and maintenance. The chatbot uses a combination of natural language processing (NLP) and document indexing to provide accurate and relevant responses to user queries.
15
+
16
+ ## Prerequisites
17
+
18
+ To run this chatbot, you will need to have the following installed on your system:
19
+
20
+ - Python 3.7 or later
21
+ - Gradio
22
+ - LangChain
23
+ - EdgeGPT
24
+ - HuggingFace transformers
25
+
26
+ ## Installation
27
+
28
+ To install the necessary packages, you can use pip:
29
+ ```
30
+ pip install gradio langchain edgegpt transformers
31
+ ```
32
+
33
+ You will also need to download the Mercedes-Benz owner's manual data files and store them in the `data` directory. The files should be organized in subdirectories named after the vehicle model (e.g., `s-class-manual` and `eqe-manual`).
34
+
35
+ ## Usage
36
+
37
+ To start the chatbot, you can run the `start_ui()` function in the `app.py` file:
38
+ ```
39
+ python app.py
40
+ ```
41
+
42
+ This will launch a Gradio interface that allows users to enter a question, select the vehicle model (S-Class or EQE), specify whether to create a new chatbot instance or reuse an existing one, and adjust the number of documents to retrieve from the database.
43
+
44
+ When the user submits a question, the chatbot retrieves the most relevant excerpts from the owner's manual and uses them to generate a response. The response is then displayed in the Gradio interface.
45