KrishnanDevilking commited on
Commit
19d5244
·
verified ·
1 Parent(s): 0d82b06

Upload folder using huggingface_hub

Browse files
Files changed (1) hide show
  1. README.md +50 -0
README.md CHANGED
@@ -8,3 +8,53 @@ A lightweight CPU-friendly assistant model that detects user intent and returns
8
  ### Example
9
 
10
  Input:
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
8
  ### Example
9
 
10
  Input:
11
+ ```json
12
+ {
13
+ "intent": "system_restart",
14
+ "response": "System restart initiated...",
15
+ "action": "os.system('shutdown /r /t 1')"
16
+ }
17
+
18
+
19
+ ---
20
+
21
+ ## 💡 Explanation of Each Field
22
+
23
+ | Key | Description |
24
+ |-----|--------------|
25
+ | `language` | Language of your model (English = `en`) |
26
+ | `license` | License type (MIT, Apache-2.0, etc.) |
27
+ | `tags` | Helps in discoverability on Hugging Face |
28
+ | `model-type` | General category (e.g., `text-classification`) |
29
+ | `pipeline_tag` | Specifies the type of pipeline for inference |
30
+ | `base_model` | The pretrained embedder used (e.g., MiniLM-L6-v2) |
31
+ | `widget` | Adds demo examples to the model’s Hugging Face page |
32
+
33
+ ---
34
+
35
+ ## ✅ After Adding YAML
36
+
37
+ When you push the updated `README.md`, the warning:
38
+
39
+
40
+
41
+ ---
42
+ language: en
43
+ license: mit
44
+ tags:
45
+ - intent-classification
46
+ - assistant
47
+ - scikit-learn
48
+ - sentence-transformers
49
+ model-type: text-classification
50
+ pipeline_tag: text-classification
51
+ base_model: sentence-transformers/all-MiniLM-L6-v2
52
+ widget:
53
+ - text: "increase volume"
54
+ - text: "open gmail"
55
+ - text: "restart system"
56
+ ---
57
+
58
+ # Jarvis Intent Classifier
59
+
60
+ A lightweight CPU-friendly assistant model that detects user intent and returns a response + action command.