Upload README.md with huggingface_hub

README.md

@@ -78,14 +78,85 @@ mammals_data = dataset['mammals']
 ## Dataset Details
 - **Format**: Parquet (optimized for streaming)
 - **Total Images**: 139,111
-- **Species Count**: 60+ species (30 birds, 30 mammals)
+- **Species Count**: 61 species (31 birds, 30 mammals)
 - **Image Format**: RGB images, variable sizes (cropped from original images)
 - **License**: MIT
-
-### Example Species
-**Aves (Birds)**: American Crow, Australian Magpie, California Quail, Common Myna, House Sparrow, etc.
-
-**Mammals**: Red Fox, White-tailed Deer, Gray Wolf, Raccoon, etc.
+- **Source**: Images from 23 camera trap datasets from LILA BC
+
+### Complete Species List
+
+#### Aves (Birds) - 31 Species, 73,528 Images
+
+| Species | Total | Validated | Uncertain |
+|---------|-------|-----------|-----------|
+| American crow | 1,240 | 1,234 | 6 |
+| Australasian swamphen | 2,772 | 2,772 | 0 |
+| Australian magpie | 2,739 | 2,733 | 6 |
+| Black curassow | 1,949 | 1,939 | 10 |
+| Blue whistling thrush | 2,157 | 2,128 | 29 |
+| Brown quail | 2,662 | 2,652 | 10 |
+| Chicken | 1,647 | 1,629 | 18 |
+| Common chafflinch | 2,384 | 2,370 | 14 |
+| Common myna | 2,707 | 2,704 | 3 |
+| Dunnock | 2,066 | 2,055 | 11 |
+| European starling | 1,876 | 1,867 | 9 |
+| Fantails | 2,127 | 2,121 | 6 |
+| Greenfinch | 2,503 | 2,483 | 20 |
+| Kea | 2,833 | 2,814 | 19 |
+| Kiwi | 1,634 | 1,620 | 14 |
+| Kori bustard | 1,485 | 1,484 | 1 |
+| Mountain quail | 2,337 | 2,337 | 0 |
+| New Zealand robin | 2,753 | 2,719 | 34 |
+| Ostrich | 3,727 | 3,722 | 5 |
+| Petrel | 2,370 | 2,354 | 16 |
+| Pipit | 2,316 | 2,238 | 78 |
+| Quail | 44 | 0 | 44 |
+| Red junglefowl | 2,684 | 2,671 | 13 |
+| Spix's guan | 3,032 | 3,022 | 10 |
+| Swamp harrier | 2,917 | 2,917 | 0 |
+| Takahē | 2,085 | 2,073 | 12 |
+| Tūī | 2,767 | 2,747 | 20 |
+| Vulturine guineafowl | 4,420 | 4,404 | 16 |
+| Weka | 2,421 | 2,407 | 14 |
+| Wild turkey | 2,057 | 2,057 | 0 |
+| Yellow-eyed penguin | 2,817 | 2,815 | 2 |
+
+#### Mammals - 30 Species, 65,583 Images
+
+| Species | Total | Validated | Uncertain |
+|---------|-------|-----------|-----------|
+| Alpaca | 1,864 | 1,864 | 0 |
+| American black bear | 2,912 | 2,797 | 115 |
+| Black-backed jackal | 2,067 | 2,053 | 14 |
+| Black rhinoceros | 1,428 | 1,419 | 9 |
+| Bushpig | 1,241 | 1,230 | 11 |
+| Common brushtail possum | 1,365 | 1,358 | 7 |
+| Crab-eating mongoose | 2,364 | 2,316 | 48 |
+| Crested porcupine | 1,449 | 1,449 | 0 |
+| Dromedary camel | 1,809 | 1,798 | 11 |
+| Eastern gray squirrel | 2,434 | 2,414 | 20 |
+| Ferret badger | 1,743 | 1,671 | 72 |
+| Gemsbok | 3,963 | 3,944 | 19 |
+| Giant armadillo | 463 | 461 | 2 |
+| Giraffe | 2,985 | 2,974 | 11 |
+| Greater kudu | 4,410 | 4,375 | 35 |
+| Hippopotamus | 2,319 | 2,314 | 5 |
+| Jaguar | 6,855 | 6,831 | 24 |
+| L'Hoest's monkey | 2,941 | 2,921 | 20 |
+| Least weasel | 1,869 | 1,869 | 0 |
+| Northern treeshrew | 699 | 687 | 12 |
+| NZ sea lion | 2,296 | 2,277 | 19 |
+| Raccoon | 2,700 | 2,577 | 123 |
+| Serval | 625 | 625 | 0 |
+| Ship rat | 822 | 822 | 0 |
+| Spotted paca | 1,715 | 1,673 | 42 |
+| Stump-tailed macaque | 3,558 | 3,535 | 23 |
+| Sun bear | 713 | 709 | 4 |
+| Warthog | 1,671 | 1,666 | 5 |
+| White-nosed coati | 1,996 | 1,982 | 14 |
+| Wolf | 2,307 | 2,307 | 0 |
+
+**Note**: "Uncertain" indicates cases where manual validation was uncertain of the given class due to occlusion, blur, or ambiguous features.
 
 ## Downloading Specific Species
 
@@ -104,33 +175,20 @@ filtered = ds.filter(lambda x: x['filename'].startswith('american-crow'))
 # without downloading the full dataset
 ```
 
-## Updating the Dataset
-
-To update metadata or add new samples without re-uploading everything:
-
-```python
-from datasets import load_dataset
-
-# Load existing dataset
-dataset = load_dataset("AI-EcoNet/ViT_animal_data")
-
-# Modify dataset (add columns, update labels, etc.)
-dataset = dataset.map(lambda x: {"new_field": "value"})
-
-# Push only the changes
-dataset.push_to_hub("AI-EcoNet/ViT_animal_data")
-```
-
 ## Citation
 
-If you use this dataset, please cite appropriately.
+If you use this dataset, please cite appropriately. Each species folder contains the original image source and datasets from LILA BC.
 
 ```bibtex
-@dataset{vit_animal_dataset,
-  title={ViT Animal Dataset},
-  author={AI-EcoNet},
+@dataset{markoff2025vit_animal_dataset,
+  title={ViT Animal Dataset: Camera Trap Images for Vision Transformer Evaluation},
+  author={Markoff, Hugo and Galaktionovs, Jurijs},
   year={2025},
   publisher={Hugging Face},
   howpublished={\url{https://huggingface.co/datasets/AI-EcoNet/ViT_animal_data}}
 }
 ```
+
+## Acknowledgments
+
+This dataset aggregates cropped images from 23 camera trap datasets available through LILA BC (Labeled Information Library of Alexandria: Biology and Conservation). We thank all the organizations and researchers who contributed to the original camera trap projects.