adiiiii13 commited on
Commit
da0ceb3
·
verified ·
1 Parent(s): 0a02627

Update Readme

Browse files
Files changed (1) hide show
  1. README.md +86 -139
README.md CHANGED
@@ -1,207 +1,154 @@
1
  ---
2
  base_model: TinyLlama/TinyLlama-1.1B-Chat-v1.0
3
  library_name: peft
 
 
 
4
  pipeline_tag: text-generation
5
  tags:
6
  - base_model:adapter:TinyLlama/TinyLlama-1.1B-Chat-v1.0
7
  - lora
8
  - transformers
 
 
 
9
  ---
10
 
11
- # Model Card for Model ID
12
-
13
- <!-- Provide a quick summary of what the model is/does. -->
14
-
15
 
 
16
 
17
  ## Model Details
18
 
19
  ### Model Description
20
 
21
- <!-- Provide a longer summary of what this model is. -->
22
 
 
 
 
 
 
23
 
 
24
 
25
- - **Developed by:** [More Information Needed]
26
- - **Funded by [optional]:** [More Information Needed]
27
- - **Shared by [optional]:** [More Information Needed]
28
- - **Model type:** [More Information Needed]
29
- - **Language(s) (NLP):** [More Information Needed]
30
- - **License:** [More Information Needed]
31
- - **Finetuned from model [optional]:** [More Information Needed]
32
 
33
- ### Model Sources [optional]
34
 
35
- <!-- Provide the basic links for the model. -->
36
 
37
- - **Repository:** [More Information Needed]
38
- - **Paper [optional]:** [More Information Needed]
39
- - **Demo [optional]:** [More Information Needed]
 
 
 
40
 
41
  ## Uses
42
 
43
- <!-- Address questions around how the model is intended to be used, including the foreseeable users of the model and those affected by the model. -->
44
-
45
  ### Direct Use
46
 
47
- <!-- This section is for the model use without fine-tuning or plugging into a larger ecosystem/app. -->
48
-
49
- [More Information Needed]
50
-
51
- ### Downstream Use [optional]
52
-
53
- <!-- This section is for the model use when fine-tuned for a task, or when plugged into a larger ecosystem/app -->
54
-
55
- [More Information Needed]
56
 
57
  ### Out-of-Scope Use
58
 
59
- <!-- This section addresses misuse, malicious use, and uses that the model will not work well for. -->
 
 
60
 
61
- [More Information Needed]
62
-
63
- ## Bias, Risks, and Limitations
64
-
65
- <!-- This section is meant to convey both technical and sociotechnical limitations. -->
66
-
67
- [More Information Needed]
68
-
69
- ### Recommendations
70
 
71
- <!-- This section is meant to convey recommendations with respect to the bias, risk, and technical limitations. -->
 
 
72
 
73
- Users (both direct and downstream) should be made aware of the risks, biases and limitations of the model. More information needed for further recommendations.
 
 
 
74
 
75
- ## How to Get Started with the Model
 
76
 
77
- Use the code below to get started with the model.
 
 
 
 
78
 
79
- [More Information Needed]
 
 
80
 
81
  ## Training Details
82
 
83
  ### Training Data
84
 
85
- <!-- 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. -->
86
-
87
- [More Information Needed]
88
 
89
  ### Training Procedure
90
 
91
- <!-- This relates heavily to the Technical Specifications. Content here should link to that section when it is relevant to the training procedure. -->
92
-
93
- #### Preprocessing [optional]
94
-
95
- [More Information Needed]
96
-
97
-
98
  #### Training Hyperparameters
99
 
100
- - **Training regime:** [More Information Needed] <!--fp32, fp16 mixed precision, bf16 mixed precision, bf16 non-mixed precision, fp16 non-mixed precision, fp8 mixed precision -->
101
-
102
- #### Speeds, Sizes, Times [optional]
103
-
104
- <!-- This section provides information about throughput, start/end time, checkpoint size if relevant, etc. -->
105
-
106
- [More Information Needed]
107
-
108
- ## Evaluation
109
-
110
- <!-- This section describes the evaluation protocols and provides the results. -->
111
-
112
- ### Testing Data, Factors & Metrics
113
-
114
- #### Testing Data
115
-
116
- <!-- This should link to a Dataset Card if possible. -->
117
-
118
- [More Information Needed]
119
-
120
- #### Factors
121
 
122
- <!-- These are the things the evaluation is disaggregating by, e.g., subpopulations or domains. -->
123
-
124
- [More Information Needed]
125
-
126
- #### Metrics
127
-
128
- <!-- These are the evaluation metrics being used, ideally with a description of why. -->
129
-
130
- [More Information Needed]
131
-
132
- ### Results
133
-
134
- [More Information Needed]
135
-
136
- #### Summary
137
-
138
-
139
-
140
- ## Model Examination [optional]
141
-
142
- <!-- Relevant interpretability work for the model goes here -->
143
-
144
- [More Information Needed]
145
-
146
- ## Environmental Impact
147
-
148
- <!-- Total emissions (in grams of CO2eq) and additional considerations, such as electricity usage, go here. Edit the suggested text below accordingly -->
149
-
150
- 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).
151
-
152
- - **Hardware Type:** [More Information Needed]
153
- - **Hours used:** [More Information Needed]
154
- - **Cloud Provider:** [More Information Needed]
155
- - **Compute Region:** [More Information Needed]
156
- - **Carbon Emitted:** [More Information Needed]
157
-
158
- ## Technical Specifications [optional]
159
 
160
  ### Model Architecture and Objective
161
 
162
- [More Information Needed]
 
 
163
 
164
  ### Compute Infrastructure
165
 
166
- [More Information Needed]
167
-
168
  #### Hardware
169
 
170
- [More Information Needed]
171
 
172
  #### Software
173
 
174
- [More Information Needed]
175
-
176
- ## Citation [optional]
177
-
178
- <!-- If there is a paper or blog post introducing the model, the APA and Bibtex information for that should go in this section. -->
179
-
180
- **BibTeX:**
181
 
182
- [More Information Needed]
183
 
184
- **APA:**
 
 
 
 
 
 
 
185
 
186
- [More Information Needed]
187
 
188
- ## Glossary [optional]
189
 
190
- <!-- If relevant, include terms and calculations in this section that can help readers understand the model or model card. -->
191
-
192
- [More Information Needed]
193
-
194
- ## More Information [optional]
195
-
196
- [More Information Needed]
197
 
198
- ## Model Card Authors [optional]
 
199
 
200
- [More Information Needed]
201
 
202
- ## Model Card Contact
 
 
203
 
204
- [More Information Needed]
205
- ### Framework versions
206
 
207
- - PEFT 0.18.1
 
1
  ---
2
  base_model: TinyLlama/TinyLlama-1.1B-Chat-v1.0
3
  library_name: peft
4
+ license: apache-2.0
5
+ language:
6
+ - en
7
  pipeline_tag: text-generation
8
  tags:
9
  - base_model:adapter:TinyLlama/TinyLlama-1.1B-Chat-v1.0
10
  - lora
11
  - transformers
12
+ - tinyllama
13
+ - bubblesort
14
+ - fine-tuned
15
  ---
16
 
17
+ # 🫧 BubbleSort-LLM
 
 
 
18
 
19
+ A fine-tuned TinyLLaMA-1.1B model with company-specific knowledge about Bubblesort.in and its startups.
20
 
21
  ## Model Details
22
 
23
  ### Model Description
24
 
25
+ BubbleSort-LLM is a LoRA fine-tuned version of TinyLLaMA designed to answer questions about Bubblesort.in, a tech company and startup ecosystem founded by Aditya Routh. The model has been trained to provide accurate information about the company's various ventures and services.
26
 
27
+ - **Developed by:** Aditya Routh / Bubblesort.in
28
+ - **Model type:** Causal Language Model (LoRA Adapter)
29
+ - **Language(s) (NLP):** English
30
+ - **License:** Apache 2.0
31
+ - **Finetuned from model:** [TinyLlama/TinyLlama-1.1B-Chat-v1.0](https://huggingface.co/TinyLlama/TinyLlama-1.1B-Chat-v1.0)
32
 
33
+ ### Model Sources
34
 
35
+ - **Repository:** [adiiiii13/bubblesort-llm](https://huggingface.co/adiiiii13/bubblesort-llm)
36
+ - **Demo:** Coming Soon
 
 
 
 
 
37
 
38
+ ## About Bubblesort.in
39
 
40
+ Bubblesort.in is the parent organization for multiple startups:
41
 
42
+ | Startup | Description | Website |
43
+ |---------|-------------|---------|
44
+ | 🍛 **Ghar Ka Khana** | Homemade food service platform | [gharkakhana2026.in](https://gharkakhana2026.in/) |
45
+ | 💼 **GKK Intern** | Internship platform for students | [gkkintern.in](https://gkkintern.in) |
46
+ | 💚 **Plutoz** | Social/NGO initiative for children | [plutoz1.netlify.app](https://plutoz1.netlify.app/) |
47
+ | 🎨 **APA Collective** | Freelancing agency | [apacollective.netlify.app](https://apacollective.netlify.app/) |
48
 
49
  ## Uses
50
 
 
 
51
  ### Direct Use
52
 
53
+ This model can be used for:
54
+ - Answering questions about Bubblesort.in and its startups
55
+ - Customer support chatbots for Bubblesort.in services
56
+ - Information retrieval about company services
 
 
 
 
 
57
 
58
  ### Out-of-Scope Use
59
 
60
+ - General knowledge questions (use base TinyLLaMA instead)
61
+ - Tasks requiring factual accuracy outside Bubblesort.in domain
62
+ - Production use without additional testing
63
 
64
+ ## How to Get Started with the Model
 
 
 
 
 
 
 
 
65
 
66
+ ```python
67
+ from peft import PeftModel
68
+ from transformers import AutoModelForCausalLM, AutoTokenizer, pipeline
69
 
70
+ # Load model
71
+ base_model = AutoModelForCausalLM.from_pretrained("TinyLlama/TinyLlama-1.1B-Chat-v1.0")
72
+ model = PeftModel.from_pretrained(base_model, "adiiiii13/bubblesort-llm")
73
+ tokenizer = AutoTokenizer.from_pretrained("adiiiii13/bubblesort-llm")
74
 
75
+ # Create pipeline
76
+ pipe = pipeline("text-generation", model=model, tokenizer=tokenizer)
77
 
78
+ # Chat format
79
+ messages = [
80
+ {"role": "system", "content": "You are a helpful assistant for Bubblesort.in"},
81
+ {"role": "user", "content": "What is Bubblesort.in?"}
82
+ ]
83
 
84
+ prompt = tokenizer.apply_chat_template(messages, tokenize=False, add_generation_prompt=True)
85
+ output = pipe(prompt, max_new_tokens=150, do_sample=True, temperature=0.7)
86
+ print(output[0]['generated_text'])
87
 
88
  ## Training Details
89
 
90
  ### Training Data
91
 
92
+ Custom dataset containing information about Bubblesort.in, its services, startups, and company details.
 
 
93
 
94
  ### Training Procedure
95
 
 
 
 
 
 
 
 
96
  #### Training Hyperparameters
97
 
98
+ | Parameter | Value |
99
+ |-----------|-------|
100
+ | LoRA Rank (r) | 16 |
101
+ | LoRA Alpha | 32 |
102
+ | LoRA Dropout | 0.05 |
103
+ | Target Modules | q_proj, k_proj, v_proj, o_proj |
104
+ | Training regime | bf16 mixed precision |
 
 
 
 
 
 
 
 
 
 
 
 
 
 
105
 
106
+ ## Technical Specifications
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
107
 
108
  ### Model Architecture and Objective
109
 
110
+ - **Architecture:** LLaMA-based transformer with LoRA adapters
111
+ - **Parameters:** ~18MB adapter weights
112
+ - **Objective:** Causal language modeling
113
 
114
  ### Compute Infrastructure
115
 
 
 
116
  #### Hardware
117
 
118
+ - Kaggle GPU (T4/P100)
119
 
120
  #### Software
121
 
122
+ - Transformers
123
+ - PEFT 0.18.1
124
+ - PyTorch
 
 
 
 
125
 
126
+ ## Citation
127
 
128
+ ```bibtex
129
+ @misc{bubblesort-llm,
130
+ author = {Aditya Routh},
131
+ title = {BubbleSort-LLM: A Fine-tuned TinyLLaMA for Bubblesort.in},
132
+ year = {2026},
133
+ publisher = {HuggingFace},
134
+ url = {https://huggingface.co/adiiiii13/bubblesort-llm}
135
+ }
136
 
137
+ ## Model Card Authors
138
 
139
+ Aditya Routh ([@adiiiii13](https://huggingface.co/adiiiii13))
140
 
141
+ ## Model Card Contact
 
 
 
 
 
 
142
 
143
+ - **GitHub:** [aditya04slg](https://github.com/aditya04slg)
144
+ - **Website:** [adityarouth.site](https://adityarouth.site)
145
 
146
+ ### Framework Versions
147
 
148
+ - PEFT: 0.18.1
149
+ - Transformers: 4.x
150
+ - PyTorch: 2.x
151
 
152
+ ---
 
153
 
154
+ Made with 💜 by [Bubblesort.in](https://bubblesort.in)