Upload README.md with huggingface_hub

#2
by nateraw - opened
Files changed (1) hide show
  1. README.md +208 -0
README.md ADDED
@@ -0,0 +1,208 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ ---
2
+ language: en
3
+ license: mit
4
+ library_name: pytorch
5
+ tags:
6
+ - object-detection
7
+ - yolo
8
+ - autogenerated-modelcard
9
+ model_name: yolov6s
10
+ ---
11
+
12
+ # Model Card for yolov6s
13
+
14
+ <!-- Provide a quick summary of what the model is/does. -->
15
+
16
+ # Table of Contents
17
+
18
+ 1. [Model Details](#model-details)
19
+ 2. [Uses](#uses)
20
+ 3. [Bias, Risks, and Limitations](#bias-risks-and-limitations)
21
+ 4. [Training Details](#training-details)
22
+ 5. [Evaluation](#evaluation)
23
+ 6. [Model Examination](#model-examination)
24
+ 7. [Environmental Impact](#environmental-impact)
25
+ 8. [Technical Specifications](#technical-specifications-optional)
26
+ 9. [Citation](#citation)
27
+ 10. [Glossary](#glossary-optional)
28
+ 11. [More Information](#more-information-optional)
29
+ 12. [Model Card Authors](#model-card-authors-optional)
30
+ 13. [Model Card Contact](#model-card-contact)
31
+ 14. [How To Get Started With the Model](#how-to-get-started-with-the-model)
32
+
33
+
34
+ # Model Details
35
+
36
+ ## Model Description
37
+
38
+ <!-- Provide a longer summary of what this model is. -->
39
+
40
+ YOLOv6 is a single-stage object detection framework dedicated to industrial applications, with hardware-friendly efficient design and high performance.
41
+
42
+ - **Developed by:** [More Information Needed]
43
+ - **Shared by [Optional]:** [@nateraw](https://hf.co/nateraw)
44
+ - **Model type:** [More Information Needed]
45
+ - **Language(s) (NLP):** [More Information Needed]
46
+ - **License:** [More Information Needed]
47
+ - **Related Models:** [yolov6t](https://hf.co/nateraw/yolov6t), [yolov6n](https://hf.co/nateraw/yolov6n)
48
+ - **Parent Model:** N/A
49
+ - **Resources for more information:** The [official GitHub Repository](https://github.com/meituan/YOLOv6)
50
+
51
+ # Uses
52
+
53
+ <!-- Address questions around how the model is intended to be used, including the foreseeable users of the model and those affected by the model. -->
54
+
55
+ ## Direct Use
56
+
57
+ <!-- This section is for the model use without fine-tuning or plugging into a larger ecosystem/app. -->
58
+
59
+ This model is meant to be used as a general object detector.
60
+
61
+ ## Downstream Use [Optional]
62
+
63
+ <!-- This section is for the model use when fine-tuned for a task, or when plugged into a larger ecosystem/app -->
64
+
65
+ You can fine-tune this model for your specific task
66
+
67
+ ## Out-of-Scope Use
68
+
69
+ <!-- This section addresses misuse, malicious use, and uses that the model will not work well for. -->
70
+
71
+ Don't be evil.
72
+
73
+ # Bias, Risks, and Limitations
74
+
75
+ <!-- This section is meant to convey both technical and sociotechnical limitations. -->
76
+
77
+ This model often classifies objects incorrectly, especially when applied to videos. It does not handle crowds very well.
78
+
79
+ ## Recommendations
80
+
81
+ <!-- This section is meant to convey recommendations with respect to the bias, risk, and technical limitations. -->
82
+
83
+ Users (both direct and downstream) should be made aware of the risks, biases and limitations of the model. More information needed for further recomendations.
84
+
85
+ # Training Details
86
+
87
+ ## Training Data
88
+
89
+ <!-- This should link to a Data 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. -->
90
+
91
+ [More Information Needed]
92
+
93
+ ## Training Procedure
94
+
95
+ <!-- This relates heavily to the Technical Specifications. Content here should link to that section when it is relevant to the training procedure. -->
96
+
97
+ ### Preprocessing
98
+
99
+ [More Information Needed]
100
+
101
+ ### Speeds, Sizes, Times
102
+
103
+ <!-- This section provides information about throughput, start/end time, checkpoint size if relevant, etc. -->
104
+
105
+ [More Information Needed]
106
+
107
+ # Evaluation
108
+
109
+ <!-- This section describes the evaluation protocols and provides the results. -->
110
+
111
+ ## Testing Data, Factors & Metrics
112
+
113
+ ### Testing Data
114
+
115
+ <!-- This should link to a Data Card if possible. -->
116
+
117
+ [More Information Needed]
118
+
119
+ ### Factors
120
+
121
+ <!-- These are the things the evaluation is disaggregating by, e.g., subpopulations or domains. -->
122
+
123
+ [More Information Needed]
124
+
125
+ ### Metrics
126
+
127
+ <!-- These are the evaluation metrics being used, ideally with a description of why. -->
128
+
129
+ [More Information Needed]
130
+
131
+ ## Results
132
+
133
+ [More Information Needed]
134
+
135
+ # Model Examination
136
+
137
+ [More Information Needed]
138
+
139
+ # Environmental Impact
140
+
141
+ <!-- Total emissions (in grams of CO2eq) and additional considerations, such as electricity usage, go here. Edit the suggested text below accordingly -->
142
+
143
+ 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).
144
+
145
+ - **Hardware Type:** [More Information Needed]
146
+ - **Hours used:** [More Information Needed]
147
+ - **Cloud Provider:** [More Information Needed]
148
+ - **Compute Region:** [More Information Needed]
149
+ - **Carbon Emitted:** [More Information Needed]
150
+
151
+ # Technical Specifications [optional]
152
+
153
+ ## Model Architecture and Objective
154
+
155
+ [More Information Needed]
156
+
157
+ ## Compute Infrastructure
158
+
159
+ [More Information Needed]
160
+
161
+ ### Hardware
162
+
163
+ [More Information Needed]
164
+
165
+ ### Software
166
+
167
+ [More Information Needed]
168
+
169
+ # Citation
170
+
171
+ <!-- If there is a paper or blog post introducing the model, the APA and Bibtex information for that should go in this section. -->
172
+
173
+ **BibTeX:**
174
+
175
+ [More Information Needed]
176
+
177
+ **APA:**
178
+
179
+ [More Information Needed]
180
+
181
+ # Glossary [optional]
182
+
183
+ <!-- If relevant, include terms and calculations in this section that can help readers understand the model or model card. -->
184
+
185
+ [More Information Needed]
186
+
187
+ # More Information [optional]
188
+
189
+ Please refer to the [official GitHub Repository](https://github.com/meituan/YOLOv6)
190
+
191
+ # Model Card Authors [optional]
192
+
193
+ [@nateraw](https://hf.co/nateraw)
194
+
195
+ # Model Card Contact
196
+
197
+ [@nateraw](https://hf.co/nateraw) - please leave a note in the discussions tab here
198
+
199
+ # How to Get Started with the Model
200
+
201
+ Use the code below to get started with the model.
202
+
203
+ <details>
204
+ <summary> Click to expand </summary>
205
+
206
+ [More Information Needed]
207
+
208
+ </details>