nakamura196 commited on
Commit
6a86152
1 Parent(s): 0f34511

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +137 -3
README.md CHANGED
@@ -1,3 +1,137 @@
1
- ---
2
- license: mit
3
- ---
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ ---
2
+ license: mit
3
+ tags:
4
+ - yolov5
5
+ - yolo
6
+ - vision
7
+ - object-detection
8
+ - pytorch
9
+ library_name: yolov5
10
+ datasets:
11
+ - nakamura196/ndl-layout-dataset
12
+ ---
13
+ # yolov5-ndl-layout
14
+
15
+ <!-- Provide a quick summary of what the model is/does. -->
16
+
17
+ 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).
18
+
19
+ ## Model Details
20
+
21
+ ### Model Description
22
+
23
+ <!-- Provide a longer summary of what this model is. -->
24
+
25
+
26
+
27
+ - **Developed by:** [More Information Needed]
28
+ - **Funded by [optional]:** [More Information Needed]
29
+ - **Shared by [optional]:** [More Information Needed]
30
+ - **Model type:** [More Information Needed]
31
+ - **Language(s) (NLP):** [More Information Needed]
32
+ - **License:** [More Information Needed]
33
+ - **Finetuned from model [optional]:** [More Information Needed]
34
+
35
+ ## Uses
36
+
37
+ <!-- Address questions around how the model is intended to be used, including the foreseeable users of the model and those affected by the model. -->
38
+
39
+ ### Direct Use
40
+
41
+ <!-- This section is for the model use without fine-tuning or plugging into a larger ecosystem/app. -->
42
+
43
+ [More Information Needed]
44
+
45
+ ### Out-of-Scope Use
46
+
47
+ <!-- This section addresses misuse, malicious use, and uses that the model will not work well for. -->
48
+
49
+ [More Information Needed]
50
+
51
+ ## Bias, Risks, and Limitations
52
+
53
+ <!-- This section is meant to convey both technical and sociotechnical limitations. -->
54
+
55
+ [More Information Needed]
56
+
57
+ ### Recommendations
58
+
59
+ <!-- This section is meant to convey recommendations with respect to the bias, risk, and technical limitations. -->
60
+
61
+ Users (both direct and downstream) should be made aware of the risks, biases and limitations of the model. More information needed for further recommendations.
62
+
63
+ ## How to Get Started with the Model
64
+
65
+ Use the code below to get started with the model.
66
+
67
+ [More Information Needed]
68
+
69
+ ## Training Details
70
+
71
+ ### Training Data
72
+
73
+ <!-- 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. -->
74
+
75
+ [More Information Needed]
76
+
77
+ ### Training Procedure
78
+
79
+ <!-- This relates heavily to the Technical Specifications. Content here should link to that section when it is relevant to the training procedure. -->
80
+
81
+
82
+
83
+
84
+ #### Training Hyperparameters
85
+
86
+ - **Training regime:** [More Information Needed] <!--fp32, fp16 mixed precision, bf16 mixed precision, bf16 non-mixed precision, fp16 non-mixed precision, fp8 mixed precision -->
87
+
88
+
89
+
90
+ ## Evaluation
91
+
92
+ <!-- This section describes the evaluation protocols and provides the results. -->
93
+
94
+ ### Testing Data, Factors & Metrics
95
+
96
+ #### Testing Data
97
+
98
+ <!-- This should link to a Dataset Card if possible. -->
99
+
100
+ [More Information Needed]
101
+
102
+ #### Factors
103
+
104
+ <!-- These are the things the evaluation is disaggregating by, e.g., subpopulations or domains. -->
105
+
106
+ [More Information Needed]
107
+
108
+ #### Metrics
109
+
110
+ <!-- These are the evaluation metrics being used, ideally with a description of why. -->
111
+
112
+ [More Information Needed]
113
+
114
+ ### Results
115
+
116
+ [More Information Needed]
117
+
118
+ #### Summary
119
+
120
+
121
+
122
+ ## Environmental Impact
123
+
124
+ <!-- Total emissions (in grams of CO2eq) and additional considerations, such as electricity usage, go here. Edit the suggested text below accordingly -->
125
+
126
+ 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).
127
+
128
+ - **Hardware Type:** [More Information Needed]
129
+ - **Hours used:** [More Information Needed]
130
+ - **Cloud Provider:** [More Information Needed]
131
+ - **Compute Region:** [More Information Needed]
132
+ - **Carbon Emitted:** [More Information Needed]
133
+
134
+
135
+ ## Model Card Contact
136
+
137
+ [More Information Needed]