frgfm commited on
Commit
c0dff32
1 Parent(s): 6555ae7

docs: Updated README

Browse files
Files changed (1) hide show
  1. README.md +131 -2
README.md CHANGED
@@ -19,6 +19,135 @@ task_ids:
19
  - image-classification
20
  ---
21
 
22
- # OpenFire
23
 
24
- For more information about this dataset, please refer to its [documentation](https://pyronear.org/pyro-vision/datasets.html#openfire).
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
19
  - image-classification
20
  ---
21
 
22
+ # Dataset Card for OpenFire
23
 
24
+ ## Table of Contents
25
+ - [Table of Contents](#table-of-contents)
26
+ - [Dataset Description](#dataset-description)
27
+ - [Dataset Summary](#dataset-summary)
28
+ - [Supported Tasks and Leaderboards](#supported-tasks-and-leaderboards)
29
+ - [Languages](#languages)
30
+ - [Dataset Structure](#dataset-structure)
31
+ - [Data Instances](#data-instances)
32
+ - [Data Fields](#data-fields)
33
+ - [Data Splits](#data-splits)
34
+ - [Dataset Creation](#dataset-creation)
35
+ - [Curation Rationale](#curation-rationale)
36
+ - [Source Data](#source-data)
37
+ - [Annotations](#annotations)
38
+ - [Personal and Sensitive Information](#personal-and-sensitive-information)
39
+ - [Considerations for Using the Data](#considerations-for-using-the-data)
40
+ - [Social Impact of Dataset](#social-impact-of-dataset)
41
+ - [Discussion of Biases](#discussion-of-biases)
42
+ - [Other Known Limitations](#other-known-limitations)
43
+ - [Additional Information](#additional-information)
44
+ - [Dataset Curators](#dataset-curators)
45
+ - [Licensing Information](#licensing-information)
46
+ - [Citation Information](#citation-information)
47
+ - [Contributions](#contributions)
48
+
49
+ ## Dataset Description
50
+
51
+ - **Homepage:** https://pyronear.org/pyro-vision/datasets.html#openfire
52
+ - **Repository:** https://github.com/pyronear/pyro-vision
53
+ - **Point of Contact:** contact@pyronear.org
54
+
55
+ ### Dataset Summary
56
+
57
+ OpenFire is an image classification dataset for wildfire detection, collected
58
+ from web searches.
59
+
60
+ ### Supported Tasks and Leaderboards
61
+
62
+ - `image-classification`: The dataset can be used to train a model for Image Classification.
63
+
64
+ ### Languages
65
+
66
+ English
67
+
68
+ ## Dataset Structure
69
+
70
+ ### Data Instances
71
+
72
+ A data point comprises an image URL and its binary label.
73
+
74
+ ```
75
+ {
76
+ 'image_url': 'https://cdn-s-www.ledauphine.com/images/13C08274-6BA6-4577-B3A0-1E6C1B2A573C/FB1200/photo-1338240831.jpg',
77
+ 'is_wildfire': true,
78
+ }
79
+ ```
80
+
81
+ ### Data Fields
82
+
83
+ - `image_url`: the download URL of the image.
84
+ - `is_wildfire`: a boolean value specifying whether there is an ongoing wildfire on the image.
85
+
86
+ ### Data Splits
87
+
88
+ The data is split into training and validation sets. The training set contains 7143 images and the validation set 792 images.
89
+
90
+ ## Dataset Creation
91
+
92
+ ### Curation Rationale
93
+
94
+ The curators state that the current wildfire classification datasets typically contain close-up shots of wildfires, with limited variations of weather conditions, luminosity and backrgounds,
95
+ making it difficult to assess for real world performance. They argue that the limitations of datasets have partially contributed to the failure of some algorithms in coping
96
+ with sun flares, foggy / cloudy weather conditions and small scale.
97
+
98
+ ### Source Data
99
+
100
+ #### Initial Data Collection and Normalization
101
+
102
+ OpenFire was collected using images publicly indexed by the search engine DuckDuckGo using multiple relevant queries. The images were then manually cleaned to remove errors.
103
+
104
+ ### Annotations
105
+
106
+ #### Annotation process
107
+
108
+ Each web search query was designed to yield a single label (with wildfire or without), and additional human verification was used to remove errors.
109
+
110
+ #### Who are the annotators?
111
+
112
+ François-Guillaume Fernandez
113
+
114
+ ### Personal and Sensitive Information
115
+
116
+ [More Information Needed]
117
+
118
+ ## Considerations for Using the Data
119
+
120
+ ### Social Impact of Dataset
121
+
122
+ [More Information Needed]
123
+
124
+ ### Discussion of Biases
125
+
126
+ [More Information Needed]
127
+
128
+ ### Other Known Limitations
129
+
130
+ [More Information Needed]
131
+
132
+ ## Additional Information
133
+
134
+ ### Dataset Curators
135
+
136
+ François-Guillaume Fernandez
137
+
138
+ ### Licensing Information
139
+
140
+ [Apache License 2.0](https://www.apache.org/licenses/LICENSE-2.0).
141
+
142
+ ### Citation Information
143
+
144
+ ```
145
+ @software{Pyronear_PyroVision_2019,
146
+ title={Pyrovision: wildfire early detection},
147
+ author={Pyronear contributors},
148
+ year={2019},
149
+ month={October},
150
+ publisher = {GitHub},
151
+ howpublished = {\url{https://github.com/pyronear/pyro-vision}}
152
+ }
153
+ ```