Dharani132 commited on
Commit
f593408
·
verified ·
1 Parent(s): a8c5005

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +113 -0
README.md CHANGED
@@ -0,0 +1,113 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ ---
2
+ license: cc-by-4.0
3
+ task_categories:
4
+ - image-segmentation
5
+ language:
6
+ - en
7
+ pretty_name: Oil Spill Detection Dataset
8
+ ---
9
+
10
+ # Oil Spill Detection Dataset
11
+
12
+ This dataset contains Sentinel-1 SAR satellite images and segmentation masks
13
+ for oil spill detection.
14
+
15
+ ⚠️ **Note**: Due to large size, the dataset files are hosted on **Zenodo**.
16
+ This Hugging Face repository provides metadata, documentation, and usage
17
+ instructions only.
18
+
19
+ ---
20
+
21
+ ## 📦 Dataset Parts (Zenodo)
22
+
23
+ ### 🔹 Train & Validation – Oil Spill
24
+ - Images:
25
+ https://zenodo.org/records/8346860/files/01_Train_Val_Oil_Spill_images.7z
26
+ - Masks:
27
+ https://zenodo.org/records/8346860/files/01_Train_Val_Oil_Spill_mask.7z
28
+
29
+ ### 🔹 Train & Validation – No Oil & Lookalike
30
+ - No Oil Images:
31
+ https://zenodo.org/records/8253899/files/01_Train_Val_No_Oil_Images.7z
32
+ - No Oil Masks:
33
+ https://zenodo.org/records/8253899/files/01_Train_Val_No_Oil_mask.7z
34
+ - Lookalike Images:
35
+ https://zenodo.org/records/8253899/files/01_Train_Val_Lookalike_images.7z
36
+ - Lookalike Masks:
37
+ https://zenodo.org/records/8253899/files/01_Train_Val_Lookalike_mask.7z
38
+
39
+ ### 🔹 Test Set
40
+ - Test Images + Ground Truth:
41
+ https://zenodo.org/records/13761290/files/02_Test_images_and_ground_truth.7z
42
+
43
+ ---
44
+
45
+ ## 📁 Dataset Structure (After Extraction)
46
+
47
+ dataset/
48
+ ├── train/
49
+ │ ├── images/
50
+ │ └── masks/
51
+ ├── val/
52
+ │ ├── images/
53
+ │ └── masks/
54
+ └── test/
55
+ ├── images/
56
+ └── masks/
57
+
58
+ ---
59
+
60
+ ## 📌 Citation
61
+
62
+ If you use this dataset, please cite the original Zenodo records:
63
+
64
+ ```bibtex
65
+ @dataset{oilspill_zenodo,
66
+ title = {Sentinel-1 SAR Oil Spill Dataset},
67
+ publisher = {Zenodo},
68
+ year = {2024},
69
+ doi = {10.5281/zenodo.8346860}
70
+ }
71
+
72
+
73
+ ---
74
+
75
+ ## ✅ THAT’S IT — YOU ARE DONE
76
+
77
+ Now your **README.md is COMPLETE**.
78
+
79
+ ---
80
+
81
+ ## FINAL CHECK (VERY IMPORTANT)
82
+
83
+ Your README should have:
84
+ 1. YAML metadata at top ✅
85
+ 2. Dataset description ✅
86
+ 3. Zenodo links ✅
87
+ 4. Dataset structure diagram ✅
88
+ 5. Citation section ✅
89
+
90
+ If yes → **DO NOT add anything else**
91
+
92
+ ---
93
+
94
+ ## LAST STEP: COMMIT
95
+ 1. Scroll down
96
+ 2. Commit message:
97
+ 3. Click **Commit changes**
98
+
99
+ 🎉 Finished. Clean. Professional.
100
+
101
+ ---
102
+
103
+ ### 🟢 If anything looks confusing on the screen:
104
+ - Blank lines
105
+ - Formatting
106
+ - Red text
107
+
108
+ 👉 **Ignore it** and commit — Markdown auto-fixes it.
109
+
110
+ ---
111
+
112
+ Say **DONE bro** once you committed
113
+ or **SCREENSHOT** if you want me to verify 💪