Yifeng-Liu commited on
Commit
096e78f
1 Parent(s): bdeb8c9

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +5 -162
README.md CHANGED
@@ -59,7 +59,7 @@ model-index:
59
 
60
  # Model Card for Model ID
61
 
62
- Object Detection for Remote Sensing task.
63
  <!-- Provide a quick summary of what the model is/does. -->
64
 
65
 
@@ -70,51 +70,21 @@ Object Detection for Remote Sensing task.
70
 
71
  <!-- Provide a longer summary of what this model is. -->
72
 
73
- This is the model card of a 🤗 transformers model that has been pushed on the Hub. This model card has been automatically generated.
74
-
75
  - **Developed by:** Yifeng Liu
76
- - **Shared by [optional]:** Yifeng Liu
77
  - **Model type:** Object Detection for Remote Sensing task.
78
  - **License:** MIT
79
- - **Finetuned from model [optional]:** RT-DETR
80
 
81
- ### Model Sources [optional]
82
 
83
  <!-- Provide the basic links for the model. -->
84
 
85
- - **Repository:** [More Information Needed]
86
- - **Paper [optional]:** [More Information Needed]
87
- - **Demo [optional]:** [More Information Needed]
88
-
89
- ## Uses
90
-
91
- <!-- Address questions around how the model is intended to be used, including the foreseeable users of the model and those affected by the model. -->
92
-
93
- ### Direct Use
94
-
95
- <!-- This section is for the model use without fine-tuning or plugging into a larger ecosystem/app. -->
96
-
97
- [More Information Needed]
98
-
99
- ### Downstream Use [optional]
100
-
101
- <!-- This section is for the model use when fine-tuned for a task, or when plugged into a larger ecosystem/app -->
102
-
103
- [More Information Needed]
104
-
105
- ### Out-of-Scope Use
106
 
107
- <!-- This section addresses misuse, malicious use, and uses that the model will not work well for. -->
108
 
109
- [More Information Needed]
110
 
111
- ## Bias, Risks, and Limitations
112
 
113
- <!-- This section is meant to convey both technical and sociotechnical limitations. -->
114
-
115
- [More Information Needed]
116
-
117
- ### Recommendations
118
 
119
  <!-- This section is meant to convey recommendations with respect to the bias, risk, and technical limitations. -->
120
 
@@ -123,130 +93,3 @@ Users (both direct and downstream) should be made aware of the risks, biases and
123
  ## How to Get Started with the Model
124
 
125
  Use the code below to get started with the model.
126
-
127
- [More Information Needed]
128
-
129
- ## Training Details
130
-
131
- ### Training Data
132
-
133
- <!-- 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. -->
134
-
135
- [More Information Needed]
136
-
137
- ### Training Procedure
138
-
139
- <!-- This relates heavily to the Technical Specifications. Content here should link to that section when it is relevant to the training procedure. -->
140
-
141
- #### Preprocessing [optional]
142
-
143
- [More Information Needed]
144
-
145
-
146
- #### Training Hyperparameters
147
-
148
- - **Training regime:** [More Information Needed] <!--fp32, fp16 mixed precision, bf16 mixed precision, bf16 non-mixed precision, fp16 non-mixed precision, fp8 mixed precision -->
149
-
150
- #### Speeds, Sizes, Times [optional]
151
-
152
- <!-- This section provides information about throughput, start/end time, checkpoint size if relevant, etc. -->
153
-
154
- [More Information Needed]
155
-
156
- ## Evaluation
157
-
158
- <!-- This section describes the evaluation protocols and provides the results. -->
159
-
160
- ### Testing Data, Factors & Metrics
161
-
162
- #### Testing Data
163
-
164
- <!-- This should link to a Dataset Card if possible. -->
165
-
166
- [More Information Needed]
167
-
168
- #### Factors
169
-
170
- <!-- These are the things the evaluation is disaggregating by, e.g., subpopulations or domains. -->
171
-
172
- [More Information Needed]
173
-
174
- #### Metrics
175
-
176
- <!-- These are the evaluation metrics being used, ideally with a description of why. -->
177
-
178
- [More Information Needed]
179
-
180
- ### Results
181
-
182
- [More Information Needed]
183
-
184
- #### Summary
185
-
186
-
187
-
188
- ## Model Examination [optional]
189
-
190
- <!-- Relevant interpretability work for the model goes here -->
191
-
192
- [More Information Needed]
193
-
194
- ## Environmental Impact
195
-
196
- <!-- Total emissions (in grams of CO2eq) and additional considerations, such as electricity usage, go here. Edit the suggested text below accordingly -->
197
-
198
- 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).
199
-
200
- - **Hardware Type:** [More Information Needed]
201
- - **Hours used:** [More Information Needed]
202
- - **Cloud Provider:** [More Information Needed]
203
- - **Compute Region:** [More Information Needed]
204
- - **Carbon Emitted:** [More Information Needed]
205
-
206
- ## Technical Specifications [optional]
207
-
208
- ### Model Architecture and Objective
209
-
210
- [More Information Needed]
211
-
212
- ### Compute Infrastructure
213
-
214
- [More Information Needed]
215
-
216
- #### Hardware
217
-
218
- [More Information Needed]
219
-
220
- #### Software
221
-
222
- [More Information Needed]
223
-
224
- ## Citation [optional]
225
-
226
- <!-- If there is a paper or blog post introducing the model, the APA and Bibtex information for that should go in this section. -->
227
-
228
- **BibTeX:**
229
-
230
- [More Information Needed]
231
-
232
- **APA:**
233
-
234
- [More Information Needed]
235
-
236
- ## Glossary [optional]
237
-
238
- <!-- If relevant, include terms and calculations in this section that can help readers understand the model or model card. -->
239
-
240
- [More Information Needed]
241
-
242
- ## More Information [optional]
243
-
244
- [More Information Needed]
245
-
246
- ## Model Card Authors [optional]
247
-
248
- [More Information Needed]
249
-
250
- ## Model Card Contact
251
-
252
- [More Information Needed]
 
59
 
60
  # Model Card for Model ID
61
 
62
+ Roof Detection for Remote Sensing task.
63
  <!-- Provide a quick summary of what the model is/does. -->
64
 
65
 
 
70
 
71
  <!-- Provide a longer summary of what this model is. -->
72
 
 
 
73
  - **Developed by:** Yifeng Liu
 
74
  - **Model type:** Object Detection for Remote Sensing task.
75
  - **License:** MIT
 
76
 
77
+ ### Model Sources
78
 
79
  <!-- Provide the basic links for the model. -->
80
 
81
+ - **Repository:** [Jupyter Notebook](https://github.com/ownEyes/satellite-image-roofs-auto-annotation-sourcecode/blob/dev/notebooks/finetune_rtdetr.ipynb)
82
+ - **Demo [optional]:** [Pending]
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
83
 
 
84
 
 
85
 
 
86
 
87
+ ## Recommendations
 
 
 
 
88
 
89
  <!-- This section is meant to convey recommendations with respect to the bias, risk, and technical limitations. -->
90
 
 
93
  ## How to Get Started with the Model
94
 
95
  Use the code below to get started with the model.