Add generation scripts and update README.md

.gitignore

@@ -0,0 +1,32 @@
+.DS_Store
+
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+
+# Vim
+*.swp
+
+# Distribution / packaging
+*.egg-info/
+dist
+build
+_version.py
+
+# VScode IDE
+.vscode/
+.env
+
+# Virtual environment
+.venv/
+
+# Local data and scratch
+.scratch
+cache
+
+# Jupyter
+.ipynb_checkpoints
+
+# SLURM
+jobs
+slurm-*

README.md

@@ -125,3 +125,80 @@ configs:
   - split: validation
     path: data/validation-*
 ---
+
+# Dataset Card for ImageNet-100
+
+ImageNet-100 is a subset of ImageNet with 100 classes randomly selected from the original ImageNet-1k dataset. In addition, the images have been resized to 160 pixels on the shorter side.
+
+- **Homepage:** https://github.com/HobbitLong/CMC
+- **Paper:** https://arxiv.org/abs/1906.05849
+
+## Dataset Structure
+
+### Data Instances
+
+An example looks like below:
+
+```
+{
+  'image': <PIL.PngImagePlugin.PngImageFile image mode=RGB size=160x213>,
+  'label': 0
+}
+```
+
+### Data Fields
+
+The data instances have the following fields:
+
+- `image`: A `PIL.Image.Image` object containing the image.
+- `label`: an `int` classification label.
+
+The labels are indexed based on the sorted list of synset ids in [imagenet100.txt](https://raw.githubusercontent.com/HobbitLong/CMC/master/imagenet100.txt) which we automatically map to original class names.
+
+### Data Splits
+
+|             |train  |validation|
+|-------------|------:|---------:|
+|# of examples|126689 |5000      |
+
+## Additional Information
+
+### Licensing Information
+
+In exchange for permission to use the ImageNet database (the "Database") at Princeton University and Stanford University, Researcher hereby agrees to the following terms and conditions:
+
+1. Researcher shall use the Database only for non-commercial research and educational purposes.
+1. Princeton University and Stanford University make no representations or warranties regarding the Database, including but not limited to warranties of non-infringement or fitness for a particular purpose.
+1. Researcher accepts full responsibility for his or her use of the Database and shall defend and indemnify the ImageNet team, Princeton University, and Stanford University, including their employees, Trustees, officers and agents, against any and all claims arising from Researcher's use of the Database, including but not limited to Researcher's use of any copies of copyrighted images that he or she may create from the Database.
+1. Researcher may provide research associates and colleagues with access to the Database provided that they first agree to be bound by these terms and conditions.
+1. Princeton University and Stanford University reserve the right to terminate Researcher's access to the Database at any time.
+1. If Researcher is employed by a for-profit, commercial entity, Researcher's employer shall also be bound by these terms and conditions, and Researcher hereby represents that he or she is fully authorized to enter into this agreement on behalf of such employer.
+1. The law of the State of New Jersey shall apply to all disputes under this agreement.
+
+### Citation Information
+
+```bibtex
+@article{imagenet15russakovsky,
+    Author = {Olga Russakovsky and Jia Deng and Hao Su and Jonathan Krause and Sanjeev Satheesh and Sean Ma and Zhiheng Huang and Andrej Karpathy and Aditya Khosla and Michael Bernstein and Alexander C. Berg and Li Fei-Fei},
+    Title = { {ImageNet Large Scale Visual Recognition Challenge} },
+    Year = {2015},
+    journal   = {International Journal of Computer Vision (IJCV)},
+    doi = {10.1007/s11263-015-0816-y},
+    volume={115},
+    number={3},
+    pages={211-252}
+}
+
+@inproceedings{tian2020contrastive,
+  title={Contrastive multiview coding},
+  author={Tian, Yonglong and Krishnan, Dilip and Isola, Phillip},
+  booktitle={Computer Vision--ECCV 2020: 16th European Conference, Glasgow, UK, August 23--28, 2020, Proceedings, Part XI 16},
+  pages={776--794},
+  year={2020},
+  organization={Springer}
+}
+```
+
+### Contributions
+
+Thanks to the 🤗 authors for the [imagenet-1k](https://huggingface.co/datasets/imagenet-1k) which was used as a reference.

classes.py

@@ -0,0 +1,113 @@
+"""
+Class list for ImageNet-100.
+
+References:
+    https://github.com/HobbitLong/CMC/blob/master/imagenet100.txt
+"""
+
+from collections import OrderedDict
+
+IMAGENET100_CLASSES = OrderedDict(
+    {
+        "n02869837": "bonnet, poke bonnet",
+        "n01749939": "green mamba",
+        "n02488291": "langur",
+        "n02107142": "Doberman, Doberman pinscher",
+        "n13037406": "gyromitra",
+        "n02091831": "Saluki, gazelle hound",
+        "n04517823": "vacuum, vacuum cleaner",
+        "n04589890": "window screen",
+        "n03062245": "cocktail shaker",
+        "n01773797": "garden spider, Aranea diademata",
+        "n01735189": "garter snake, grass snake",
+        "n07831146": "carbonara",
+        "n07753275": "pineapple, ananas",
+        "n03085013": "computer keyboard, keypad",
+        "n04485082": "tripod",
+        "n02105505": "komondor",
+        "n01983481": "American lobster, Northern lobster, Maine lobster, Homarus americanus",
+        "n02788148": "bannister, banister, balustrade, balusters, handrail",
+        "n03530642": "honeycomb",
+        "n04435653": "tile roof",
+        "n02086910": "papillon",
+        "n02859443": "boathouse",
+        "n13040303": "stinkhorn, carrion fungus",
+        "n03594734": "jean, blue jean, denim",
+        "n02085620": "Chihuahua",
+        "n02099849": "Chesapeake Bay retriever",
+        "n01558993": "robin, American robin, Turdus migratorius",
+        "n04493381": "tub, vat",
+        "n02109047": "Great Dane",
+        "n04111531": "rotisserie",
+        "n02877765": "bottlecap",
+        "n04429376": "throne",
+        "n02009229": "little blue heron, Egretta caerulea",
+        "n01978455": "rock crab, Cancer irroratus",
+        "n02106550": "Rottweiler",
+        "n01820546": "lorikeet",
+        "n01692333": "Gila monster, Heloderma suspectum",
+        "n07714571": "head cabbage",
+        "n02974003": "car wheel",
+        "n02114855": "coyote, prairie wolf, brush wolf, Canis latrans",
+        "n03785016": "moped",
+        "n03764736": "milk can",
+        "n03775546": "mixing bowl",
+        "n02087046": "toy terrier",
+        "n07836838": "chocolate sauce, chocolate syrup",
+        "n04099969": "rocking chair, rocker",
+        "n04592741": "wing",
+        "n03891251": "park bench",
+        "n02701002": "ambulance",
+        "n03379051": "football helmet",
+        "n02259212": "leafhopper",
+        "n07715103": "cauliflower",
+        "n03947888": "pirate, pirate ship",
+        "n04026417": "purse",
+        "n02326432": "hare",
+        "n03637318": "lampshade, lamp shade",
+        "n01980166": "fiddler crab",
+        "n02113799": "standard poodle",
+        "n02086240": "Shih-Tzu",
+        "n03903868": "pedestal, plinth, footstall",
+        "n02483362": "gibbon, Hylobates lar",
+        "n04127249": "safety pin",
+        "n02089973": "English foxhound",
+        "n03017168": "chime, bell, gong",
+        "n02093428": "American Staffordshire terrier, Staffordshire terrier, American pit bull terrier, pit bull terrier",
+        "n02804414": "bassinet",
+        "n02396427": "wild boar, boar, Sus scrofa",
+        "n04418357": "theater curtain, theatre curtain",
+        "n02172182": "dung beetle",
+        "n01729322": "hognose snake, puff adder, sand viper",
+        "n02113978": "Mexican hairless",
+        "n03787032": "mortarboard",
+        "n02089867": "Walker hound, Walker foxhound",
+        "n02119022": "red fox, Vulpes vulpes",
+        "n03777754": "modem",
+        "n04238763": "slide rule, slipstick",
+        "n02231487": "walking stick, walkingstick, stick insect",
+        "n03032252": "cinema, movie theater, movie theatre, movie house, picture palace",
+        "n02138441": "meerkat, mierkat",
+        "n02104029": "kuvasz",
+        "n03837869": "obelisk",
+        "n03494278": "harmonica, mouth organ, harp, mouth harp",
+        "n04136333": "sarong",
+        "n03794056": "mousetrap",
+        "n03492542": "hard disc, hard disk, fixed disk",
+        "n02018207": "American coot, marsh hen, mud hen, water hen, Fulica americana",
+        "n04067472": "reel",
+        "n03930630": "pickup, pickup truck",
+        "n03584829": "iron, smoothing iron",
+        "n02123045": "tabby, tabby cat",
+        "n04229816": "ski mask",
+        "n02100583": "vizsla, Hungarian pointer",
+        "n03642806": "laptop, laptop computer",
+        "n04336792": "stretcher",
+        "n03259280": "Dutch oven",
+        "n02116738": "African hunting dog, hyena dog, Cape hunting dog, Lycaon pictus",
+        "n02108089": "boxer",
+        "n03424325": "gasmask, respirator, gas helmet",
+        "n01855672": "goose",
+        "n02090622": "borzoi, Russian wolfhound",
+    }
+)

generate.py

@@ -0,0 +1,42 @@
+"""
+Generate resized ImageNet-100 dataset.
+"""
+
+from argparse import ArgumentParser
+from functools import partial
+from pathlib import Path
+
+from datasets import load_dataset
+from torchvision.transforms import InterpolationMode
+from torchvision.transforms.functional import resize
+
+SCRIPT = str(Path(__file__).parent / "imagenet-100.py")
+
+
+def transforms(examples, size: int = 160):
+    examples["image"] = [
+        resize(image, size, interpolation=InterpolationMode.BICUBIC)
+        for image in examples["image"]
+    ]
+    return examples
+
+
+if __name__ == "__main__":
+    parser = ArgumentParser()
+    parser.add_argument("--outdir", "-o", type=str, default="cache")
+    parser.add_argument("--size", "-s", type=int, default=160)
+    parser.add_argument("--num-proc", "-n", type=int, default=8)
+    args = parser.parse_args()
+
+    dataset = load_dataset(SCRIPT)
+    dataset = dataset.map(
+        partial(transforms, size=args.size),
+        batched=True,
+        batch_size=256,
+        num_proc=args.num_proc,
+    )
+    print(dataset)
+    print(dataset["validation"][0])
+
+    outdir = Path(args.outdir) / f"imagenet-100_{args.size}"
+    dataset.save_to_disk(outdir, num_proc=args.num_proc)

imagenet-100.py

@@ -0,0 +1,90 @@
+"""
+Dataset builder for ImageNet-100.
+
+References:
+    https://huggingface.co/datasets/imagenet-1k/blob/main/imagenet-1k.py
+"""
+
+import os
+from pathlib import Path
+from typing import List
+
+import datasets
+from datasets.tasks import ImageClassification
+
+from .classes import IMAGENET100_CLASSES
+
+_CITATION = """\
+@inproceedings{tian2020contrastive,
+  title={Contrastive multiview coding},
+  author={Tian, Yonglong and Krishnan, Dilip and Isola, Phillip},
+  booktitle={Computer Vision--ECCV 2020: 16th European Conference, Glasgow, UK, August 23--28, 2020, Proceedings, Part XI 16},
+  pages={776--794},
+  year={2020},
+  organization={Springer}
+}
+"""
+
+_HOMEPAGE = "https://github.com/HobbitLong/CMC"
+
+_DESCRIPTION = f"""\
+ImageNet-100 is a subset of ImageNet with 100 classes randomly selected from the original ImageNet-1k dataset.
+"""
+
+_IMAGENET_ROOT = os.environ.get("IMAGENET_ROOT", "/data/imagenet")
+
+_DATA_URL = {
+    "train": [f"{_IMAGENET_ROOT}/train/{label}" for label in IMAGENET100_CLASSES],
+    "val": [f"{_IMAGENET_ROOT}/val/{label}" for label in IMAGENET100_CLASSES],
+}
+
+
+class Imagenet100(datasets.GeneratorBasedBuilder):
+    VERSION = datasets.Version("1.0.0")
+
+    DEFAULT_WRITER_BATCH_SIZE = 1000
+
+    def _info(self):
+        assert len(IMAGENET100_CLASSES) == 100
+        return datasets.DatasetInfo(
+            description=_DESCRIPTION,
+            features=datasets.Features(
+                {
+                    "image": datasets.Image(),
+                    "label": datasets.ClassLabel(
+                        names=list(IMAGENET100_CLASSES.values())
+                    ),
+                }
+            ),
+            homepage=_HOMEPAGE,
+            citation=_CITATION,
+            task_templates=[
+                ImageClassification(image_column="image", label_column="label")
+            ],
+        )
+
+    def _split_generators(self, dl_manager):
+        """Returns SplitGenerators."""
+
+        return [
+            datasets.SplitGenerator(
+                name=datasets.Split.TRAIN,
+                gen_kwargs={"folders": _DATA_URL["train"]},
+            ),
+            datasets.SplitGenerator(
+                name=datasets.Split.VALIDATION,
+                gen_kwargs={"folders": _DATA_URL["val"]},
+            ),
+        ]
+
+    def _generate_examples(self, folders: List[str]):
+        """Yields examples."""
+        idx = 0
+        for folder in folders:
+            synset_id = Path(folder).name
+            label = IMAGENET100_CLASSES[synset_id]
+
+            for path in Path(folder).glob("*.JPEG"):
+                ex = {"image": str(path), "label": label}
+                yield idx, ex
+                idx += 1