Update README.md

README.md

@@ -10,195 +10,83 @@ base_model:
 ---
 # Model Card for Model ID
 
-<!-- Provide a quick summary of what the model is/does. -->
-
-This modelcard aims to be a base template for new models. It has been generated using [this raw template](https://github.com/huggingface/huggingface_hub/blob/main/src/huggingface_hub/templates/modelcard_template.md?plain=1).
+This repository contains FCN and FPN models trained using the split_open strategy from [SeaTurtleID2022](https://www.kaggle.com/datasets/wildlifedatasets/seaturtleid2022). The models have been uploaded to facilitate evaluation and review by the supervisor.
 
 ## Model Details
 
 ### Model Description
 
-<!-- Provide a longer summary of what this model is. -->
-
-
-
-- **Developed by:** [More Information Needed]
-- **Funded by [optional]:** [More Information Needed]
-- **Shared by [optional]:** [More Information Needed]
-- **Model type:** [More Information Needed]
-- **Language(s) (NLP):** [More Information Needed]
-- **License:** [More Information Needed]
-- **Finetuned from model [optional]:** [More Information Needed]
+- **Developed by:** Jinghan Wang
+- **Language(s) (NLP):** English
+- **License:** MIT
 
 ### Model Sources [optional]
 
-<!-- Provide the basic links for the model. -->
-
-- **Repository:** [More Information Needed]
-- **Paper [optional]:** [More Information Needed]
-- **Demo [optional]:** [More Information Needed]
-
+- **FPN**: [Segmentation Models Pytorch](https://segmentation-modelspytorch.readthedocs.io/en/latest/docs/api.html#fpn)
+- **FCN:** [Pytorch](https://pytorch.org/vision/main/models/generated/torchvision.models.segmentation.fcn_resnet101.html#fcn-resnet101)
+- 
 ## Uses
 
-<!-- Address questions around how the model is intended to be used, including the foreseeable users of the model and those affected by the model. -->
-
-### Direct Use
-
-<!-- This section is for the model use without fine-tuning or plugging into a larger ecosystem/app. -->
-
-[More Information Needed]
-
-### Downstream Use [optional]
-
-<!-- This section is for the model use when fine-tuned for a task, or when plugged into a larger ecosystem/app -->
-
-[More Information Needed]
-
-### Out-of-Scope Use
-
-<!-- This section addresses misuse, malicious use, and uses that the model will not work well for. -->
-
-[More Information Needed]
-
-## Bias, Risks, and Limitations
-
-<!-- This section is meant to convey both technical and sociotechnical limitations. -->
-
-[More Information Needed]
-
-### Recommendations
-
-<!-- This section is meant to convey recommendations with respect to the bias, risk, and technical limitations. -->
-
-Users (both direct and downstream) should be made aware of the risks, biases and limitations of the model. More information needed for further recommendations.
-
-## How to Get Started with the Model
-
-Use the code below to get started with the model.
-
-[More Information Needed]
+These models have been uploaded to facilitate review and evaluation for the COMP9517 Computer Vision project assignment at the University of New South Wales, T3 2024 semester.
 
 ## Training Details
 
 ### Training Data
 
-<!-- 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. -->
-
-[More Information Needed]
-
-### Training Procedure
-
-<!-- This relates heavily to the Technical Specifications. Content here should link to that section when it is relevant to the training procedure. -->
-
-#### Preprocessing [optional]
-
-[More Information Needed]
-
-
-#### Training Hyperparameters
-
-- **Training regime:** [More Information Needed] <!--fp32, fp16 mixed precision, bf16 mixed precision, bf16 non-mixed precision, fp16 non-mixed precision, fp8 mixed precision -->
-
-#### Speeds, Sizes, Times [optional]
+[SeaTurtleID2022](https://www.kaggle.com/datasets/wildlifedatasets/seaturtleid2022)
+`split_open: 'train'`
 
-<!-- This section provides information about throughput, start/end time, checkpoint size if relevant, etc. -->
+### Valid Data
 
-[More Information Needed]
+[SeaTurtleID2022](https://www.kaggle.com/datasets/wildlifedatasets/seaturtleid2022)
+`split_open: 'valid'`
 
-## Evaluation
-
-<!-- This section describes the evaluation protocols and provides the results. -->
 
 ### Testing Data, Factors & Metrics
 
 #### Testing Data
 
-<!-- This should link to a Dataset Card if possible. -->
-
-[More Information Needed]
-
-#### Factors
-
-<!-- These are the things the evaluation is disaggregating by, e.g., subpopulations or domains. -->
+[SeaTurtleID2022](https://www.kaggle.com/datasets/wildlifedatasets/seaturtleid2022)
+`split_open: 'test'`
 
-[More Information Needed]
 
-#### Metrics
-
-<!-- These are the evaluation metrics being used, ideally with a description of why. -->
+## Evaluation
+```
+FCN (Resnet101)
+  Mean IoU: 0.9039
+  Mean Accuracy: 0.9458
 
-[More Information Needed]
+  Mean IoU of backdrop: 0.9932
+  Mean Accuracy of backdrop: 0.9963
 
-### Results
+  Mean IoU of turtle: 0.9225
+  Mean Accuracy of turtle: 0.9713
 
-[More Information Needed]
+  Mean IoU of flipper: 0.8351
+  Mean Accuracy of flipper: 0.8940
 
-#### Summary
+  Mean IoU of head: 0.8649
+  Mean Accuracy of head: 0.9215
+```
 
+```
+FPN (Resnet152):
+  Mean IoU: 0.9042
+  Mean Accuracy: 0.9440
 
+  Mean IoU of backdrop: 0.9933
+  Mean Accuracy of backdrop: 0.9966
 
-## Model Examination [optional]
+  Mean IoU of turtle: 0.9242
+  Mean Accuracy of turtle: 0.9708
 
-<!-- Relevant interpretability work for the model goes here -->
+  Mean IoU of flipper: 0.8317
+  Mean Accuracy of flipper: 0.8899
 
-[More Information Needed]
+  Mean IoU of head: 0.8677
+  Mean Accuracy of head: 0.9187
+```
 
 ## Environmental Impact
 
-<!-- Total emissions (in grams of CO2eq) and additional considerations, such as electricity usage, go here. Edit the suggested text below accordingly -->
-
-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).
-
-- **Hardware Type:** [More Information Needed]
-- **Hours used:** [More Information Needed]
-- **Cloud Provider:** [More Information Needed]
-- **Compute Region:** [More Information Needed]
-- **Carbon Emitted:** [More Information Needed]
-
-## Technical Specifications [optional]
-
-### Model Architecture and Objective
-
-[More Information Needed]
-
-### Compute Infrastructure
-
-[More Information Needed]
-
-#### Hardware
-
-[More Information Needed]
-
-#### Software
-
-[More Information Needed]
-
-## Citation [optional]
-
-<!-- If there is a paper or blog post introducing the model, the APA and Bibtex information for that should go in this section. -->
-
-**BibTeX:**
-
-[More Information Needed]
-
-**APA:**
-
-[More Information Needed]
-
-## Glossary [optional]
-
-<!-- If relevant, include terms and calculations in this section that can help readers understand the model or model card. -->
-
-[More Information Needed]
-
-## More Information [optional]
-
-[More Information Needed]
-
-## Model Card Authors [optional]
-
-[More Information Needed]
-
-## Model Card Contact
-
-[More Information Needed]
+- **Cloud Provider:** [Colab](https://colab.research.google.com/)