Reducing modelcard size template

README.md

@@ -1,7 +1,6 @@
 ---
 language: en
-library_name: keras
-license: mit
+license: cc-by-nc-4.0
 ---
 
 # Model Card for yolo5_beachbot_160
@@ -19,54 +18,34 @@ license: mit
 A finetune of Yolo5 intended for identifying beach trash.
 
 - **Developed by:** Jeffrey Queisser, Christopher Buckley
-- **Funded by [optional]:** Okinawa Institute of Science and Technology COI Next Grant
-- **Shared by [optional]:** [More Information Needed]
+- **Funded by:** Okinawa Institute of Science and Technology COI Next Grant
 - **Model type:** Yolo5
-- **Language(s) (NLP):** en
 - **License:** CC BY-NC 4.0
-- **Finetuned from model [optional]:** Yolo5
+- **Finetuned from model:** Yolo5
 
-### Model Sources [optional]
+### Model Sources
 
 <!-- Provide the basic links for the model. -->
 
 - **Repository:** https://github.com/okinawa-ai-beach-robot/yolo5_beachbot_160
-- **Paper [optional]:** [More Information Needed]
-- **Demo [optional]:** [More Information Needed]
-
-## 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]
+- **Demo:** [Work in Progress]
 
 ## Bias, Risks, and Limitations
 
 <!-- This section is meant to convey both technical and sociotechnical limitations. -->
 
-[More Information Needed]
+
+        Note the dataset is small and test set can have quite similar images to the train set. 
+        This was an early version of the dataset so results are not reliable
+        
 
 ### 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.
+
+        Use later version of the dataset
+        
 
 ## How to Get Started with the Model
 
@@ -86,25 +65,19 @@ https://universe.roboflow.com/okinawaaibeachrobot/beach-cleaning-object-detectio
 
 <!-- This relates heavily to the Technical Specifications. Content here should link to that section when it is relevant to the training procedure. -->
 
-#### Preprocessing [optional]
+#### Preprocessing
 
 
-    {'preprocessing': {'auto-orient': True, 'resize': {'width': 1280, 'height': 800, 'format': 'Fill (with center crop) in'}}}
-    See https://docs.roboflow.com/api-reference/versions/create-a-project-version for more information
-    
+        {'preprocessing': {'auto-orient': True, 'resize': {'width': 1280, 'height': 800, 'format': 'Fill (with center crop) in'}}}
+        See https://docs.roboflow.com/api-reference/versions/create-a-project-version for more information
+        
 
 
 #### Training Hyperparameters
 
 - **Training regime:** 
-    TODO populate with any hyperparameters
-     <!--fp32, fp16 mixed precision, bf16 mixed precision, bf16 non-mixed precision, fp16 non-mixed precision, fp8 mixed precision -->
-
-#### Speeds, Sizes, Times [optional]
-
-<!-- This section provides information about throughput, start/end time, checkpoint size if relevant, etc. -->
-
-[More Information Needed]
+        TODO populate with any hyperparameters
+         <!--fp32, fp16 mixed precision, bf16 mixed precision, bf16 non-mixed precision, fp16 non-mixed precision, fp8 mixed precision -->
 
 ## Evaluation
 
@@ -118,92 +91,24 @@ https://universe.roboflow.com/okinawaaibeachrobot/beach-cleaning-object-detectio
 
 https://universe.roboflow.com/okinawaaibeachrobot/beach-cleaning-object-detection/dataset/1/images?split=test
 
-#### Factors
-
-<!-- These are the things the evaluation is disaggregating by, e.g., subpopulations or domains. -->
-
-[More Information Needed]
-
 #### Metrics
 
 <!-- These are the evaluation metrics being used, ideally with a description of why. -->
 
 
-    TODO populate with any metrics
-    e.g. loss function
-    
+        TODO populate with any metrics
+        e.g. loss function
+        
 
 ### Results
 
 
-    TODO populate with any results
-    
-
-#### Summary
-
-
-    TODO
-    
-
-## Model Examination [optional]
-
-<!-- Relevant interpretability work for the model goes here -->
-
-[More Information Needed]
+        TODO populate with any results
+        
 
-## 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:** TODO
-- **Hours used:** TODO
-- **Cloud Provider:** TODO
-- **Compute Region:** TODO
-- **Carbon Emitted:** TODO
-
-## 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]
+## Technical Specifications
 
-## Model Card Authors [optional]
+## Model Card Authors
 
 Christopher Buckley