Vipplav commited on
Commit
9783ccb
·
verified ·
1 Parent(s): 93420e1

Revamp model card with Vipplav Enterprise documentation and inference guide

Browse files
Files changed (1) hide show
  1. README.md +75 -182
README.md CHANGED
@@ -1,199 +1,92 @@
1
  ---
2
- library_name: transformers
3
- tags: []
 
 
 
 
 
 
 
 
 
 
 
4
  ---
5
 
6
- # Model Card for Model ID
7
 
8
- <!-- Provide a quick summary of what the model is/does. -->
 
 
9
 
 
 
 
 
10
 
 
11
 
12
- ## Model Details
13
-
14
- ### Model Description
15
-
16
- <!-- Provide a longer summary of what this model is. -->
17
-
18
- This is the model card of a 🤗 transformers model that has been pushed on the Hub. This model card has been automatically generated.
19
-
20
- - **Developed by:** [More Information Needed]
21
- - **Funded by [optional]:** [More Information Needed]
22
- - **Shared by [optional]:** [More Information Needed]
23
- - **Model type:** [More Information Needed]
24
- - **Language(s) (NLP):** [More Information Needed]
25
- - **License:** [More Information Needed]
26
- - **Finetuned from model [optional]:** [More Information Needed]
27
-
28
- ### Model Sources [optional]
29
-
30
- <!-- Provide the basic links for the model. -->
31
-
32
- - **Repository:** [More Information Needed]
33
- - **Paper [optional]:** [More Information Needed]
34
- - **Demo [optional]:** [More Information Needed]
35
-
36
- ## Uses
37
-
38
- <!-- Address questions around how the model is intended to be used, including the foreseeable users of the model and those affected by the model. -->
39
-
40
- ### Direct Use
41
-
42
- <!-- This section is for the model use without fine-tuning or plugging into a larger ecosystem/app. -->
43
-
44
- [More Information Needed]
45
-
46
- ### Downstream Use [optional]
47
-
48
- <!-- This section is for the model use when fine-tuned for a task, or when plugged into a larger ecosystem/app -->
49
-
50
- [More Information Needed]
51
-
52
- ### Out-of-Scope Use
53
-
54
- <!-- This section addresses misuse, malicious use, and uses that the model will not work well for. -->
55
-
56
- [More Information Needed]
57
-
58
- ## Bias, Risks, and Limitations
59
-
60
- <!-- This section is meant to convey both technical and sociotechnical limitations. -->
61
-
62
- [More Information Needed]
63
-
64
- ### Recommendations
65
-
66
- <!-- This section is meant to convey recommendations with respect to the bias, risk, and technical limitations. -->
67
-
68
- Users (both direct and downstream) should be made aware of the risks, biases and limitations of the model. More information needed for further recommendations.
69
-
70
- ## How to Get Started with the Model
71
-
72
- Use the code below to get started with the model.
73
-
74
- [More Information Needed]
75
-
76
- ## Training Details
77
-
78
- ### Training Data
79
-
80
- <!-- This should link to a Dataset Card, perhaps with a short stub of information on what the training data is all about as well as documentation related to data pre-processing or additional filtering. -->
81
-
82
- [More Information Needed]
83
-
84
- ### Training Procedure
85
-
86
- <!-- This relates heavily to the Technical Specifications. Content here should link to that section when it is relevant to the training procedure. -->
87
-
88
- #### Preprocessing [optional]
89
-
90
- [More Information Needed]
91
-
92
-
93
- #### Training Hyperparameters
94
-
95
- - **Training regime:** [More Information Needed] <!--fp32, fp16 mixed precision, bf16 mixed precision, bf16 non-mixed precision, fp16 non-mixed precision, fp8 mixed precision -->
96
-
97
- #### Speeds, Sizes, Times [optional]
98
-
99
- <!-- This section provides information about throughput, start/end time, checkpoint size if relevant, etc. -->
100
-
101
- [More Information Needed]
102
-
103
- ## Evaluation
104
-
105
- <!-- This section describes the evaluation protocols and provides the results. -->
106
-
107
- ### Testing Data, Factors & Metrics
108
-
109
- #### Testing Data
110
-
111
- <!-- This should link to a Dataset Card if possible. -->
112
-
113
- [More Information Needed]
114
-
115
- #### Factors
116
-
117
- <!-- These are the things the evaluation is disaggregating by, e.g., subpopulations or domains. -->
118
-
119
- [More Information Needed]
120
-
121
- #### Metrics
122
-
123
- <!-- These are the evaluation metrics being used, ideally with a description of why. -->
124
-
125
- [More Information Needed]
126
-
127
- ### Results
128
-
129
- [More Information Needed]
130
-
131
- #### Summary
132
-
133
-
134
-
135
- ## Model Examination [optional]
136
-
137
- <!-- Relevant interpretability work for the model goes here -->
138
-
139
- [More Information Needed]
140
-
141
- ## Environmental Impact
142
-
143
- <!-- Total emissions (in grams of CO2eq) and additional considerations, such as electricity usage, go here. Edit the suggested text below accordingly -->
144
-
145
- Carbon emissions can be estimated using the [Machine Learning Impact calculator](https://mlco2.github.io/impact#compute) presented in [Lacoste et al. (2019)](https://arxiv.org/abs/1910.09700).
146
-
147
- - **Hardware Type:** [More Information Needed]
148
- - **Hours used:** [More Information Needed]
149
- - **Cloud Provider:** [More Information Needed]
150
- - **Compute Region:** [More Information Needed]
151
- - **Carbon Emitted:** [More Information Needed]
152
-
153
- ## Technical Specifications [optional]
154
-
155
- ### Model Architecture and Objective
156
-
157
- [More Information Needed]
158
-
159
- ### Compute Infrastructure
160
-
161
- [More Information Needed]
162
-
163
- #### Hardware
164
-
165
- [More Information Needed]
166
-
167
- #### Software
168
-
169
- [More Information Needed]
170
-
171
- ## Citation [optional]
172
-
173
- <!-- If there is a paper or blog post introducing the model, the APA and Bibtex information for that should go in this section. -->
174
-
175
- **BibTeX:**
176
-
177
- [More Information Needed]
178
-
179
- **APA:**
180
 
181
- [More Information Needed]
182
 
183
- ## Glossary [optional]
184
 
185
- <!-- If relevant, include terms and calculations in this section that can help readers understand the model or model card. -->
186
 
187
- [More Information Needed]
 
 
 
188
 
189
- ## More Information [optional]
190
 
191
- [More Information Needed]
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
192
 
193
- ## Model Card Authors [optional]
194
 
195
- [More Information Needed]
196
 
197
- ## Model Card Contact
198
 
199
- [More Information Needed]
 
 
 
1
  ---
2
+ language: en
3
+ tags:
4
+ - tinyllama
5
+ - lora
6
+ - peft
7
+ - faq
8
+ - customer-support
9
+ - enterprise-ai
10
+ - vipplav-ai
11
+ license: apache-2.0
12
+ base_model: TinyLlama/TinyLlama-1.1B-Chat-v1.0
13
+ library_name: peft
14
+ pipeline_tag: text-generation
15
  ---
16
 
17
+ <div align="center">
18
 
19
+ # 🦙 TinyLlama Fine-Tuned Enterprise FAQ Assistant
20
+ ### Lightweight, Low-Latency Customer Support & FAQ Generation
21
+ **Developed by [Vipplav AI](https://www.vipplavai.com/) — India's Most Specialized AI Studio**
22
 
23
+ [![Website](https://img.shields.io/badge/Website-vipplavai.com-blue)](https://www.vipplavai.com/)
24
+ [![GitHub](https://img.shields.io/badge/GitHub-vipplavai-black)](https://github.com/vipplavai)
25
+ [![Base Model](https://img.shields.io/badge/Base_Model-TinyLlama--1.1B-orange)](https://huggingface.co/TinyLlama/TinyLlama-1.1B-Chat-v1.0)
26
+ [![License](https://img.shields.io/badge/License-Apache%202.0-green.svg)](https://opensource.org/licenses/Apache-2.0)
27
 
28
+ </div>
29
 
30
+ ---
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
31
 
32
+ ## 📌 Model Overview
33
 
34
+ `Vipplav/tinyllama-finetuned-faq` is a specialized LoRA adapter fine-tuned on top of **`TinyLlama/TinyLlama-1.1B-Chat-v1.0`**.
35
 
36
+ It is engineered for businesses needing an ultra-low-latency, edge-deployable question-answering assistant that delivers concise, context-grounded answers without requiring expensive cloud GPUs or massive API infrastructure.
37
 
38
+ * **Base Model:** `TinyLlama/TinyLlama-1.1B-Chat-v1.0`
39
+ * **Adapter Type:** Parameter-Efficient Fine-Tuning (LoRA)
40
+ * **Target Modules:** `q_proj`, `v_proj`
41
+ * **Ideal Footprint:** Runs seamlessly on consumer laptops, CPUs, Raspberry Pi, or edge nodes (<2GB VRAM).
42
 
43
+ ---
44
 
45
+ ## 🚀 Usage with `peft` and `transformers`
46
+
47
+ ```python
48
+ import torch
49
+ from transformers import AutoTokenizer, AutoModelForCausalLM
50
+ from peft import PeftModel
51
+
52
+ base_model_name = "TinyLlama/TinyLlama-1.1B-Chat-v1.0"
53
+ adapter_name = "Vipplav/tinyllama-finetuned-faq"
54
+
55
+ # 1. Load tokenizer and base model
56
+ tokenizer = AutoTokenizer.from_pretrained(base_model_name)
57
+ base_model = AutoModelForCausalLM.from_pretrained(
58
+ base_model_name,
59
+ torch_dtype=torch.float16 if torch.cuda.is_available() else torch.float32,
60
+ device_map="auto"
61
+ )
62
+
63
+ # 2. Attach Vipplav LoRA adapter
64
+ model = PeftModel.from_pretrained(base_model, adapter_name)
65
+ model.eval()
66
+
67
+ # 3. Format FAQ Prompt
68
+ prompt = "<|system|>\nYou are a helpful enterprise support assistant. Answer the customer FAQ concisely.</s>\n<|user|>\nHow can I reset my account password?</s>\n<|assistant|>\n"
69
+
70
+ inputs = tokenizer(prompt, return_tensors="pt").to(model.device)
71
+ with torch.no_grad():
72
+ outputs = model.generate(
73
+ **inputs,
74
+ max_new_tokens=150,
75
+ temperature=0.3,
76
+ repetition_penalty=1.1,
77
+ eos_token_id=tokenizer.eos_token_id
78
+ )
79
+
80
+ response = tokenizer.decode(outputs[0][inputs.input_ids.shape[1]:], skip_special_tokens=True)
81
+ print("Response:", response.strip())
82
+ ```
83
 
84
+ ---
85
 
86
+ ## 🏢 About Vipplav AI
87
 
88
+ Vipplav AI is an enterprise AI studio engineering foundational Indic Small Language Models (**Rachana**) and verifiable agentic automation pipelines.
89
 
90
+ * **Website:** [https://www.vipplavai.com](https://www.vipplavai.com)
91
+ * **GitHub:** [https://github.com/vipplavai](https://github.com/vipplavai)
92
+ * **Contact:** [hello@vipplavai.com](mailto:hello@vipplavai.com)