kylebrodeur commited on
Commit
c35e9fd
·
verified ·
1 Parent(s): 794d818

Replace auto-generated template with complete model card

Browse files
Files changed (1) hide show
  1. README.md +84 -168
README.md CHANGED
@@ -1,199 +1,115 @@
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
+ base_model: google/gemma-4-E4B-it
3
+ library_name: peft
4
+ license: gemma
5
+ tags:
6
+ - lora
7
+ - 3d-printing
8
+ - microfactory
9
+ - build-small-hackathon
10
+ - peft
11
+ - chief-engineer
12
  ---
13
 
14
+ # Microfactory Node: 3D Printer (LoRA v2)
15
 
16
+ I trained this LoRA to bake Chief Engineer O'Brien's judgment into Gemma 4 E4B. The live node still reads from the lesson ledger; this adapter is what happens when I try to put that ledger into the weights instead.
17
 
18
+ ## What it does
19
 
20
+ Give it a print job — material, geometry, room temperature and humidity — and it returns structured **Advice JSON**:
21
+ - **Settings**: nozzle_temp, bed_temp, retraction_mm, fan_pct, first_layer_fan_pct
22
+ - **Risk regions**: where on the part, what risk, why, anchor hint
23
+ - **Reasoning**: what transfers from prior knowledge and why
24
 
25
+ ## Training
26
 
27
+ | Parameter | Value |
28
+ |-----------|-------|
29
+ | Base model | `google/gemma-4-E4B-it` |
30
+ | Method | LoRA (PEFT) |
31
+ | Rank | r=4, α=8 |
32
+ | Epochs | 1 |
33
+ | Learning rate | 2e-4 |
34
+ | Batch size | 2 × 4 gradient accumulation |
35
+ | Max sequence length | 1536 |
36
+ | Dataset | 180 train / 80 eval (live-generated on Modal A10G) |
37
+ | GPU | NVIDIA A10G (24GB) |
38
+ | Framework | TRL SFTTrainer + transformers 5.x |
39
 
40
+ I kept rank low and epochs at one on purpose. v1 used r=16 for three epochs on deterministic targets and parroted the same settings for every input. This run sacrifices raw capacity for actual attention to the job.
41
 
42
+ ## Dataset
43
 
44
+ I generated the training set by driving the base model across a grid of 4 materials × 5 geometries × 3 temperatures × 3 humidities (train), with 2 temperatures × 2 humidities held out for eval. Each example is a chat-format pair: system prompt describing the job → structured Advice JSON response.
 
 
 
 
 
 
45
 
46
+ I kept targets noisy — temperature=0.7, top_p=0.95 — so the model cannot memorize a single template. v1 proved that deterministic targets and a high rank just produce a parrot. Noise forces judgment.
47
 
48
+ ## Usage
49
 
50
+ ```python
51
+ from peft import PeftModel
52
+ from transformers import AutoModelForCausalLM, AutoTokenizer
53
+ import torch
54
 
55
+ tok = AutoTokenizer.from_pretrained("google/gemma-4-E4B-it")
56
+ base = AutoModelForCausalLM.from_pretrained(
57
+ "google/gemma-4-E4B-it",
58
+ dtype=torch.bfloat16,
59
+ device_map="auto"
60
+ )
61
+ tuned = PeftModel.from_pretrained(base, "kylebrodeur/microfactory-node-lora-v2")
62
 
63
+ messages = [{"role": "user", "content": "Your prompt here"}]
64
+ inputs = tok.apply_chat_template(messages, return_tensors="pt", add_generation_prompt=True).to(tuned.device)
65
+ out = tuned.generate(**inputs, max_new_tokens=512, do_sample=True, temperature=0.7)
66
+ print(tok.decode(out[0], skip_special_tokens=True))
67
+ ```
68
 
69
+ ## Safety
70
 
71
+ This adapter proposes settings. It does not validate them. A deterministic Spine clamps every proposed value against hard material bounds before any printer sees them. The LoRA gives the opinion; the Spine has the veto.
72
 
73
+ ## Iteration history
74
 
75
+ | Version | Base | Rank | Epochs | Dataset | Result |
76
+ |---------|------|------|--------|---------|--------|
77
+ | v1 | gemma-3-1b-it | r=16 | 3 | deterministic | ❌ Parroted template |
78
+ | **v2** | **gemma-4-E4B-it** | **r=4** | **1** | **live-generated** | **✅ Well-Tuned (100% JSON-valid, 100% Spine-safe, real judgment)** |
79
 
80
+ v1 taught me what not to do.
81
 
82
+ ## Limitations
83
 
84
+ This adapter is narrow by design, and it will fail loudly outside that narrow band.
85
 
86
+ - **Materials and geometries outside the training grid** — The grid covered four materials and five geometries. Hand it an exotic filament or an unusual geometry and it will guess confidently. That guess is extrapolation, not recall.
87
+ - **Humid PETG stringing** — Small Gemmas can return perfectly valid JSON with bad physics. During early driving I saw a lesson recommend slightly higher nozzle temperature to fight humid-PETG stringing, when the correct move is lower. Schema validation does not catch that. The human reads the plan before it runs.
88
+ - **Multi-tool or multi-material prints** — These were not in the training grid. Expect invented tool-change behavior.
89
+ - **ABS without an enclosure** — The model may propose settings that ignore chamber drafts. The Spine clamps individual values, but it does not model enclosure physics.
90
+ - **Mechanically risky combinations** — Very small layer heights paired with aggressive retraction can pass JSON schema and still fail on the bed. That is why La Forge inspects and the human decides.
91
+ - **No live sensor feedback** — It predicts from precedent and stops. It does not see actual bed adhesion, layer curling, or nozzle state. The printer and the human close the loop.
92
+ - **Single-epoch, low-rank LoRA** — It has not deeply rewritten the base model. Ask it something far from 3D printing and it answers like base Gemma. That is intentional.
93
 
94
+ ## Try it via GGUF (Ollama / llama.cpp)
95
 
96
+ A quantized GGUF of this adapter, merged into the base model, is published as
97
+ [`kylebrodeur/microfactory-node-gguf` · `microfactory-node-v2.gguf`](https://huggingface.co/kylebrodeur/microfactory-node-gguf/blob/main/microfactory-node-v2.gguf)
98
+ (5.1 GB, q4_k_m) and on the public Ollama registry:
99
 
100
+ ```bash
101
+ # Public Ollama registry (one-liner)
102
+ ollama run kylebrodeur/microfactory-node-v2
103
 
104
+ # Direct from HF Hub (template/system/params auto-applied)
105
+ ollama run hf.co/kylebrodeur/microfactory-node-gguf:microfactory-node-v2.gguf
106
+ ```
107
 
108
+ See the
109
+ [full publishing runbook](https://github.com/kylebrodeur/microfactory-node/blob/main/learn/finetune/OLLAMA_PUBLISHING.md)
110
+ for the merge → quantize → upload pipeline and the QAT-trained v3 sibling
111
+ ([`microfactory-node-lora-v3-qat`](https://huggingface.co/kylebrodeur/microfactory-node-lora-v3-qat)).
112
 
113
+ ## License
114
 
115
+ This adapter inherits the [Gemma license](https://ai.google.dev/gemma/terms) from its base model.