Update README.md


README.md

@@ -1,17 +1,84 @@
 ---
-Title: Grapevine Leaves Image Classification.
-
-Introduction: The model is a simple Image Classification model trained on the 5 types of Grapevine Leaves dataset. It uses the `gradio` SDK to create a simple UI for the Image Classifier of the Grapevine Leaves model.  The model is hosted on the Hugging Face Hub and can be accessed at https://huggingface.co/spaces/jannatulferdaws/amrin_gradio_grapevine. We have taken our dataset from the kaggle dataset https://www.kaggle.com/datasets/muratkokludataset/grapevine-leaves-image-dataset?resource=download. The dataset contains 5 classes of grapevine leaves. The classes are :- Black Rot, Esca (Black Measles), Healthy, Leaf Blight (Isariopsis Leaf Spot), and Leaf Blight (Black Dead Arm). The dataset contains 1000 images of grapevine leaves. The dataset is divided into 80% training set and 20% test set. The model is trained on the training set and tested on the test set. The model is trained for 10 epochs. 
-
-Model architecture: The model is trained on the `MobileNetV2` architecture. MobileNetV2 is a convolutional neural network design aimed at achieving high performance on mobile devices. It adopts an inverted residual structure, featuring residual connections between bottleneck layers. The intermediate expansion layer employs lightweight depthwise convolutions to introduce non-linearity while filtering features. In summary, MobileNetV2 consists of an initial fully convolutional layer with 32 filters, succeeded by 19 residual bottleneck layers.. The model is trained on the `Adam` optimizer with a learning rate of `0.0001`. The model is trained on the `categorical_crossentropy` loss function, `accuracy` metric.  
-
-How to Guide: This is the user interface of the model. We can Select an image from the dropdown menu and click on the `Submit` button or drag and drop an image in the box. The model will classified the image into one of the 5 classes of grapevine leaves. This is the image when the input is given.This is the output of the model. The model has classified the image into the class `Ala_Idris`.
-
-
+Introduction: >-
+  The model is a simple Image Classification model trained on the 5 types of
+  Grapevine Leaves dataset. It uses the `gradio` SDK to create a simple UI for
+  the Image Classifier of the Grapevine Leaves model.  The model is hosted on
+  the Hugging Face Hub and can be accessed at
+  https://huggingface.co/spaces/jannatulferdaws/amrin_gradio_grapevine. We have
+  taken our dataset from the kaggle dataset
+  https://www.kaggle.com/datasets/muratkokludataset/grapevine-leaves-image-dataset?resource=download.
+  The dataset contains 5 classes of grapevine leaves. The classes are :- Black
+  Rot, Esca (Black Measles), Healthy, Leaf Blight (Isariopsis Leaf Spot), and
+  Leaf Blight (Black Dead Arm). The dataset contains 1000 images of grapevine
+  leaves. The dataset is divided into 80% training set and 20% test set. The
+  model is trained on the training set and tested on the test set. The model is
+  trained for 10 epochs.
+Model architecture: >-
+  The model is trained on the `MobileNetV2` architecture. MobileNetV2 is a
+  convolutional neural network design aimed at achieving high performance on
+  mobile devices. It adopts an inverted residual structure, featuring residual
+  connections between bottleneck layers. The intermediate expansion layer
+  employs lightweight depthwise convolutions to introduce non-linearity while
+  filtering features. In summary, MobileNetV2 consists of an initial fully
+  convolutional layer with 32 filters, succeeded by 19 residual bottleneck
+  layers.. The model is trained on the `Adam` optimizer with a learning rate of
+  `0.0001`. The model is trained on the `categorical_crossentropy` loss
+  function, `accuracy` metric.
+How to Guide: >-
+  This is the user interface of the model. We can Select an image from the
+  dropdown menu and click on the `Submit` button or drag and drop an image in
+  the box. The model will classified the image into one of the 5 classes of
+  grapevine leaves. This is the image when the input is given.This is the output
+  of the model. The model has classified the image into the class `Ala_Idris`.
 sdk: gradio
 sdk_version: 4.15.0
 app_file: app.py
 pinned: false
-license: mit 
+license: mit
 Contributor: Jannatul Ferdaws Amrin
----
+language:
+- en
+---
+
+
+# Title:
+ Image Classification of Grapevine Leaves.
+
+## Introduction:
+In this project, we are trying to build a model using **PyTorch**, a powerful deep learning framework, for the image classification of five distinct types of grapevine leaves. Our objective is to harness the flexibility and efficiency of PyTorch to develop a robust neural network model. By training on a dataset of grapevine leaf images, our approach seeks to achieve accurate classification, enabling the differentiation of various grapevine varieties. The dataset contains 5 classes of grapevine leaves. The classes are :- Black Rot, Esca (Black Measles), Healthy, Leaf Blight (Isariopsis Leaf Spot), and Leaf Blight (Black Dead Arm). The dataset contains 1000 images of grapevine leaves. The dataset is divided into 80% training set and 20% test set. The model is trained on the training set and tested on the test set. The model is trained for 10 epochs.  We have taken our dataset from the kaggle dataset https://www.kaggle.com/datasets/muratkokludataset/grapevine-leaves-image-dataset?resource=download. It uses the *gradio* SDK to create a simple UI for the Image Classifier of the Grapevine Leaves model. This exploration not only demonstrates the potential of PyTorch in image classification but also contributes to the advancement of viticulture through enhanced leaf identification capabilities.
+### Model Architecture:
+The model is trained on the `MobileNetV2` architecture. MobileNetV2 is a convolutional neural network design aimed at achieving high performance on mobile devices.  The MobileNetV2 model architecture for image classification of grapevine leaves in PyTorch consists of a series of convolutional layers, batch normalization, and rectified linear unit (ReLU) activations. The key components include depthwise separable convolutions, which enhance efficiency. The model utilizes Inverted Residual blocks, containing a combination of 3x3 depthwise separable convolutions and 1x1 pointwise convolutions. The final layers involve global average pooling and a fully connected layer for classification. The output size of the last linear layer should be adjusted based on the specific number of classes in the grapevine leaves dataset.
+[More Information Needed]
+
+
+## How to Guide:
+
+- **Pre-trained Model:**
+We have trained a model using a deep learning framework 'PyTorch'. Alternatively, you can use a pre-trained model and fine-tune it on your grapevine leaves dataset.
+
+- **Load the Model:**
+We have load the pre-trained model using 'torch.load'.
+
+- **Preprocess Input Image:**
+We have preprocess the input image to match the format expected by the model. It involved resizing, cropping, and normalizing the image.
+
+- **Inference:**
+We have passed the preprocessed image through the model to obtain predictions. The output will be a probability distribution over the different classes.
+
+- **Post-process Results:**
+Depending on the model's architecture, the post-process the results obtained the final classification extracting the class with the highest probability or considering top-k predictions.
+
+- **Display or Use Results:**
+We have used gradio UI library to display the classification results. We can Select an image from the dropdown menu and click on the `Submit` button or drag and drop an image in the box. The model will classified the image into one of the 5 classes of grapevine leaves.
+
+Use the code below to get started with the model.
+https://huggingface.co/spaces/jannatulferdaws/amrin_gradio_grapevine.
+
+
+
+- **Contributor:** : Jannatul Ferdaws Amrin
+- **License:** mit
+- **sdk:** gradio
+- **sdk_version:** 4.15.0
+- **app_file:** app.py
+