Deepu1965 commited on
Commit
e4f2a8e
·
verified ·
1 Parent(s): 954cb58

Upload folder using huggingface_hub

Browse files
Files changed (3) hide show
  1. README.md +195 -105
  2. adapter_config.json +5 -5
  3. adapter_model.safetensors +1 -1
README.md CHANGED
@@ -1,117 +1,207 @@
1
  ---
2
- language:
3
- - en
4
- license: llama3.2
5
  tags:
6
- - summarization
7
- - llama
8
  - lora
9
- - xsum
10
- datasets:
11
- - xsum
12
- metrics:
13
- - rouge
14
- library_name: transformers
15
- pipeline_tag: summarization
16
  ---
17
 
18
- # LLaMA 3.2 1B Instruct - XSum Summarization (LoRA)
 
 
 
19
 
20
- This model is a LoRA fine-tuned version of [`meta-llama/Llama-3.2-1B-Instruct`](https://huggingface.co/meta-llama/Llama-3.2-1B-Instruct) for extreme summarization on the XSum dataset.
21
 
22
  ## Model Details
23
 
24
- - **Base Model**: meta-llama/Llama-3.2-1B-Instruct
25
- - **Method**: LoRA (Low-Rank Adaptation)
26
- - **Task**: Instruction-based summarization
27
- - **Dataset**: XSum (extreme summarization)
28
- - **Training Samples**: 5,000
29
- - **Validation Samples**: 500
30
-
31
- ## Training Configuration
32
-
33
- ### LoRA Parameters
34
- - **Rank (r)**: 16
35
- - **Alpha**: 32
36
- - **Dropout**: 0.05
37
- - **Target Modules**: q_proj, k_proj, v_proj...
38
-
39
- ### Training Hyperparameters
40
- - **Epochs**: 3
41
- - **Batch Size**: 4
42
- - **Gradient Accumulation**: 4
43
- - **Learning Rate**: 0.0002
44
- - **Optimizer**: paged_adamw_8bit
45
- - **Scheduler**: cosine
46
- - **Quantization**: 4-bit (nf4)
47
-
48
- ## Performance
49
-
50
- Evaluated on 200 validation samples:
51
-
52
- | Metric | Score |
53
- |--------|-------|
54
- | ROUGE-1 | 0.2077 |
55
- | ROUGE-2 | 0.0637 |
56
- | ROUGE-L | 0.1519 |
57
- | ROUGE-Lsum | 0.1566 |
58
-
59
- ## Usage
60
-
61
- ```python
62
- from transformers import AutoTokenizer, AutoModelForCausalLM
63
- from peft import PeftModel
64
- import torch
65
-
66
- # Load base model
67
- model_name = "meta-llama/Llama-3.2-1B-Instruct"
68
- tokenizer = AutoTokenizer.from_pretrained(model_name)
69
- model = AutoModelForCausalLM.from_pretrained(
70
- model_name,
71
- torch_dtype=torch.float16,
72
- device_map="auto"
73
- )
74
-
75
- # Load LoRA adapters
76
- model = PeftModel.from_pretrained(model, "Deepu1965/xsum-llama1b-instruct-lora")
77
-
78
- # Prepare input
79
- document = "Your news article here..."
80
- prompt = (
81
- "<|begin_of_text|><|start_header_id|>system<|end_header_id|>\n\n"
82
- "You are a helpful assistant that summarizes news articles into one concise sentence.\n"
83
- "<|eot_id|><|start_header_id|>user<|end_header_id|>\n\n"
84
- f"Summarize this article in one sentence:\n\n{document}\n"
85
- "<|eot_id|><|start_header_id|>assistant<|end_header_id|>\n\n"
86
- )
87
-
88
- inputs = tokenizer(prompt, return_tensors="pt").to(model.device)
89
- outputs = model.generate(**inputs, max_new_tokens=128)
90
- summary = tokenizer.decode(outputs[0], skip_special_tokens=True)
91
- ```
92
 
93
  ## Training Details
94
 
95
- - **Framework**: HuggingFace Transformers + PEFT
96
- - **Quantization**: bitsandbytes 4-bit
97
- - **Gradient Checkpointing**: Enabled
98
- - **Mixed Precision**: FP16
99
-
100
- ## Limitations
101
-
102
- - Trained on English news articles only
103
- - Optimized for single-sentence summaries
104
- - May not generalize well to other domains
105
- - Requires LoRA adapters loaded on top of base model
106
-
107
- ## Citation
108
-
109
- ```bibtex
110
- @misc{llama32-xsum-lora,
111
- author = {Your Name},
112
- title = {LLaMA 3.2 1B XSum LoRA},
113
- year = {2025},
114
- publisher = {HuggingFace},
115
- url = {https://huggingface.co/Deepu1965/xsum-llama1b-instruct-lora}
116
- }
117
- ```
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
  ---
2
+ base_model: meta-llama/Llama-3.2-1B-Instruct
3
+ library_name: peft
4
+ pipeline_tag: text-generation
5
  tags:
6
+ - base_model:adapter:meta-llama/Llama-3.2-1B-Instruct
 
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.17.1
adapter_config.json CHANGED
@@ -25,13 +25,13 @@
25
  "rank_pattern": {},
26
  "revision": null,
27
  "target_modules": [
28
- "q_proj",
29
  "k_proj",
30
- "gate_proj",
31
  "down_proj",
32
- "up_proj",
33
- "v_proj",
34
- "o_proj"
 
35
  ],
36
  "target_parameters": null,
37
  "task_type": "CAUSAL_LM",
 
25
  "rank_pattern": {},
26
  "revision": null,
27
  "target_modules": [
28
+ "up_proj",
29
  "k_proj",
 
30
  "down_proj",
31
+ "gate_proj",
32
+ "q_proj",
33
+ "o_proj",
34
+ "v_proj"
35
  ],
36
  "target_parameters": null,
37
  "task_type": "CAUSAL_LM",
adapter_model.safetensors CHANGED
@@ -1,3 +1,3 @@
1
  version https://git-lfs.github.com/spec/v1
2
- oid sha256:46ea89f318c2bc8ebc290bd630d91799219cf73aca6c1c7e686d4c284374ea70
3
  size 45118424
 
1
  version https://git-lfs.github.com/spec/v1
2
+ oid sha256:55f74b738cb37920312e91faaae1c8b1dd346716504dc506ef4849c2e9314913
3
  size 45118424