yeorem commited on
Commit
998e3bc
1 Parent(s): 54e40a1

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +35 -1
README.md CHANGED
@@ -1,6 +1,40 @@
1
  ---
2
  tags:
3
- - text-classification # Replace with the correct task tag for your model
4
  - question-answering
 
 
 
5
  license: apache-2.0
6
  ---
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
  ---
2
  tags:
 
3
  - question-answering
4
+ - faq
5
+ - fine-tuned
6
+ - canton-roast
7
  license: apache-2.0
8
  ---
9
+
10
+ # Canton Roast FAQ Model
11
+
12
+ This model is fine-tuned to answer frequently asked questions related to Canton Roast. It is designed to provide accurate and relevant answers to questions about Canton Roast's products, services, and operations.
13
+
14
+ ## Model Details
15
+
16
+ - **Model type:** Question Answering
17
+ - **Base model:** [Your base model name, e.g., `bert-base-uncased`]
18
+ - **Fine-tuned on:** Canton Roast FAQs dataset
19
+ - **Task:** Question Answering
20
+ - **License:** Apache 2.0
21
+
22
+ ## Intended Use
23
+
24
+ This model is intended to be used for customer support and information retrieval regarding Canton Roast. It can answer questions such as:
25
+
26
+ - What are your opening hours?
27
+ - Do you offer delivery services?
28
+ - What payment methods do you accept?
29
+
30
+ ## How to Use
31
+
32
+ ### Inference API
33
+
34
+ You can use the Hugging Face Inference API to query this model:
35
+
36
+ ```bash
37
+ curl -X POST https://api-inference.huggingface.co/models/your-username/canton-roast-faqs-model \
38
+ -H "Authorization: Bearer your_huggingface_api_token" \
39
+ -H "Content-Type: application/json" \
40
+ -d '{"inputs": {"question": "What are your opening hours?", "context": "Your context here"}}'