Nancyrr25 commited on
Commit
0562a3e
Β·
verified Β·
1 Parent(s): ef5126d

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +68 -16
README.md CHANGED
@@ -52,32 +52,84 @@ De_vuelta_a_casa/
52
 
53
  Each folder contains images organized by region and species.
54
 
55
- 🏷️# Dataset Details
56
  Total number of images: [Add the total number of images here]
57
  Number of species: [Add the number of species here]
 
 
 
 
58
  Image sources: Images collected from various public online sources.
59
  Average resolution: [Add the average image resolution here, if relevant].
60
  Labels: Each image is labeled with the species name it belongs to.
 
 
 
61
 
62
- πŸš€ How to Use the Dataset
63
- You can load the dataset directly from Hugging Face with the following code:
64
- from datasets import load_dataset
 
 
 
 
 
 
 
 
65
  ```python
66
- # Load the dataset
67
- dataset = load_dataset("De_vuelta_a_casa", split="train")
 
 
68
 
69
- # Example: Access Bivalves from the Caribbean
70
- caribbean_bivalves = dataset["Dataset/Bivalves/Caribbean/"]
 
 
71
 
72
- # Example: Access Gastropoda from the Pacific
73
- pacific_gastropoda = dataset["Dataset/Gastropoda/Pacific/"]
 
 
 
 
 
 
 
 
 
 
 
 
 
74
  ```
75
 
76
- ⚠️# Considerations and License
77
- This dataset contains images collected from the internet and is intended for educational and research purposes only.
78
- It is recommended to verify the images before using them in commercial projects.
79
- Please respect the copyright associated with the images collected.
 
 
80
 
81
- 🌟 Acknowledgments
82
- Special thanks to all the public sources and individuals who contributed to the knowledge and documentation of marine species. This work aims to support biodiversity preservation and scientific research.
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
83
 
 
52
 
53
  Each folder contains images organized by region and species.
54
 
55
+ ## 🏷️Dataset Details
56
  Total number of images: [Add the total number of images here]
57
  Number of species: [Add the number of species here]
58
+ Geographic Regions: Caribbean and Pacific from Costa Rica
59
+ OverCategories:
60
+ -Bivalves: Two-shelled mollusks (e.g., clams, oysters)
61
+ -Gastropoda: Single-shelled mollusks (e.g., snails)
62
  Image sources: Images collected from various public online sources.
63
  Average resolution: [Add the average image resolution here, if relevant].
64
  Labels: Each image is labeled with the species name it belongs to.
65
+ Sources: Publicly available images from the internet
66
+ Image Format: JPEG/PNG
67
+ Labels: Species name and geographic region
68
 
69
+ ## πŸ“Š Applications
70
+ This dataset can be used for:
71
+
72
+ **Marine Biodiversity Research:** Studying species distribution and diversity.
73
+ **Image Classification:** Training models to identify and classify mollusk species.
74
+ **Environmental Studies:** Understanding the impact of environmental factors on species distribution.
75
+ **Educational Purposes:** Teaching about marine ecosystems and mollusk species.
76
+
77
+ ## πŸš€ Getting Started
78
+ ### πŸ“₯ Download the Dataset
79
+ You can download the dataset directly from Hugging Face using the following command:
80
  ```python
81
+ pip install datasets
82
+ ```
83
+ ```python
84
+ from datasets import load_dataset
85
 
86
+ dataset = load_dataset("De_vuelta_a_casa", split="train")
87
+ ```
88
+ ### πŸ” Access Specific Categories
89
+ To access images from specific categories:
90
 
91
+ **Bivalves (Caribbean):**
92
+ ```python
93
+ dataset["Dataset/Bivalves/Caribbean/"]
94
+ ```
95
+ **Bivalves (Pacific):**
96
+ ```python
97
+ dataset["Dataset/Bivalves/Pacific/"]
98
+ ```
99
+ **Gastropoda (Caribbean):**
100
+ ```python
101
+ dataset["Dataset/Gastropoda/Caribbean/"]
102
+ ```
103
+ **Gastropoda (Pacific):**
104
+ ```python
105
+ dataset["Dataset/Gastropoda/Pacific/"]
106
  ```
107
 
108
+ ## πŸ“œ Licensing and Usage
109
+ License: MIT License
110
+ Usage:
111
+ This dataset is intended for educational and research purposes only.
112
+ Commercial use of the dataset requires prior verification of the original image sources.
113
+ Respect the copyright and intellectual property rights associated with the collected images.
114
 
115
+
116
+ ## 🌟 Acknowledgments
117
+ Special thanks to:
118
+
119
+ All contributors who have made marine species documentation publicly available.
120
+ The creators of open-source tools that have enabled this project.
121
+ This dataset was created to promote awareness of marine biodiversity and support scientific research. We hope it helps researchers, educators, and enthusiasts understand and protect our oceans' ecosystems.
122
+
123
+ ## πŸ”— Citation
124
+ If you use this dataset in your research, please cite it as follows:
125
+
126
+ ```bibtex
127
+ @dataset{de_vuelta_a_casa,
128
+ title = {De_vuelta_a_casa: Sea Shell Image Dataset},
129
+ author = {JoystickData Team},
130
+ year = {2025},
131
+ publisher = {Hugging Face},
132
+ url = {https://huggingface.co/datasets/De_vuelta_a_casa}
133
+ }
134
+ ```
135