thinkoverit commited on
Commit
46adf82
·
verified ·
1 Parent(s): 9648393

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +183 -1
README.md CHANGED
@@ -4,22 +4,82 @@ base_model:
4
  - Ultralytics/YOLO11
5
  pipeline_tag: image-segmentation
6
  ---
 
7
  # Model Card for Model ID
8
 
9
  <!-- Provide a quick summary of what the model is/does. -->
10
 
 
 
 
11
  Segmentation fine tuned model for zebra face detection.
 
12
  ## Model Details
13
 
14
  ### Model Description
15
 
16
  <!-- Provide a longer summary of what this model is. -->
 
17
  This is Yolo11x-seg based fined tuned model
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
18
  ## Uses
19
 
20
  <!-- Address questions around how the model is intended to be used, including the foreseeable users of the model and those affected by the model. -->
 
 
 
 
21
  Model should be used to segment zebra faces from zebra pictures, which can further be used for classification identification purpose.
22
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
23
  ## How to Get Started with the Model
24
 
25
  Use the code below to get started with the model.
@@ -27,6 +87,7 @@ Use the code below to get started with the model.
27
  model = YOLO('yolo11xseg-zebra.pt')
28
 
29
  result = model.predict("<image-path>")
 
30
 
31
  [More Information Needed]
32
 
@@ -36,4 +97,125 @@ Use the code below to get started with the model.
36
 
37
  <!-- 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. -->
38
 
39
- Dataset here - https://universe.roboflow.com/pixel6/face-t7r4g/dataset/12
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
4
  - Ultralytics/YOLO11
5
  pipeline_tag: image-segmentation
6
  ---
7
+
8
  # Model Card for Model ID
9
 
10
  <!-- Provide a quick summary of what the model is/does. -->
11
 
12
+ 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).
13
+
14
+
15
  Segmentation fine tuned model for zebra face detection.
16
+
17
  ## Model Details
18
 
19
  ### Model Description
20
 
21
  <!-- Provide a longer summary of what this model is. -->
22
+
23
  This is Yolo11x-seg based fined tuned model
24
+
25
+ 1) Face Annotated Dataset in YOLO format is used to train YOLO model for face detection
26
+ 2) Trained model is used to crop the face out of all images from classification folder structure dataset.
27
+ 3) Generated classification dataset is manullay reviewed to remove any false detections from datatset.
28
+ 4) New dataset is used for training MobilenNet / Yolo-cls models using fine tuning and transfer learning.
29
+ 5) Fine tuned model is used to indentify the new / test images.
30
+
31
+
32
+ - **Developed by:** [More Information Needed]
33
+ - **Funded by [optional]:** [More Information Needed]
34
+ - **Shared by [optional]:** [More Information Needed]
35
+ - **Model type:** [More Information Needed]
36
+ - **Language(s) (NLP):** [More Information Needed]
37
+ - **License:** [More Information Needed]
38
+ - **Finetuned from model [optional]:** [More Information Needed]
39
+
40
+ ### Model Sources [optional]
41
+
42
+ <!-- Provide the basic links for the model. -->
43
+
44
+ - **Repository:** [More Information Needed]
45
+ - **Paper [optional]:** [More Information Needed]
46
+ - **Demo [optional]:** [More Information Needed]
47
+
48
  ## Uses
49
 
50
  <!-- Address questions around how the model is intended to be used, including the foreseeable users of the model and those affected by the model. -->
51
+
52
+ ### Direct Use
53
+
54
+ <!-- This section is for the model use without fine-tuning or plugging into a larger ecosystem/app. -->
55
  Model should be used to segment zebra faces from zebra pictures, which can further be used for classification identification purpose.
56
 
57
+ [More Information Needed]
58
+
59
+ ### Downstream Use [optional]
60
+
61
+ <!-- This section is for the model use when fine-tuned for a task, or when plugged into a larger ecosystem/app -->
62
+
63
+ [More Information Needed]
64
+
65
+ ### Out-of-Scope Use
66
+
67
+ <!-- This section addresses misuse, malicious use, and uses that the model will not work well for. -->
68
+
69
+ [More Information Needed]
70
+
71
+ ## Bias, Risks, and Limitations
72
+
73
+ <!-- This section is meant to convey both technical and sociotechnical limitations. -->
74
+
75
+ [More Information Needed]
76
+
77
+ ### Recommendations
78
+
79
+ <!-- This section is meant to convey recommendations with respect to the bias, risk, and technical limitations. -->
80
+
81
+ Users (both direct and downstream) should be made aware of the risks, biases and limitations of the model. More information needed for further recommendations.
82
+
83
  ## How to Get Started with the Model
84
 
85
  Use the code below to get started with the model.
 
87
  model = YOLO('yolo11xseg-zebra.pt')
88
 
89
  result = model.predict("<image-path>")
90
+
91
 
92
  [More Information Needed]
93
 
 
97
 
98
  <!-- 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. -->
99
 
100
+ Face annotated Dataset (For step 1) - https://universe.roboflow.com/pixel6/face-t7r4g
101
+
102
+ Face Dataset (For step 4) - https://universe.roboflow.com/pixel6/face-classify-color
103
+
104
+ [More Information Needed]
105
+
106
+ ### Training Procedure
107
+
108
+ <!-- This relates heavily to the Technical Specifications. Content here should link to that section when it is relevant to the training procedure. -->
109
+
110
+ #### Preprocessing [optional]
111
+
112
+ [More Information Needed]
113
+
114
+
115
+ #### Training Hyperparameters
116
+
117
+ - **Training regime:** [More Information Needed] <!--fp32, fp16 mixed precision, bf16 mixed precision, bf16 non-mixed precision, fp16 non-mixed precision, fp8 mixed precision -->
118
+
119
+ #### Speeds, Sizes, Times [optional]
120
+
121
+ <!-- This section provides information about throughput, start/end time, checkpoint size if relevant, etc. -->
122
+
123
+ [More Information Needed]
124
+
125
+ ## Evaluation
126
+
127
+ <!-- This section describes the evaluation protocols and provides the results. -->
128
+
129
+ ### Testing Data, Factors & Metrics
130
+
131
+ #### Testing Data
132
+
133
+ <!-- This should link to a Dataset Card if possible. -->
134
+
135
+ [More Information Needed]
136
+
137
+ #### Factors
138
+
139
+ <!-- These are the things the evaluation is disaggregating by, e.g., subpopulations or domains. -->
140
+
141
+ [More Information Needed]
142
+
143
+ #### Metrics
144
+
145
+ <!-- These are the evaluation metrics being used, ideally with a description of why. -->
146
+
147
+ [More Information Needed]
148
+
149
+ ### Results
150
+
151
+ [More Information Needed]
152
+
153
+ #### Summary
154
+
155
+
156
+
157
+ ## Model Examination [optional]
158
+
159
+ <!-- Relevant interpretability work for the model goes here -->
160
+
161
+ [More Information Needed]
162
+
163
+ ## Environmental Impact
164
+
165
+ <!-- Total emissions (in grams of CO2eq) and additional considerations, such as electricity usage, go here. Edit the suggested text below accordingly -->
166
+
167
+ 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).
168
+
169
+ - **Hardware Type:** [More Information Needed]
170
+ - **Hours used:** [More Information Needed]
171
+ - **Cloud Provider:** [More Information Needed]
172
+ - **Compute Region:** [More Information Needed]
173
+ - **Carbon Emitted:** [More Information Needed]
174
+
175
+ ## Technical Specifications [optional]
176
+
177
+ ### Model Architecture and Objective
178
+
179
+ [More Information Needed]
180
+
181
+ ### Compute Infrastructure
182
+
183
+ [More Information Needed]
184
+
185
+ #### Hardware
186
+
187
+ [More Information Needed]
188
+
189
+ #### Software
190
+
191
+ [More Information Needed]
192
+
193
+ ## Citation [optional]
194
+
195
+ <!-- If there is a paper or blog post introducing the model, the APA and Bibtex information for that should go in this section. -->
196
+
197
+ **BibTeX:**
198
+
199
+ [More Information Needed]
200
+
201
+ **APA:**
202
+
203
+ [More Information Needed]
204
+
205
+ ## Glossary [optional]
206
+
207
+ <!-- If relevant, include terms and calculations in this section that can help readers understand the model or model card. -->
208
+
209
+ [More Information Needed]
210
+
211
+ ## More Information [optional]
212
+
213
+ [More Information Needed]
214
+
215
+ ## Model Card Authors [optional]
216
+
217
+ [More Information Needed]
218
+
219
+ ## Model Card Contact
220
+
221
+ [More Information Needed]