Update README.md

README.md

@@ -1,3 +1,72 @@
----
-license: cc-by-4.0
----
+---
+license: cc-by-4.0
+---
+# ReefNet Dataset
+
+The ReefNet dataset is a comprehensive collection of annotated coral images designed for training and evaluating machine learning models in the field of corals. This dataset provides a rich source of information to aid in the classification and study of corals across different geographic regions.
+
+## Dataset Structure
+
+The dataset is organized as follows:
+
+- `ReefNet_CN_annotations.csv` (714 MB)
+  - Contains the annotations for the CoralNet data sources used in ReefNet.
+  
+- `ReefNet_RSG_annotations.csv` (2.42 MB)
+  - Contains the annotations for the ReefNet dataset with genus and species-level labels.
+  
+- `ReefNet_RSG_images.zip` (1.21 GB)
+  - This file contains the majority of the training and validation images. Due to its large size, it is hosted on Google Drive.
+
+- `Supplementary Materials 1 CoralNet sources used in ReefNet.xlsx` (16.8 KB)
+  - Details the CoralNet sources used in the ReefNet dataset.
+  
+- `Supplementary Materials 2 ReefNet dataset structure.xlsx` (49.5 KB)
+  - Provides an overview of the dataset structure.
+  
+- `Supplementary Materials 3 ReefNet Training and Validation data distribution.xlsx` (32.7 KB)
+  - Describes the distribution of training and validation data in the ReefNet dataset.
+
+## Download Instructions
+
+### Hugging Face Files
+
+You can download the following files directly from Hugging Face:
+
+- `ReefNet_CN_annotations.csv`
+- `ReefNet_RSG_annotations.csv`
+- `Supplementary Materials 1 CoralNet sources used in ReefNet.xlsx`
+- `Supplementary Materials 2 ReefNet dataset structure.xlsx`
+- `Supplementary Materials 3 ReefNet Training and Validation data distribution.xlsx`
+
+### Google Drive File
+
+Due to its size, the `ReefNet_CN_images.zip` file is hosted on Google Drive. You can download it using the following link:
+
+[ReefNet_CN_images.zip](https://drive.google.com/file/d/1adETkbevDTDSCZEbmSNdwhzAM-4bp5IF/view?usp=sharing)
+
+## Usage
+
+To use this dataset, please ensure that you download all necessary files, including the images from Google Drive. The annotations are provided in CSV format, which can be easily read and processed using various data analysis tools and libraries.
+
+<!-- ## Citation
+
+If you use this dataset in your research, please cite it as follows:
+
+@dataset{reefnet2024,
+author = {Your Name and Collaborators},
+title = {ReefNet: Annotated Coral Image Dataset for Machine Learning},
+year = 2024,
+publisher = {Hugging Face},
+url = {https://huggingface.co/datasets/reefnet}
+} -->
+
+
+## Contact
+
+For any questions or issues regarding the dataset, please contact:
+
+- Yahia Battach
+- [email protected]
+
+We hope this dataset aids in your research and contributes to the advancement of marine biology and machine learning applications.