adds birds labels, bird species dataset script and test script

.gitignore

@@ -0,0 +1 @@
+data/

bird-species-dataset.py

@@ -0,0 +1,93 @@
+import os
+import datasets
+from datasets import SplitGenerator, Split, ImageClassification
+from kaggle.api.kaggle_api_extended import KaggleApi
+
+_CITATION = """\
+@TECHREPORT{gpiosenka/100-bird-species,
+    author = {gpiosenka},
+    title = {BIRDS 525 SPECIES- IMAGE CLASSIFICATION},
+    institution = {},
+    year = {2023}
+}
+"""
+
+_DESCRIPTION = """\
+A dataset of bird species downloaded from kaggle. """
+
+_HOMEPAGE = "https://www.kaggle.com/datasets/gpiosenka/100-bird-species/"
+
+_DATA_DIR = 'data/'
+
+def _CLASSES() -> list[str]:
+    # reads from bird_labels.txt, line by line
+    with open("birds_labels.txt") as f:
+        return f.read().splitlines()
+
+class BirdSpeciesDatasetDataset(datasets.GeneratorBasedBuilder):
+    VERSION = datasets.Version("0.1.0")
+
+    BUILDER_CONFIGS = [
+        datasets.BuilderConfig(
+            name="plain_text",
+            version=datasets.Version("0.1.0", ""),
+            description="Import of BIRDS 525 SPECIES Data Set",
+        )
+    ]
+
+    def _info(self):
+        _NAMES = _CLASSES()
+
+        return datasets.DatasetInfo(
+            description=_DESCRIPTION,
+            features=datasets.Features(
+                {
+                    "image": datasets.Image(),
+                    "label": datasets.features.ClassLabel(names=_NAMES),
+                }
+            ),
+            supervised_keys=("image", "label"),
+            homepage=_HOMEPAGE,
+            citation=_CITATION,
+            task_templates=ImageClassification(image_column="image", label_column="label"),
+        )
+    
+    def _split_generators(self, dl_manager):
+        data_dir = _DATA_DIR
+        # Downloading the dataset
+        if not os.path.exists(data_dir):
+            kaggle_api = KaggleApi()
+            kaggle_api.authenticate()
+            kaggle_api.dataset_download_files('gpiosenka/100-bird-species', path=data_dir, unzip=True)
+
+            # There is a bug in the dataset, where one of the folders is named "PARAKETT  AUKLET" instead of "PARAKETT AUKLET"
+            # We fix it by adding a space to the valid folder, because train and test are wrong and also the names in the labels file
+            # Fixing the path
+            fault_path = os.path.join(data_dir, 'valid', 'PARAKETT AUKLET')
+            correct_path = os.path.join(data_dir, 'valid', 'PARAKETT  AUKLET')
+            os.rename(fault_path, correct_path)
+
+        return [
+            SplitGenerator(name=Split.TRAIN, gen_kwargs={"filepath": os.path.join(data_dir, "train")}),
+            SplitGenerator(name=Split.VALIDATION, gen_kwargs={"filepath": os.path.join(data_dir, "valid")}),
+            SplitGenerator(name=Split.TEST, gen_kwargs={"filepath": os.path.join(data_dir, "test")}),
+        ]
+
+    def _generate_examples(self, filepath):
+        """Yields examples."""
+        idx = 0
+        for label in os.listdir(filepath):
+            for f in os.listdir(os.path.join(filepath, label)):
+                record = {
+                    "image": os.path.join(filepath, label, f),
+                    "label": label,
+                }
+                yield idx, record
+                idx += 1
+
+    
+
+
+# To use the dataset:
+# from datasets import load_dataset
+# dataset = load_dataset('path/to/birds.py')

birds_labels.txt

@@ -0,0 +1,525 @@
+ABBOTTS BABBLER
+ABBOTTS BOOBY
+ABYSSINIAN GROUND HORNBILL
+AFRICAN CROWNED CRANE
+AFRICAN EMERALD CUCKOO
+AFRICAN FIREFINCH
+AFRICAN OYSTER CATCHER
+AFRICAN PIED HORNBILL
+AFRICAN PYGMY GOOSE
+ALBATROSS
+ALBERTS TOWHEE
+ALEXANDRINE PARAKEET
+ALPINE CHOUGH
+ALTAMIRA YELLOWTHROAT
+AMERICAN AVOCET
+AMERICAN BITTERN
+AMERICAN COOT
+AMERICAN DIPPER
+AMERICAN FLAMINGO
+AMERICAN GOLDFINCH
+AMERICAN KESTREL
+AMERICAN PIPIT
+AMERICAN REDSTART
+AMERICAN ROBIN
+AMERICAN WIGEON
+AMETHYST WOODSTAR
+ANDEAN GOOSE
+ANDEAN LAPWING
+ANDEAN SISKIN
+ANHINGA
+ANIANIAU
+ANNAS HUMMINGBIRD
+ANTBIRD
+ANTILLEAN EUPHONIA
+APAPANE
+APOSTLEBIRD
+ARARIPE MANAKIN
+ASHY STORM PETREL
+ASHY THRUSHBIRD
+ASIAN CRESTED IBIS
+ASIAN DOLLARD BIRD
+ASIAN GREEN BEE EATER
+ASIAN OPENBILL STORK
+AUCKLAND SHAQ
+AUSTRAL CANASTERO
+AUSTRALASIAN FIGBIRD
+AVADAVAT
+AZARAS SPINETAIL
+AZURE BREASTED PITTA
+AZURE JAY
+AZURE TANAGER
+AZURE TIT
+BAIKAL TEAL
+BALD EAGLE
+BALD IBIS
+BALI STARLING
+BALTIMORE ORIOLE
+BANANAQUIT
+BAND TAILED GUAN
+BANDED BROADBILL
+BANDED PITA
+BANDED STILT
+BAR-TAILED GODWIT
+BARN OWL
+BARN SWALLOW
+BARRED PUFFBIRD
+BARROWS GOLDENEYE
+BAY-BREASTED WARBLER
+BEARDED BARBET
+BEARDED BELLBIRD
+BEARDED REEDLING
+BELTED KINGFISHER
+BIRD OF PARADISE
+BLACK AND YELLOW BROADBILL
+BLACK BAZA
+BLACK BREASTED PUFFBIRD
+BLACK COCKATO
+BLACK FACED SPOONBILL
+BLACK FRANCOLIN
+BLACK HEADED CAIQUE
+BLACK NECKED STILT
+BLACK SKIMMER
+BLACK SWAN
+BLACK TAIL CRAKE
+BLACK THROATED BUSHTIT
+BLACK THROATED HUET
+BLACK THROATED WARBLER
+BLACK VENTED SHEARWATER
+BLACK VULTURE
+BLACK-CAPPED CHICKADEE
+BLACK-NECKED GREBE
+BLACK-THROATED SPARROW
+BLACKBURNIAM WARBLER
+BLONDE CRESTED WOODPECKER
+BLOOD PHEASANT
+BLUE COAU
+BLUE DACNIS
+BLUE GRAY GNATCATCHER
+BLUE GROSBEAK
+BLUE GROUSE
+BLUE HERON
+BLUE MALKOHA
+BLUE THROATED PIPING GUAN
+BLUE THROATED TOUCANET
+BOBOLINK
+BORNEAN BRISTLEHEAD
+BORNEAN LEAFBIRD
+BORNEAN PHEASANT
+BRANDT CORMARANT
+BREWERS BLACKBIRD
+BROWN CREPPER
+BROWN HEADED COWBIRD
+BROWN NOODY
+BROWN THRASHER
+BUFFLEHEAD
+BULWERS PHEASANT
+BURCHELLS COURSER
+BUSH TURKEY
+CAATINGA CACHOLOTE
+CABOTS TRAGOPAN
+CACTUS WREN
+CALIFORNIA CONDOR
+CALIFORNIA GULL
+CALIFORNIA QUAIL
+CAMPO FLICKER
+CANARY
+CANVASBACK
+CAPE GLOSSY STARLING
+CAPE LONGCLAW
+CAPE MAY WARBLER
+CAPE ROCK THRUSH
+CAPPED HERON
+CAPUCHINBIRD
+CARMINE BEE-EATER
+CASPIAN TERN
+CASSOWARY
+CEDAR WAXWING
+CERULEAN WARBLER
+CHARA DE COLLAR
+CHATTERING LORY
+CHESTNET BELLIED EUPHONIA
+CHESTNUT WINGED CUCKOO
+CHINESE BAMBOO PARTRIDGE
+CHINESE POND HERON
+CHIPPING SPARROW
+CHUCAO TAPACULO
+CHUKAR PARTRIDGE
+CINNAMON ATTILA
+CINNAMON FLYCATCHER
+CINNAMON TEAL
+CLARKS GREBE
+CLARKS NUTCRACKER
+COCK OF THE  ROCK
+COCKATOO
+COLLARED ARACARI
+COLLARED CRESCENTCHEST
+COMMON FIRECREST
+COMMON GRACKLE
+COMMON HOUSE MARTIN
+COMMON IORA
+COMMON LOON
+COMMON POORWILL
+COMMON STARLING
+COPPERSMITH BARBET
+COPPERY TAILED COUCAL
+CRAB PLOVER
+CRANE HAWK
+CREAM COLORED WOODPECKER
+CRESTED AUKLET
+CRESTED CARACARA
+CRESTED COUA
+CRESTED FIREBACK
+CRESTED KINGFISHER
+CRESTED NUTHATCH
+CRESTED OROPENDOLA
+CRESTED SERPENT EAGLE
+CRESTED SHRIKETIT
+CRESTED WOOD PARTRIDGE
+CRIMSON CHAT
+CRIMSON SUNBIRD
+CROW
+CUBAN TODY
+CUBAN TROGON
+CURL CRESTED ARACURI
+D-ARNAUDS BARBET
+DALMATIAN PELICAN
+DARJEELING WOODPECKER
+DARK EYED JUNCO
+DAURIAN REDSTART
+DEMOISELLE CRANE
+DOUBLE BARRED FINCH
+DOUBLE BRESTED CORMARANT
+DOUBLE EYED FIG PARROT
+DOWNY WOODPECKER
+DUNLIN
+DUSKY LORY
+DUSKY ROBIN
+EARED PITA
+EASTERN BLUEBIRD
+EASTERN BLUEBONNET
+EASTERN GOLDEN WEAVER
+EASTERN MEADOWLARK
+EASTERN ROSELLA
+EASTERN TOWEE
+EASTERN WIP POOR WILL
+EASTERN YELLOW ROBIN
+ECUADORIAN HILLSTAR
+EGYPTIAN GOOSE
+ELEGANT TROGON
+ELLIOTS  PHEASANT
+EMERALD TANAGER
+EMPEROR PENGUIN
+EMU
+ENGGANO MYNA
+EURASIAN BULLFINCH
+EURASIAN GOLDEN ORIOLE
+EURASIAN MAGPIE
+EUROPEAN GOLDFINCH
+EUROPEAN TURTLE DOVE
+EVENING GROSBEAK
+FAIRY BLUEBIRD
+FAIRY PENGUIN
+FAIRY TERN
+FAN TAILED WIDOW
+FASCIATED WREN
+FIERY MINIVET
+FIORDLAND PENGUIN
+FIRE TAILLED MYZORNIS
+FLAME BOWERBIRD
+FLAME TANAGER
+FOREST WAGTAIL
+FRIGATE
+FRILL BACK PIGEON
+GAMBELS QUAIL
+GANG GANG COCKATOO
+GILA WOODPECKER
+GILDED FLICKER
+GLOSSY IBIS
+GO AWAY BIRD
+GOLD WING WARBLER
+GOLDEN BOWER BIRD
+GOLDEN CHEEKED WARBLER
+GOLDEN CHLOROPHONIA
+GOLDEN EAGLE
+GOLDEN PARAKEET
+GOLDEN PHEASANT
+GOLDEN PIPIT
+GOULDIAN FINCH
+GRANDALA
+GRAY CATBIRD
+GRAY KINGBIRD
+GRAY PARTRIDGE
+GREAT ARGUS
+GREAT GRAY OWL
+GREAT JACAMAR
+GREAT KISKADEE
+GREAT POTOO
+GREAT TINAMOU
+GREAT XENOPS
+GREATER PEWEE
+GREATER PRAIRIE CHICKEN
+GREATOR SAGE GROUSE
+GREEN BROADBILL
+GREEN JAY
+GREEN MAGPIE
+GREEN WINGED DOVE
+GREY CUCKOOSHRIKE
+GREY HEADED CHACHALACA
+GREY HEADED FISH EAGLE
+GREY PLOVER
+GROVED BILLED ANI
+GUINEA TURACO
+GUINEAFOWL
+GURNEYS PITTA
+GYRFALCON
+HAMERKOP
+HARLEQUIN DUCK
+HARLEQUIN QUAIL
+HARPY EAGLE
+HAWAIIAN GOOSE
+HAWFINCH
+HELMET VANGA
+HEPATIC TANAGER
+HIMALAYAN BLUETAIL
+HIMALAYAN MONAL
+HOATZIN
+HOODED MERGANSER
+HOOPOES
+HORNED GUAN
+HORNED LARK
+HORNED SUNGEM
+HOUSE FINCH
+HOUSE SPARROW
+HYACINTH MACAW
+IBERIAN MAGPIE
+IBISBILL
+IMPERIAL SHAQ
+INCA TERN
+INDIAN BUSTARD
+INDIAN PITTA
+INDIAN ROLLER
+INDIAN VULTURE
+INDIGO BUNTING
+INDIGO FLYCATCHER
+INLAND DOTTEREL
+IVORY BILLED ARACARI
+IVORY GULL
+IWI
+JABIRU
+JACK SNIPE
+JACOBIN PIGEON
+JANDAYA PARAKEET
+JAPANESE ROBIN
+JAVA SPARROW
+JOCOTOCO ANTPITTA
+KAGU
+KAKAPO
+KILLDEAR
+KING EIDER
+KING VULTURE
+KIWI
+KNOB BILLED DUCK
+KOOKABURRA
+LARK BUNTING
+LAUGHING GULL
+LAZULI BUNTING
+LESSER ADJUTANT
+LILAC ROLLER
+LIMPKIN
+LITTLE AUK
+LOGGERHEAD SHRIKE
+LONG-EARED OWL
+LOONEY BIRDS
+LUCIFER HUMMINGBIRD
+MAGPIE GOOSE
+MALABAR HORNBILL
+MALACHITE KINGFISHER
+MALAGASY WHITE EYE
+MALEO
+MALLARD DUCK
+MANDRIN DUCK
+MANGROVE CUCKOO
+MARABOU STORK
+MASKED BOBWHITE
+MASKED BOOBY
+MASKED LAPWING
+MCKAYS BUNTING
+MERLIN
+MIKADO  PHEASANT
+MILITARY MACAW
+MOURNING DOVE
+MYNA
+NICOBAR PIGEON
+NOISY FRIARBIRD
+NORTHERN BEARDLESS TYRANNULET
+NORTHERN CARDINAL
+NORTHERN FLICKER
+NORTHERN FULMAR
+NORTHERN GANNET
+NORTHERN GOSHAWK
+NORTHERN JACANA
+NORTHERN MOCKINGBIRD
+NORTHERN PARULA
+NORTHERN RED BISHOP
+NORTHERN SHOVELER
+OCELLATED TURKEY
+OILBIRD
+OKINAWA RAIL
+ORANGE BREASTED TROGON
+ORANGE BRESTED BUNTING
+ORIENTAL BAY OWL
+ORNATE HAWK EAGLE
+OSPREY
+OSTRICH
+OVENBIRD
+OYSTER CATCHER
+PAINTED BUNTING
+PALILA
+PALM NUT VULTURE
+PARADISE TANAGER
+PARAKETT  AUKLET
+PARUS MAJOR
+PATAGONIAN SIERRA FINCH
+PEACOCK
+PEREGRINE FALCON
+PHAINOPEPLA
+PHILIPPINE EAGLE
+PINK ROBIN
+PLUSH CRESTED JAY
+POMARINE JAEGER
+PUFFIN
+PUNA TEAL
+PURPLE FINCH
+PURPLE GALLINULE
+PURPLE MARTIN
+PURPLE SWAMPHEN
+PYGMY KINGFISHER
+PYRRHULOXIA
+QUETZAL
+RAINBOW LORIKEET
+RAZORBILL
+RED BEARDED BEE EATER
+RED BELLIED PITTA
+RED BILLED TROPICBIRD
+RED BROWED FINCH
+RED CROSSBILL
+RED FACED CORMORANT
+RED FACED WARBLER
+RED FODY
+RED HEADED DUCK
+RED HEADED WOODPECKER
+RED KNOT
+RED LEGGED HONEYCREEPER
+RED NAPED TROGON
+RED SHOULDERED HAWK
+RED TAILED HAWK
+RED TAILED THRUSH
+RED WINGED BLACKBIRD
+RED WISKERED BULBUL
+REGENT BOWERBIRD
+RING-NECKED PHEASANT
+ROADRUNNER
+ROCK DOVE
+ROSE BREASTED COCKATOO
+ROSE BREASTED GROSBEAK
+ROSEATE SPOONBILL
+ROSY FACED LOVEBIRD
+ROUGH LEG BUZZARD
+ROYAL FLYCATCHER
+RUBY CROWNED KINGLET
+RUBY THROATED HUMMINGBIRD
+RUDDY SHELDUCK
+RUDY KINGFISHER
+RUFOUS KINGFISHER
+RUFOUS TREPE
+RUFUOS MOTMOT
+SAMATRAN THRUSH
+SAND MARTIN
+SANDHILL CRANE
+SATYR TRAGOPAN
+SAYS PHOEBE
+SCARLET CROWNED FRUIT DOVE
+SCARLET FACED LIOCICHLA
+SCARLET IBIS
+SCARLET MACAW
+SCARLET TANAGER
+SHOEBILL
+SHORT BILLED DOWITCHER
+SMITHS LONGSPUR
+SNOW GOOSE
+SNOW PARTRIDGE
+SNOWY EGRET
+SNOWY OWL
+SNOWY PLOVER
+SNOWY SHEATHBILL
+SORA
+SPANGLED COTINGA
+SPLENDID WREN
+SPOON BILED SANDPIPER
+SPOTTED CATBIRD
+SPOTTED WHISTLING DUCK
+SQUACCO HERON
+SRI LANKA BLUE MAGPIE
+STEAMER DUCK
+STORK BILLED KINGFISHER
+STRIATED CARACARA
+STRIPED OWL
+STRIPPED MANAKIN
+STRIPPED SWALLOW
+SUNBITTERN
+SUPERB STARLING
+SURF SCOTER
+SWINHOES PHEASANT
+TAILORBIRD
+TAIWAN MAGPIE
+TAKAHE
+TASMANIAN HEN
+TAWNY FROGMOUTH
+TEAL DUCK
+TIT MOUSE
+TOUCHAN
+TOWNSENDS WARBLER
+TREE SWALLOW
+TRICOLORED BLACKBIRD
+TROPICAL KINGBIRD
+TRUMPTER SWAN
+TURKEY VULTURE
+TURQUOISE MOTMOT
+UMBRELLA BIRD
+VARIED THRUSH
+VEERY
+VENEZUELIAN TROUPIAL
+VERDIN
+VERMILION FLYCATHER
+VICTORIA CROWNED PIGEON
+VIOLET BACKED STARLING
+VIOLET CUCKOO
+VIOLET GREEN SWALLOW
+VIOLET TURACO
+VISAYAN HORNBILL
+VULTURINE GUINEAFOWL
+WALL CREAPER
+WATTLED CURASSOW
+WATTLED LAPWING
+WHIMBREL
+WHITE BREASTED WATERHEN
+WHITE BROWED CRAKE
+WHITE CHEEKED TURACO
+WHITE CRESTED HORNBILL
+WHITE EARED HUMMINGBIRD
+WHITE NECKED RAVEN
+WHITE TAILED TROPIC
+WHITE THROATED BEE EATER
+WILD TURKEY
+WILLOW PTARMIGAN
+WILSONS BIRD OF PARADISE
+WOOD DUCK
+WOOD THRUSH
+WOODLAND KINGFISHER
+WRENTIT
+YELLOW BELLIED FLOWERPECKER
+YELLOW BREASTED CHAT
+YELLOW CACIQUE
+YELLOW HEADED BLACKBIRD
+ZEBRA DOVE

test_dataloader.py

@@ -0,0 +1,10 @@
+from datasets import load_dataset
+import time
+
+def main():
+    for split in ["train", "validation", "test"]:
+        data = load_dataset("bird-species-dataset.py")[split]
+        print(data)
+
+if __name__=="__main__":
+    main()