Bimokuncoro commited on
Commit
37328ae
·
verified ·
1 Parent(s): d7dd47b

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +103 -189
README.md CHANGED
@@ -1,200 +1,114 @@
1
  ---
2
- library_name: transformers
 
3
  tags:
4
- - unsloth
 
 
 
 
 
 
5
  ---
6
 
7
- # Model Card for Model ID
8
 
9
- <!-- Provide a quick summary of what the model is/does. -->
 
10
 
 
11
 
 
 
 
12
 
13
- ## Model Details
14
-
15
- ### Model Description
16
-
17
- <!-- Provide a longer summary of what this model is. -->
18
-
19
- This is the model card of a 🤗 transformers model that has been pushed on the Hub. This model card has been automatically generated.
20
-
21
- - **Developed by:** [More Information Needed]
22
- - **Funded by [optional]:** [More Information Needed]
23
- - **Shared by [optional]:** [More Information Needed]
24
- - **Model type:** [More Information Needed]
25
- - **Language(s) (NLP):** [More Information Needed]
26
- - **License:** [More Information Needed]
27
- - **Finetuned from model [optional]:** [More Information Needed]
28
-
29
- ### Model Sources [optional]
30
-
31
- <!-- Provide the basic links for the model. -->
32
-
33
- - **Repository:** [More Information Needed]
34
- - **Paper [optional]:** [More Information Needed]
35
- - **Demo [optional]:** [More Information Needed]
36
-
37
- ## Uses
38
-
39
- <!-- Address questions around how the model is intended to be used, including the foreseeable users of the model and those affected by the model. -->
40
-
41
- ### Direct Use
42
-
43
- <!-- This section is for the model use without fine-tuning or plugging into a larger ecosystem/app. -->
44
-
45
- [More Information Needed]
46
-
47
- ### Downstream Use [optional]
48
-
49
- <!-- This section is for the model use when fine-tuned for a task, or when plugged into a larger ecosystem/app -->
50
-
51
- [More Information Needed]
52
-
53
- ### Out-of-Scope Use
54
-
55
- <!-- This section addresses misuse, malicious use, and uses that the model will not work well for. -->
56
-
57
- [More Information Needed]
58
-
59
- ## Bias, Risks, and Limitations
60
-
61
- <!-- This section is meant to convey both technical and sociotechnical limitations. -->
62
-
63
- [More Information Needed]
64
-
65
- ### Recommendations
66
-
67
- <!-- This section is meant to convey recommendations with respect to the bias, risk, and technical limitations. -->
68
-
69
- Users (both direct and downstream) should be made aware of the risks, biases and limitations of the model. More information needed for further recommendations.
70
-
71
- ## How to Get Started with the Model
72
-
73
- Use the code below to get started with the model.
74
-
75
- [More Information Needed]
76
 
77
  ## Training Details
78
 
79
- ### Training Data
80
-
81
- <!-- 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. -->
82
-
83
- [More Information Needed]
84
-
85
- ### Training Procedure
86
-
87
- <!-- This relates heavily to the Technical Specifications. Content here should link to that section when it is relevant to the training procedure. -->
88
-
89
- #### Preprocessing [optional]
90
-
91
- [More Information Needed]
92
-
93
-
94
- #### Training Hyperparameters
95
-
96
- - **Training regime:** [More Information Needed] <!--fp32, fp16 mixed precision, bf16 mixed precision, bf16 non-mixed precision, fp16 non-mixed precision, fp8 mixed precision -->
97
-
98
- #### Speeds, Sizes, Times [optional]
99
-
100
- <!-- This section provides information about throughput, start/end time, checkpoint size if relevant, etc. -->
101
-
102
- [More Information Needed]
103
-
104
- ## Evaluation
105
-
106
- <!-- This section describes the evaluation protocols and provides the results. -->
107
-
108
- ### Testing Data, Factors & Metrics
109
-
110
- #### Testing Data
111
-
112
- <!-- This should link to a Dataset Card if possible. -->
113
-
114
- [More Information Needed]
115
-
116
- #### Factors
117
-
118
- <!-- These are the things the evaluation is disaggregating by, e.g., subpopulations or domains. -->
119
-
120
- [More Information Needed]
121
-
122
- #### Metrics
123
-
124
- <!-- These are the evaluation metrics being used, ideally with a description of why. -->
125
-
126
- [More Information Needed]
127
-
128
- ### Results
129
-
130
- [More Information Needed]
131
-
132
- #### Summary
133
-
134
-
135
-
136
- ## Model Examination [optional]
137
-
138
- <!-- Relevant interpretability work for the model goes here -->
139
-
140
- [More Information Needed]
141
-
142
- ## Environmental Impact
143
-
144
- <!-- Total emissions (in grams of CO2eq) and additional considerations, such as electricity usage, go here. Edit the suggested text below accordingly -->
145
-
146
- 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).
147
-
148
- - **Hardware Type:** [More Information Needed]
149
- - **Hours used:** [More Information Needed]
150
- - **Cloud Provider:** [More Information Needed]
151
- - **Compute Region:** [More Information Needed]
152
- - **Carbon Emitted:** [More Information Needed]
153
-
154
- ## Technical Specifications [optional]
155
-
156
- ### Model Architecture and Objective
157
-
158
- [More Information Needed]
159
-
160
- ### Compute Infrastructure
161
-
162
- [More Information Needed]
163
-
164
- #### Hardware
165
-
166
- [More Information Needed]
167
-
168
- #### Software
169
-
170
- [More Information Needed]
171
-
172
- ## Citation [optional]
173
-
174
- <!-- If there is a paper or blog post introducing the model, the APA and Bibtex information for that should go in this section. -->
175
-
176
- **BibTeX:**
177
-
178
- [More Information Needed]
179
-
180
- **APA:**
181
-
182
- [More Information Needed]
183
-
184
- ## Glossary [optional]
185
-
186
- <!-- If relevant, include terms and calculations in this section that can help readers understand the model or model card. -->
187
-
188
- [More Information Needed]
189
-
190
- ## More Information [optional]
191
-
192
- [More Information Needed]
193
-
194
- ## Model Card Authors [optional]
195
-
196
- [More Information Needed]
197
-
198
- ## Model Card Contact
199
-
200
- [More Information Needed]
 
1
  ---
2
+ base_model: google/medgemma-4b-it
3
+ library_name: peft
4
  tags:
5
+ - medical
6
+ - vision-language
7
+ - histopathology
8
+ - colorectal-cancer
9
+ - lora
10
+ - unsloth
11
+ license: apache-2.0
12
  ---
13
 
14
+ # MedGemma 4B CRC Tissue Classification (Fine-tuned)
15
 
16
+ Fine-tuned version of [MedGemma 4B](https://huggingface.co/google/medgemma-4b-it)
17
+ for 9-class colorectal cancer tissue classification from H&E stained histological images.
18
 
19
+ ## Model Description
20
 
21
+ This model was fine-tuned using LoRA on the
22
+ [NCT-CRC-HE-100K](https://huggingface.co/datasets/1aurent/NCT-CRC-HE) dataset
23
+ to classify colorectal tissue patches into 9 classes:
24
 
25
+ | Label | Tissue Type |
26
+ |---|---|
27
+ | ADI | Adipose |
28
+ | BACK | Background |
29
+ | DEB | Debris |
30
+ | LYM | Lymphocytes |
31
+ | MUC | Mucus |
32
+ | MUS | Smooth Muscle |
33
+ | NORM | Normal Colon Mucosa |
34
+ | STR | Cancer-Associated Stroma |
35
+ | TUM | Colorectal Adenocarcinoma Epithelium |
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
36
 
37
  ## Training Details
38
 
39
+ | Parameter | Value |
40
+ |---|---|
41
+ | Base model | unsloth/medgemma-4b-it (full 16-bit) |
42
+ | Fine-tuning method | LoRA (r=16, alpha=16, all-linear) |
43
+ | Trainable parameters | 38,497,792 / 4,338,577,264 (0.89%) |
44
+ | Training samples | 9,000 from NCT-CRC-HE-100K |
45
+ | Steps | 300 (epoch = 0.267) |
46
+ | Batch size | 4 per device, grad accum 2 (effective = 8) |
47
+ | Learning rate | 2e-4 with cosine scheduler |
48
+ | Optimizer | AdamW (fused) |
49
+ | Hardware | NVIDIA A100-SXM4-80GB |
50
+ | Training time | ~21 minutes |
51
+ | Final training loss | 0.2072 |
52
+
53
+ ## Evaluation Results
54
+
55
+ Evaluated on 500 randomly sampled images (seed=42) from each dataset:
56
+
57
+ | Model | Dataset | Accuracy | Weighted F1 |
58
+ |---|---|---|---|
59
+ | Pretrained MedGemma | NCT-CRC-HE-100K (test) | 19.4% | 0.163 |
60
+ | **Fine-tuned (Ours)** | NCT-CRC-HE-100K (test) | **94.2%** | **0.943** |
61
+ | Pretrained MedGemma | CRC-VAL-HE-7K | 17.4% | 0.147 |
62
+ | **Fine-tuned (Ours)** | CRC-VAL-HE-7K | **94.8%** | **0.948** |
63
+
64
+ ## How to Use
65
+ ```python
66
+ from unsloth import FastVisionModel
67
+ from peft import PeftModel
68
+ import torch
69
+
70
+ # Load base model + adapter
71
+ model, processor = FastVisionModel.from_pretrained(
72
+ "unsloth/medgemma-4b-it",
73
+ load_in_4bit=False,
74
+ )
75
+ model = PeftModel.from_pretrained(model, "Bimokuncoro/medgemma-4b-crc-finetuned")
76
+ FastVisionModel.for_inference(model)
77
+
78
+ # Run inference
79
+ from PIL import Image
80
+ image = Image.open("your_tissue_image.png")
81
+ messages = [{
82
+ "role": "user",
83
+ "content": [
84
+ {"type": "image", "image": image},
85
+ {"type": "text", "text": "What type of tissue is shown in this histological image?
86
+ Reply with ONLY one word from this list: ADI, BACK, DEB, LYM, MUC, MUS, NORM, STR, TUM.
87
+ Do not explain."}
88
+ ]
89
+ }]
90
+ input_text = processor.tokenizer.apply_chat_template(
91
+ messages, add_generation_prompt=True, tokenize=False
92
+ )
93
+ inputs = processor(images=image, text=input_text,
94
+ add_special_tokens=False, return_tensors="pt").to("cuda")
95
+ input_length = inputs["input_ids"].shape[1]
96
+ with torch.no_grad():
97
+ out = model.generate(**inputs, max_new_tokens=50, use_cache=True)
98
+ new_tokens = out[0][input_length:]
99
+ result = processor.tokenizer.decode(new_tokens, skip_special_tokens=True).strip()
100
+ print(result) # e.g. "TUM"
101
+ ```
102
+
103
+ ## Dataset
104
+
105
+ - **Training:** [1aurent/NCT-CRC-HE](https://huggingface.co/datasets/1aurent/NCT-CRC-HE),
106
+ split `NCT_CRC_HE_100K`, 9,000 samples
107
+ - **Evaluation A:** Same dataset, held-out test split, 500 samples
108
+ - **Evaluation B:** Split `CRC_VAL_HE_7K`, 500 samples (never seen during training)
109
+
110
+ ## Citation / Acknowledgements
111
+
112
+ - Base model: [Google MedGemma](https://huggingface.co/google/medgemma-4b-it)
113
+ - Fine-tuning framework: [Unsloth](https://github.com/unslothai/unsloth)
114
+ - Dataset: [NCT-CRC-HE by 1aurent](https://huggingface.co/datasets/1aurent/NCT-CRC-HE)