osv5m commited on
Commit
4eb8816
1 Parent(s): 3acbb3d

Upload README.md with huggingface_hub

Browse files
Files changed (1) hide show
  1. README.md +252 -0
README.md ADDED
@@ -0,0 +1,252 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ ---
2
+ language: en
3
+ license: mit
4
+ library_name: pytorch
5
+ model-index:
6
+ - name: baseline
7
+ results:
8
+ - task:
9
+ type: Geoscore
10
+ dataset:
11
+ name: OSV-5M
12
+ type: geolocation
13
+ metrics:
14
+ - type: ranking
15
+ value: 3361
16
+ - task:
17
+ type: Haversine Distance
18
+ dataset:
19
+ name: OSV-5M
20
+ type: geolocation
21
+ metrics:
22
+ - type: distance
23
+ value: 1814
24
+ - task:
25
+ type: Country classification
26
+ dataset:
27
+ name: OSV-5M
28
+ type: geolocation
29
+ metrics:
30
+ - type: accuracy
31
+ value: 68
32
+ - task:
33
+ type: Region classification
34
+ dataset:
35
+ name: OSV-5M
36
+ type: geolocation
37
+ metrics:
38
+ - type: accuracy
39
+ value: 39.4
40
+ - task:
41
+ type: Area classification
42
+ dataset:
43
+ name: OSV-5M
44
+ type: geolocation
45
+ metrics:
46
+ - type: accuracy
47
+ value: 10.3
48
+ - task:
49
+ type: City classification
50
+ dataset:
51
+ name: OSV-5M
52
+ type: geolocation
53
+ metrics:
54
+ - type: accuracy
55
+ value: 5.9
56
+ ---
57
+
58
+ # Model Card for baseline
59
+
60
+ <!-- Provide a quick summary of what the model is/does. -->
61
+
62
+
63
+
64
+ ## Model Details
65
+
66
+ ### Model Description
67
+
68
+ <!-- Provide a longer summary of what this model is. -->
69
+
70
+ Geolocation benchmark on OpenStreetView-5M dataset
71
+
72
+ - **Developed by:** <tobereleased>
73
+ - **Shared by [optional]:** [More Information Needed]
74
+ - **Model type:** [More Information Needed]
75
+ - **Language(s) (NLP):** en
76
+ - **License:** mit
77
+ - **Finetuned from model [optional]:** [More Information Needed]
78
+
79
+ ### Model Sources [optional]
80
+
81
+ <!-- Provide the basic links for the model. -->
82
+
83
+ - **Repository:** <tobereleased>
84
+ - **Paper [optional]:** [More Information Needed]
85
+ - **Demo [optional]:** [More Information Needed]
86
+
87
+ ## Uses
88
+
89
+ <!-- Address questions around how the model is intended to be used, including the foreseeable users of the model and those affected by the model. -->
90
+
91
+ ### Direct Use
92
+
93
+ <!-- This section is for the model use without fine-tuning or plugging into a larger ecosystem/app. -->
94
+
95
+ [More Information Needed]
96
+
97
+ ### Downstream Use [optional]
98
+
99
+ <!-- This section is for the model use when fine-tuned for a task, or when plugged into a larger ecosystem/app -->
100
+
101
+ [More Information Needed]
102
+
103
+ ### Out-of-Scope Use
104
+
105
+ <!-- This section addresses misuse, malicious use, and uses that the model will not work well for. -->
106
+
107
+ [More Information Needed]
108
+
109
+ ## Bias, Risks, and Limitations
110
+
111
+ <!-- This section is meant to convey both technical and sociotechnical limitations. -->
112
+
113
+ [More Information Needed]
114
+
115
+ ### Recommendations
116
+
117
+ <!-- This section is meant to convey recommendations with respect to the bias, risk, and technical limitations. -->
118
+
119
+ Users (both direct and downstream) should be made aware of the risks, biases and limitations of the model. More information needed for further recommendations.
120
+
121
+ ## How to Get Started with the Model
122
+
123
+ Use the code below to get started with the model.
124
+
125
+ [More Information Needed]
126
+
127
+ ## Training Details
128
+
129
+ ### Training Data
130
+
131
+ <!-- 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. -->
132
+
133
+ [More Information Needed]
134
+
135
+ ### Training Procedure
136
+
137
+ <!-- This relates heavily to the Technical Specifications. Content here should link to that section when it is relevant to the training procedure. -->
138
+
139
+ #### Preprocessing [optional]
140
+
141
+ [More Information Needed]
142
+
143
+
144
+ #### Training Hyperparameters
145
+
146
+ - **Training regime:** [More Information Needed] <!--fp32, fp16 mixed precision, bf16 mixed precision, bf16 non-mixed precision, fp16 non-mixed precision, fp8 mixed precision -->
147
+
148
+ #### Speeds, Sizes, Times [optional]
149
+
150
+ <!-- This section provides information about throughput, start/end time, checkpoint size if relevant, etc. -->
151
+
152
+ [More Information Needed]
153
+
154
+ ## Evaluation
155
+
156
+ <!-- This section describes the evaluation protocols and provides the results. -->
157
+
158
+ ### Testing Data, Factors & Metrics
159
+
160
+ #### Testing Data
161
+
162
+ <!-- This should link to a Data Card if possible. -->
163
+
164
+ [More Information Needed]
165
+
166
+ #### Factors
167
+
168
+ <!-- These are the things the evaluation is disaggregating by, e.g., subpopulations or domains. -->
169
+
170
+ [More Information Needed]
171
+
172
+ #### Metrics
173
+
174
+ <!-- These are the evaluation metrics being used, ideally with a description of why. -->
175
+
176
+ [More Information Needed]
177
+
178
+ ### Results
179
+
180
+ [More Information Needed]
181
+
182
+ #### Summary
183
+
184
+
185
+
186
+ ## Model Examination [optional]
187
+
188
+ <!-- Relevant interpretability work for the model goes here -->
189
+
190
+ [More Information Needed]
191
+
192
+ ## Environmental Impact
193
+
194
+ <!-- Total emissions (in grams of CO2eq) and additional considerations, such as electricity usage, go here. Edit the suggested text below accordingly -->
195
+
196
+ 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).
197
+
198
+ - **Hardware Type:** [More Information Needed]
199
+ - **Hours used:** [More Information Needed]
200
+ - **Cloud Provider:** [More Information Needed]
201
+ - **Compute Region:** [More Information Needed]
202
+ - **Carbon Emitted:** [More Information Needed]
203
+
204
+ ## Technical Specifications [optional]
205
+
206
+ ### Model Architecture and Objective
207
+
208
+ [More Information Needed]
209
+
210
+ ### Compute Infrastructure
211
+
212
+ [More Information Needed]
213
+
214
+ #### Hardware
215
+
216
+ [More Information Needed]
217
+
218
+ #### Software
219
+
220
+ [More Information Needed]
221
+
222
+ ## Citation [optional]
223
+
224
+ <!-- If there is a paper or blog post introducing the model, the APA and Bibtex information for that should go in this section. -->
225
+
226
+ **BibTeX:**
227
+
228
+ [More Information Needed]
229
+
230
+ **APA:**
231
+
232
+ [More Information Needed]
233
+
234
+ ## Glossary [optional]
235
+
236
+ <!-- If relevant, include terms and calculations in this section that can help readers understand the model or model card. -->
237
+
238
+ [More Information Needed]
239
+
240
+ ## More Information [optional]
241
+
242
+ [More Information Needed]
243
+
244
+ ## Model Card Authors [optional]
245
+
246
+ [More Information Needed]
247
+
248
+ ## Model Card Contact
249
+
250
+ [More Information Needed]
251
+
252
+