syaffers commited on
Commit
259262f
·
verified ·
1 Parent(s): 3b06141

docs: update README

Browse files
Files changed (1) hide show
  1. README.md +61 -149
README.md CHANGED
@@ -2,206 +2,118 @@
2
  base_model: hmellor/tiny-random-LlamaForCausalLM
3
  library_name: peft
4
  pipeline_tag: text-generation
 
 
 
 
 
5
  tags:
6
  - base_model:adapter:hmellor/tiny-random-LlamaForCausalLM
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.0
 
2
  base_model: hmellor/tiny-random-LlamaForCausalLM
3
  library_name: peft
4
  pipeline_tag: text-generation
5
+ license: mit
6
+ language:
7
+ - en
8
+ datasets:
9
+ - iamholmes/tiny-imdb
10
  tags:
11
  - base_model:adapter:hmellor/tiny-random-LlamaForCausalLM
12
  - lora
13
  - transformers
14
+ - causal-lm
15
+ - vllm
16
  ---
17
 
18
+ # Tiny Random LLaMA LoRA
 
 
 
19
 
20
+ A minimal LoRA adapter for [hmellor/tiny-random-LlamaForCausalLM](https://huggingface.co/hmellor/tiny-random-LlamaForCausalLM), useful for smoke testing deployments.
21
 
22
  ## Model Details
23
 
24
  ### Model Description
25
 
26
+ This is a LoRA (Low-Rank Adaptation) adapter trained on a tiny random LLaMA model. The model and adapter are intentionally small and produce random outputs—they are **not** meant for any real inference tasks. The primary purpose is to provide a lightweight adapter for testing deployment pipelines, inference servers, and LoRA loading mechanisms.
 
 
27
 
28
+ - **Model type:** LoRA adapter for causal language modeling
29
+ - **Language(s):** English
30
+ - **License:** MIT
31
+ - **Finetuned from:** [hmellor/tiny-random-LlamaForCausalLM](https://huggingface.co/hmellor/tiny-random-LlamaForCausalLM)
 
 
 
32
 
33
+ ### Model Sources
34
 
35
+ - **Repository:** [syaffers/tiny-random-llama-lora](https://github.com/syaffers/tiny-random-llama-lora) (training code)
 
 
 
 
36
 
37
  ## Uses
38
 
 
 
39
  ### Direct Use
40
 
41
+ This adapter is intended for:
42
+ - Smoke testing LoRA adapter loading in inference pipelines
43
+ - Testing deployment configurations with minimal resource usage
44
+ - Validating HuggingFace PEFT integration in your infrastructure
 
 
 
 
 
45
 
46
  ### Out-of-Scope Use
47
 
48
+ This model should **not** be used for:
49
+ - Any real text generation or NLP tasks
50
+ - Production applications
51
+ - Any use case requiring meaningful outputs
 
 
 
 
 
 
 
 
 
 
 
52
 
53
  ## How to Get Started with the Model
54
 
55
+ ```python
56
+ from peft import PeftModel
57
+ from transformers import AutoModelForCausalLM, AutoTokenizer
58
+
59
+ base_model = AutoModelForCausalLM.from_pretrained("hmellor/tiny-random-LlamaForCausalLM")
60
+ model = PeftModel.from_pretrained(base_model, "syaffers/tiny-random-llama-lora")
61
+ tokenizer = AutoTokenizer.from_pretrained("syaffers/tiny-random-llama-lora")
62
 
63
+ # Generate (output will be random/meaningless)
64
+ inputs = tokenizer("Hello world", return_tensors="pt")
65
+ outputs = model.generate(**inputs, max_new_tokens=10)
66
+ print(tokenizer.decode(outputs[0]))
67
+ ```
68
 
69
  ## Training Details
70
 
71
  ### Training Data
72
 
73
+ [iamholmes/tiny-imdb](https://huggingface.co/datasets/iamholmes/tiny-imdb) - A tiny subset of IMDB reviews used for quick training iterations.
 
 
74
 
75
  ### Training Procedure
76
 
 
 
 
 
 
 
 
77
  #### Training Hyperparameters
78
 
79
+ - **Training regime:** fp32
80
+ - **Batch size:** 4
81
+ - **Learning rate:** 1e-4
82
+ - **Epochs:** 3
83
+ - **Warmup steps:** 10
84
+ - **Max sequence length:** 128
 
 
 
 
 
 
 
 
 
 
 
 
 
85
 
86
+ ### LoRA Configuration
87
 
88
+ | Parameter | Value |
89
+ |-----------|-------|
90
+ | r (rank) | 8 |
91
+ | lora_alpha | 16 |
92
+ | target_modules | q_proj, v_proj |
93
+ | lora_dropout | 0.05 |
94
+ | bias | none |
95
+ | task_type | CAUSAL_LM |
96
 
97
+ ## Technical Specifications
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
98
 
99
  ### Model Architecture and Objective
100
 
101
+ LoRA adapter applied to the query and value projection layers of a tiny random LLaMA architecture for causal language modeling.
102
 
103
  ### Compute Infrastructure
104
 
 
 
105
  #### Hardware
106
 
107
+ - Apple M3 Pro (36GB unified memory)
108
+ - macOS Sequoia 15.6.1
109
 
110
  #### Software
111
 
112
+ - Transformers
113
+ - PEFT 0.18.0
114
+ - PyTorch
115
+ - Datasets
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
116
 
 
117
  ### Framework versions
118
 
119
+ - PEFT 0.18.0