Update README.md
Browse files
README.md
CHANGED
|
@@ -1,199 +1,98 @@
|
|
| 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 |
-
|
|
|
|
|
|
|
|
|
|
| 83 |
|
| 84 |
-
|
| 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 |
-
|
| 148 |
-
- **
|
| 149 |
-
- **
|
| 150 |
-
- **Compute Region:** [More Information Needed]
|
| 151 |
-
- **Carbon Emitted:** [More Information Needed]
|
| 152 |
|
| 153 |
-
|
| 154 |
|
| 155 |
-
|
| 156 |
|
| 157 |
-
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 158 |
|
| 159 |
-
|
| 160 |
|
| 161 |
-
|
| 162 |
|
| 163 |
-
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 164 |
|
| 165 |
-
|
| 166 |
|
| 167 |
-
|
| 168 |
|
| 169 |
-
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 170 |
|
| 171 |
-
|
| 172 |
|
| 173 |
-
|
| 174 |
|
| 175 |
-
**BibTeX:**
|
| 176 |
|
| 177 |
-
|
|
|
|
| 178 |
|
| 179 |
-
|
| 180 |
|
| 181 |
-
|
| 182 |
|
| 183 |
-
|
| 184 |
|
| 185 |
-
|
| 186 |
|
| 187 |
-
|
| 188 |
|
| 189 |
-
|
|
|
|
| 190 |
|
| 191 |
-
|
|
|
|
| 192 |
|
| 193 |
-
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 194 |
|
| 195 |
-
|
| 196 |
|
| 197 |
-
|
| 198 |
|
| 199 |
-
|
|
|
|
| 1 |
+
# 🌿 Plant Identification ViT (Fine-Tuned by Kelvin jackson (DRROBOT))
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 2 |
|
| 3 |
+
**Base Model:** [`marwaALzaabi/plant-identification-vit`](https://huggingface.co/marwaALzaabi/plant-identification-vit)
|
| 4 |
+
**Fine-Tuned On:** [Kaggle – House Plant Species Dataset](https://www.kaggle.com/datasets/jonasnevers/house-plant-species)
|
| 5 |
+
**Developed By:** [Kelvin Nnadi](https://huggingface.co/your-username)
|
| 6 |
+
**Objective:** To build a high-accuracy computer vision model that can identify and describe a wide range of houseplants, forming the perception layer of a larger AI botanist system.
|
| 7 |
|
| 8 |
+
---
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 9 |
|
| 10 |
+
## 🧠 Model Summary
|
| 11 |
+
This model is a **fine-tuned Vision Transformer (ViT)** specialized for **plant species recognition**.
|
| 12 |
+
It was trained on **14,790 high-quality images** covering **47 distinct houseplant species**, improving the model’s ability to handle real-world lighting, angles, and background variation.
|
|
|
|
|
|
|
| 13 |
|
| 14 |
+
The model forms the **visual foundation** of an intelligent AI system that integrates with **Qwen Instruct** for reasoning, allowing users to snap or upload plant photos and receive detailed botanical explanations.
|
| 15 |
|
| 16 |
+
---
|
| 17 |
|
| 18 |
+
## ⚙️ Training Details
|
| 19 |
+
|
| 20 |
+
| Parameter | Value |
|
| 21 |
+
|------------|--------|
|
| 22 |
+
| **Base Model** | `marwaALzaabi/plant-identification-vit` |
|
| 23 |
+
| **Dataset** | Kaggle House Plant Species (~14.8k images, 47 classes) |
|
| 24 |
+
| **Epochs** | 5 |
|
| 25 |
+
| **Batch Size** | 16 |
|
| 26 |
+
| **Optimizer** | AdamW |
|
| 27 |
+
| **Learning Rate** | 5e-5 |
|
| 28 |
+
| **Scheduler** | Cosine Annealing |
|
| 29 |
+
| **Hardware** | NVIDIA T4 GPU (Colab Pro+) |
|
| 30 |
+
| **Mixed Precision** | FP16 enabled |
|
| 31 |
+
| **Framework** | Hugging Face Transformers + PyTorch |
|
| 32 |
|
| 33 |
+
---
|
| 34 |
|
| 35 |
+
## 📈 Performance Metrics
|
| 36 |
|
| 37 |
+
| Metric | Value |
|
| 38 |
+
|---------|-------|
|
| 39 |
+
| **Training Loss (Final)** | 0.0010 |
|
| 40 |
+
| **Validation Loss (Final)** | 0.2161 |
|
| 41 |
+
| **Best Validation Epoch** | 5 |
|
| 42 |
+
| **Global Training Loss** | 0.1849 |
|
| 43 |
+
| **Steps** | 8,320 |
|
| 44 |
+
| **Samples/Sec** | 7.75 |
|
| 45 |
+
| **Steps/Sec** | 0.969 |
|
| 46 |
|
| 47 |
+
The model achieved **remarkably low loss** and stable convergence, indicating excellent generalization to unseen plant images.
|
| 48 |
|
| 49 |
+
---
|
| 50 |
|
| 51 |
+
## 🌱 Intended Use
|
| 52 |
+
This model can be used for:
|
| 53 |
+
- 📸 **Real-time plant species recognition** from photos
|
| 54 |
+
- 🌿 **Agricultural or botanical assistant systems** (e.g., Farmlingua or AI Botanist)
|
| 55 |
+
- 🧠 **Educational tools** for plant taxonomy learning
|
| 56 |
+
- 🪴 **Smart garden applications** with vision intelligence
|
| 57 |
|
| 58 |
+
It can also be **paired with a text-based reasoning model** like to provide rich, natural language explanations about plant care, origin, and characteristics.
|
| 59 |
|
| 60 |
+
---
|
| 61 |
|
|
|
|
| 62 |
|
| 63 |
+
🧩 Model Architecture
|
| 64 |
+
Type: Vision Transformer (ViT)
|
| 65 |
|
| 66 |
+
Patch Size: 16x16
|
| 67 |
|
| 68 |
+
Embedding Dimension: 768
|
| 69 |
|
| 70 |
+
Heads: 12
|
| 71 |
|
| 72 |
+
Depth: 12
|
| 73 |
|
| 74 |
+
Fine-tuning Method: Full fine-tuning (not LoRA)
|
| 75 |
|
| 76 |
+
⚖️ License
|
| 77 |
+
This model is released under the Apache 2.0 License, allowing both commercial and research use with attribution.
|
| 78 |
|
| 79 |
+
💬 Citation
|
| 80 |
+
If you use this model, please cite:
|
| 81 |
|
| 82 |
+
java
|
| 83 |
+
Copy code
|
| 84 |
+
@model{kelvinnnadi_plant_vit_2025,
|
| 85 |
+
title={Plant Identification ViT (Fine-Tuned)},
|
| 86 |
+
author={Kelvin Nnadi},
|
| 87 |
+
year={2025},
|
| 88 |
+
howpublished={Hugging Face},
|
| 89 |
+
url={https://huggingface.co/your-username/plant-identification-vit-finetuned}
|
| 90 |
+
}
|
| 91 |
+
🏆 Highlights
|
| 92 |
+
Fine-tuned with 47 classes of houseplants
|
| 93 |
|
| 94 |
+
Highly generalized on real-world photos
|
| 95 |
|
| 96 |
+
Seamlessly integrates with multimodal LLMs
|
| 97 |
|
| 98 |
+
Production-grade architecture suitable for cloud APIs
|