Update README.md

README.md

@@ -6,6 +6,9 @@ datasets:
 - imagefolder
 metrics:
 - accuracy
+- f1
+- recall
+- precision
 model-index:
 - name: van-base-Brain_Tumors_Image_Classification
   results:
@@ -22,14 +25,15 @@ model-index:
     - name: Accuracy
       type: accuracy
       value: 0.7918781725888325
+language:
+- en
+pipeline_tag: image-classification
 ---
 
-<!-- This model card has been generated automatically according to the information the Trainer had access to. You
-should probably proofread and complete it, then remove this comment. -->
+<h1>van-base-Brain_Tumors_Image_Classification</h1>
 
-# van-base-Brain_Tumors_Image_Classification
+This model is a fine-tuned version of [Visual-Attention-Network/van-base](https://huggingface.co/Visual-Attention-Network/van-base).
 
-This model is a fine-tuned version of [Visual-Attention-Network/van-base](https://huggingface.co/Visual-Attention-Network/van-base) on the imagefolder dataset.
 It achieves the following results on the evaluation set:
 - Loss: 1.7847
 - Accuracy: 0.7919
@@ -43,17 +47,43 @@ It achieves the following results on the evaluation set:
 - Micro precision: 0.7919
 - Macro precision: 0.8675
 
-## Model description
-
-More information needed
-
-## Intended uses & limitations
-
-More information needed
-
-## Training and evaluation data
-
-More information needed
+<div style="text-align: center;">
+<h2>
+    Model Description
+</h2>
+<a href=“https://github.com/DunnBC22/Vision_Audio_and_Multimodal_Projects/blob/main/Computer%20Vision/Image%20Classification/Multiclass%20Classification/Brain%20Tumors%20Image%20Classification%20Comparison/VAN%20-%20Image%20Classification.ipynb”>
+    Click here for the code that I used to create this model.
+</a>
+
+This project is part of a comparison of seventeen (17) transformers. 
+
+<a href="https://github.com/DunnBC22/Vision_Audio_and_Multimodal_Projects/blob/main/Computer%20Vision/Image%20Classification/Multiclass%20Classification/Brain%20Tumors%20Image%20Classification%20Comparison/README.md">
+    Click here to see the README markdown file for the full project.
+</a>
+<h2>
+    Intended Uses & Limitations
+</h2>
+This model is intended to demonstrate my ability to solve a complex problem using technology.
+
+<h2>
+    Training & Evaluation Data
+</h2>
+<a href="https://www.kaggle.com/datasets/sartajbhuvaji/brain-tumor-classification-mri">
+    Brain Tumor Image Classification Dataset
+</a>
+<h2>
+    Sample Images
+</h2>
+<img src="https://github.com/DunnBC22/Vision_Audio_and_Multimodal_Projects/raw/main/Computer%20Vision/Image%20Classification/Multiclass%20Classification/Brain%20Tumors%20Image%20Classification%20Comparison/Images/Sample%20Images.png" />
+<h2>
+    Class Distribution of Training Dataset
+</h2>
+<img src="https://github.com/DunnBC22/Vision_Audio_and_Multimodal_Projects/raw/main/Computer%20Vision/Image%20Classification/Multiclass%20Classification/Brain%20Tumors%20Image%20Classification%20Comparison/Images/Class%20Distribution%20-%20Training%20Dataset.png"/>
+<h2>
+    Class Distribution of Evaluation Dataset
+</h2>
+<img src="https://github.com/DunnBC22/Vision_Audio_and_Multimodal_Projects/raw/main/Computer%20Vision/Image%20Classification/Multiclass%20Classification/Brain%20Tumors%20Image%20Classification%20Comparison/Images/Class%20Distribution%20-%20Testing%20Dataset.png"/>
+</div>
 
 ## Training procedure
 
@@ -76,10 +106,9 @@ The following hyperparameters were used during training:
 | 1.3357        | 2.0   | 360  | 1.9359          | 0.7792   | 0.7314      | 0.7792   | 0.7411   | 0.7792          | 0.7792       | 0.7764       | 0.8467             | 0.7792          | 0.8636          |
 | 0.1229        | 3.0   | 540  | 1.7847          | 0.7919   | 0.7588      | 0.7919   | 0.7665   | 0.7919          | 0.7919       | 0.7865       | 0.8505             | 0.7919          | 0.8675          |
 
-
 ### Framework versions
 
 - Transformers 4.28.1
 - Pytorch 2.0.0
 - Datasets 2.11.0
-- Tokenizers 0.13.3
+- Tokenizers 0.13.3