Add WIT

README.md

@@ -1,3 +1,346 @@
 ---
-license: cc-by-sa-3.0
+annotations_creators:
+- machine-generated
+language_creators:
+- found
+languages:
+- af
+- ar
+- ast
+- azb
+- be
+- bg
+- bn
+- br
+- ca
+- cs
+- cy
+- da
+- de
+- el
+- en
+- eo
+- es
+- et
+- eu
+- fa
+- fi
+- fr
+- fy
+- ga
+- gl
+- hr
+- hu
+- hy
+- id
+- it
+- iw
+- ja
+- ka
+- ko
+- la
+- lt
+- lv
+- mk
+- ml
+- ms
+- nl
+- nn
+- 'no'
+- pl
+- pt
+- ro
+- ru
+- sk
+- sl
+- sr
+- sv
+- th
+- tr
+- uk
+- ur
+- vi
+- vo
+- zh
+licenses:
+- cc-by-sa-3.0
+multilinguality:
+- multilingual
+paperswithcode_id: wit
+pretty_name: Wikipedia-based Image Text
+size_categories:
+- 10M<n<100M
+source_datasets:
+- original
+- extended|wikipedia
+task_categories:
+- text-retrieval
+- image-to-text
+task_ids:
+- text-retrieval-other-text-image-retrieval
+- image-captioning
 ---
+
+# Dataset Card for WIT
+
+## Table of Contents
+- [Table of Contents](#table-of-contents)
+- [Dataset Description](#dataset-description)
+  - [Dataset Summary](#dataset-summary)
+  - [Dataset Preprocessing](#dataset-preprocessing)
+  - [Supported Tasks and Leaderboards](#supported-tasks-and-leaderboards)
+  - [Languages](#languages)
+- [Dataset Structure](#dataset-structure)
+  - [Data Instances](#data-instances)
+  - [Data Fields](#data-fields)
+  - [Data Splits](#data-splits)
+- [Dataset Creation](#dataset-creation)
+  - [Curation Rationale](#curation-rationale)
+  - [Source Data](#source-data)
+  - [Annotations](#annotations)
+  - [Personal and Sensitive Information](#personal-and-sensitive-information)
+- [Considerations for Using the Data](#considerations-for-using-the-data)
+  - [Social Impact of Dataset](#social-impact-of-dataset)
+  - [Discussion of Biases](#discussion-of-biases)
+  - [Other Known Limitations](#other-known-limitations)
+- [Additional Information](#additional-information)
+  - [Dataset Curators](#dataset-curators)
+  - [Licensing Information](#licensing-information)
+  - [Citation Information](#citation-information)
+  - [Contributions](#contributions)
+
+## Dataset Description
+
+- **Homepage:** [WIT homepage](https://github.com/google-research-datasets/wit)
+- **Repository:** [WIT repository](https://github.com/google-research-datasets/wit)
+- **Paper:** [WIT: Wikipedia-based Image Text Dataset for Multimodal Multilingual Machine Learning
+](https://arxiv.org/abs/2103.01913)
+- **Leaderboard:** [WIT leaderboard](https://www.kaggle.com/c/wikipedia-image-caption)
+- **Point of Contact:** [WIT e-mail](mailto:wit-dataset@google.com)
+
+### Dataset Summary
+
+Wikipedia-based Image Text (WIT) Dataset is a large multimodal multilingual dataset. WIT is composed of a curated set of 37.6 million entity rich image-text examples with 11.5 million unique images across 108 Wikipedia languages. Its size enables WIT to be used as a pretraining dataset for multimodal machine learning models.
+
+A few unique advantages of WIT:
+
+* The largest multimodal dataset (time of this writing) by the number of image-text examples.
+* A massively multilingual (first of its kind) with coverage for over 100+ languages.
+* A collection of diverse set of concepts and real world entities.
+* Brings forth challenging real-world test sets.
+
+### Dataset Preprocessing
+
+This dataset doesn't download the images locally by default. Instead, it exposes URLs to the images. To fetch the images, use the following code:
+
+```python
+from concurrent.futures import ThreadPoolExecutor
+from functools import partial
+import io
+import urllib
+
+import PIL.Image
+
+from datasets import load_dataset
+from datasets.utils.file_utils import get_datasets_user_agent
+
+
+def fetch_single_image(image_url, timeout=None, retries=0):
+    for _ in range(retries + 1):
+        try:
+            request = urllib.request.Request(
+                image_url,
+                data=None,
+                headers={"user-agent": get_datasets_user_agent()},
+            )
+            with urllib.request.urlopen(request, timeout=timeout) as req:
+                image = PIL.Image.open(io.BytesIO(req.read()))
+            break
+        except Exception:
+            image = None
+    return image
+
+
+def fetch_images(batch, num_threads, timeout=None, retries=0):
+    fetch_single_image_with_args = partial(fetch_single_image, timeout=timeout, retries=retries)
+    with ThreadPoolExecutor(max_workers=num_threads) as executor:
+        batch["image"] = list(executor.map(fetch_single_image_with_args, batch["image_url"]))
+    return batch
+
+
+num_threads = 20
+dset = load_dataset("wit")
+dset = dset.map(fetch_images, batched=True, batch_size=100, fn_kwargs={"num_threads": num_threads})
+```
+
+### Supported Tasks and Leaderboards
+
+- `image-captioning`: This dataset can be used to train a model for image captioning where the goal is to predict a caption given the image.
+
+- `text-retrieval`: The goal in this task is to build a model that retrieves the text closest to an image.
+
+In these tasks, any combination of the `caption_reference_description`, `caption_attribution_description` and `caption_alt_text_description` fields can be used as the input text/caption. 
+
+### Languages
+
+The dataset contains examples from all Wikipedia languages, with the following stats:
+
+Image-Text   | # Lang | Uniq. Images  | # Lang
+------------ | ------ | ------------- | ------
+total > 1M   | 9      | images > 1M   | 6
+total > 500K | 10     | images > 500K | 12
+total > 100K | 36     | images > 100K | 35
+total > 50K  | 15     | images > 50K  | 17
+total > 14K  | 38     | images > 13K  | 38
+
+## Dataset Structure
+
+### Data Instances
+
+```
+{
+  'language': 'en',
+  'page_url': 'https://en.wikipedia.org/wiki/Oxydactylus',
+  'image_url': 'https://upload.wikimedia.org/wikipedia/commons/5/5f/Oxydactylus_longipes_fm.jpg',
+  'page_title': 'Oxydactylus',
+  'section_title': None,
+  'hierarchical_section_title': 'Oxydactylus',
+  'caption_reference_description': None,
+  'caption_attribution_description': 'English: Mounted skeleton of Oxydactylus longipes in the Field Museum of Natural History.',
+  'caption_alt_text_description': None,
+  'mime_type': 'image/jpeg',
+  'original_height': 3564,
+  'original_width': 2748,
+  'is_main_image': True,
+  'attribution_passes_lang_id': True,
+  'page_changed_recently': True,
+  'context_page_description': 'Oxydactylus is an extinct genus of camelid endemic to North America. It lived from the Late Oligocene to the Middle Miocene, existing for approximately 14 million years. The name is from the Ancient Greek οξύς and δάκτυλος.\nThey had very long legs and necks, and were probably adapted to eating high vegetation, much like modern giraffes. Unlike modern camelids, they had hooves, rather than tough sole-pads, and splayed toes.',
+  'context_section_description': 'Oxydactylus is an extinct genus of camelid endemic to North America. It lived from the Late Oligocene to the Middle Miocene (28.4–13.7 mya), existing for approximately 14 million years. The name is from the Ancient Greek οξύς (oxys, "sharp")and δάκτυλος (daktylos, "finger").\n \nThey had very long legs and necks, and were probably adapted to eating high vegetation, much like modern giraffes. Unlike modern camelids, they had hooves, rather than tough sole-pads, and splayed toes.'
+}
+```
+
+### Data Fields
+
+- `language`: Language code depicting wikipedia language of the page
+- `page_url`: URL to wikipedia page
+- `image_url`: URL to wikipedia image
+- `page_title`: Wikipedia page's title
+- `section_title`: Section's title
+- `hierarchical_section_title`: Hierarchical section's title
+- `caption_reference_description`: This is the caption that is visible on the wiki page directly below the image.
+- `caption_attribution_description`: This is the text found on the Wikimedia page of the image. This text is common to all occurrences of that image across all Wikipedias and thus can be in a language different to the original page article.
+- `caption_alt_text_description`: This is the “alt” text associated with the image. While not visible in general, it is commonly used for accessibility / screen readers
+- `mime_type`: Mime type associated to the image.
+- `original_height`: Image height
+- `original_width`: Image width
+- `is_main_image`: Flag determining if the image is the first image of the page. Usually displayed on the top-right part of the page when using web browsers.
+- `attribution_passes_lang_id`: Compared `language` field with the attribution language (written in the prefix of the attribution description). 
+- `page_changed_recently`: [More Information Needed] 
+- `context_page_description`: Page description corresponds to the short description of the page. It provides a concise explanation of the scope of the page.
+- `context_section_description`: Text within the image's section.
+
+<p align='center'>
+  <img width='75%' src='https://production-media.paperswithcode.com/datasets/Screenshot_2021-03-04_at_14.26.02.png' alt="Half Dome" /> </br>
+<b>Figure: WIT annotation example. </b>
+</p>
+
+Details on the field content can be found directly in the [paper, figure 5 and table 12.](https://arxiv.org/abs/2103.01913)
+
+### Data Splits
+
+All data is held in `train` split, with a total of 37046386 rows.
+
+## Dataset Creation
+
+### Curation Rationale
+
+From the [repository](https://github.com/google-research-datasets/wit#motivation):
+
+> Multimodal visio-linguistic models rely on a rich dataset to help them learn to model the relationship between images and texts. Having large image-text datasets can significantly improve performance, as shown by recent works. Furthermore the lack of language coverage in existing datasets (which are mostly only in English) also impedes research in the multilingual multimodal space – we consider this a lost opportunity given the potential shown in leveraging images (as a language-agnostic medium) to help improve our multilingual textual understanding.
+>
+> To address these challenges and advance research on multilingual, multimodal learning we created the Wikipedia-based Image Text (WIT) Dataset. WIT is created by extracting multiple different texts associated with an image (e.g., as shown in the above image) from Wikipedia articles and Wikimedia image links. This was accompanied by rigorous filtering to only retain high quality image-text sets.
+>
+> The resulting dataset contains over 37.6 million image-text sets – making WIT the largest multimodal dataset (publicly available at the time of this writing) with unparalleled multilingual coverage – with 12K+ examples in each of 108 languages (53 languages have 100K+ image-text pairs).
+
+### Source Data
+
+#### Initial Data Collection and Normalization
+
+From the [paper, section 3.1](https://arxiv.org/abs/2103.01913):
+
+> We started with all Wikipedia content pages (i.e., ignoring other
+pages that have discussions, comments and such). These number about ∼124M pages across 279 languages.
+
+#### Who are the source language producers?
+
+Text was extracted from Wikipedia.
+
+### Annotations
+
+#### Annotation process
+
+WIT was constructed using an automatic process. However it was human-validated.
+
+From the [paper, section 3.7](https://arxiv.org/abs/2103.01913):
+
+> To further verify the quality of the WIT dataset we performed a
+study using (crowd-sourced) human annotators. As seen in Fig. 3,
+we asked raters to answer 3 questions. Given an image and the page
+title, raters first evaluate the quality of the attribution description
+and reference description in the first two questions (order randomized). The third question understands the contextual quality of these
+text descriptions given the page description and caption. Each response is on a 3-point scale: "Yes" if the text perfectly describes
+the image, "Maybe" if it is sufficiently explanatory and "No" if it is
+irrelevant or the image is inappropriate.
+
+#### Who are the annotators?
+
+[More Information Needed]
+
+### Personal and Sensitive Information
+
+[More Information Needed]
+
+## Considerations for Using the Data
+
+### Social Impact of Dataset
+
+[More Information Needed]
+
+### Discussion of Biases
+
+From the [paper, section 3.4](https://arxiv.org/abs/2103.01913):
+
+> Lastly we found that certain image-text pairs occurred very
+frequently. These were often generic images that did not have
+much to do with the main article page. Common examples
+included flags, logos, maps, insignia and such. To prevent
+biasing the data, we heavily under-sampled all such images
+
+### Other Known Limitations
+
+[More Information Needed]
+
+## Additional Information
+
+### Dataset Curators
+
+[More Information Needed]
+
+### Licensing Information
+
+[More Information Needed]
+
+### Citation Information
+
+```bibtex
+@article{srinivasan2021wit,
+  title={WIT: Wikipedia-based Image Text Dataset for Multimodal Multilingual Machine Learning},
+  author={Srinivasan, Krishna and Raman, Karthik and Chen, Jiecao and Bendersky, Michael and Najork, Marc},
+  journal={arXiv preprint arXiv:2103.01913},
+  year={2021}
+}
+```
+
+### Contributions
+
+Thanks to [@thomasw21](https://github.com/thomasw21), [@nateraw](https://github.com/nateraw) and [hassiahk](https://github.com/hassiahk) for adding this dataset.

dataset_infos.json

@@ -0,0 +1 @@
+{"default": {"description": "Wikipedia-based Image Text (WIT) Dataset is a large multimodal multilingual dataset.\nWIT is composed of a curated set of 37.6 million entity rich image-text examples with 11.5 million unique images across 108 Wikipedia languages.\nIts size enables WIT to be used as a pretraining dataset for multimodal machine learning models.\n", "citation": "@article{srinivasan2021wit,\n  title={WIT: Wikipedia-based Image Text Dataset for Multimodal Multilingual Machine Learning},\n  author={Srinivasan, Krishna and Raman, Karthik and Chen, Jiecao and Bendersky, Michael and Najork, Marc},\n  journal={arXiv preprint arXiv:2103.01913},\n  year={2021}\n}\n", "homepage": "https://github.com/google-research-datasets/wit", "license": "Data is available under the Creative Commons Attribution-ShareAlike 3.0 Unported license.", "features": {"language": {"dtype": "string", "id": null, "_type": "Value"}, "page_url": {"dtype": "string", "id": null, "_type": "Value"}, "image_url": {"dtype": "string", "id": null, "_type": "Value"}, "page_title": {"dtype": "string", "id": null, "_type": "Value"}, "section_title": {"dtype": "string", "id": null, "_type": "Value"}, "hierarchical_section_title": {"dtype": "string", "id": null, "_type": "Value"}, "caption_reference_description": {"dtype": "string", "id": null, "_type": "Value"}, "caption_attribution_description": {"dtype": "string", "id": null, "_type": "Value"}, "caption_alt_text_description": {"dtype": "string", "id": null, "_type": "Value"}, "mime_type": {"dtype": "string", "id": null, "_type": "Value"}, "original_height": {"dtype": "int32", "id": null, "_type": "Value"}, "original_width": {"dtype": "int32", "id": null, "_type": "Value"}, "is_main_image": {"dtype": "bool", "id": null, "_type": "Value"}, "attribution_passes_lang_id": {"dtype": "bool", "id": null, "_type": "Value"}, "page_changed_recently": {"dtype": "bool", "id": null, "_type": "Value"}, "context_page_description": {"dtype": "string", "id": null, "_type": "Value"}, "context_section_description": {"dtype": "string", "id": null, "_type": "Value"}}, "post_processed": null, "supervised_keys": null, "task_templates": null, "builder_name": "wit", "config_name": "default", "version": {"version_str": "0.0.0", "description": null, "major": 0, "minor": 0, "patch": 0}, "splits": {"train": {"name": "train", "num_bytes": 69619778881, "num_examples": 37046386, "dataset_name": "wit"}}, "download_checksums": {"https://storage.googleapis.com/gresearch/wit/wit_v1.train.all-00000-of-00010.tsv.gz": {"num_bytes": 2672819495, "checksum": "1fdd379b55e559fa6d0884aa3c57066bb1f206b183b5b4ce6a8128f486f2e8b3"}, "https://storage.googleapis.com/gresearch/wit/wit_v1.train.all-00001-of-00010.tsv.gz": {"num_bytes": 2667931762, "checksum": "2fb22ceab0cd33168367fd6d268c8d803982cfe924b5d01cdf43457c32591f27"}, "https://storage.googleapis.com/gresearch/wit/wit_v1.train.all-00002-of-00010.tsv.gz": {"num_bytes": 2669251466, "checksum": "316fd4471585df14c33425a199e1fbb843ea8ae1f42b2800ddea1d959d403dcd"}, "https://storage.googleapis.com/gresearch/wit/wit_v1.train.all-00003-of-00010.tsv.gz": {"num_bytes": 2670373763, "checksum": "fdf2fb4e667de19e9dca276257322687fff597ce43d91c0ad456b5da32e3a028"}, "https://storage.googleapis.com/gresearch/wit/wit_v1.train.all-00004-of-00010.tsv.gz": {"num_bytes": 2668172723, "checksum": "16033a528ed0cabec9571f4a41c5dd039fc4c0ef84ee8e62a802ba760c79c170"}, "https://storage.googleapis.com/gresearch/wit/wit_v1.train.all-00005-of-00010.tsv.gz": {"num_bytes": 2673104331, "checksum": "a749c620fae1773d5818324c717c33ea23ce1c286daa34dcea290a056f0934ba"}, "https://storage.googleapis.com/gresearch/wit/wit_v1.train.all-00006-of-00010.tsv.gz": {"num_bytes": 2670156092, "checksum": "90e00f3f82afd21e1322ebd969958960238abaeb9c5f00cb3f053ce7e1c5e32c"}, "https://storage.googleapis.com/gresearch/wit/wit_v1.train.all-00007-of-00010.tsv.gz": {"num_bytes": 2669891774, "checksum": "b3728292b163f98858ff4c1f9f619259376ed063f9f36f0bdd66169982c40187"}, "https://storage.googleapis.com/gresearch/wit/wit_v1.train.all-00008-of-00010.tsv.gz": {"num_bytes": 2669091199, "checksum": "6104064c2981696c2a91f1aa35d952aae488ea07c2263cdc0c66b202cdb43170"}, "https://storage.googleapis.com/gresearch/wit/wit_v1.train.all-00009-of-00010.tsv.gz": {"num_bytes": 2670659115, "checksum": "3388614d12905c9a1ddb4c27445899a1f73ed75d12eaa36dd112e481330ecfaa"}}, "download_size": 26701451720, "post_processing_size": null, "dataset_size": 69619778881, "size_in_bytes": 96321230601}}

dummy/0.0.0/dummy_data.zip

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:2a32bc09f4e331daafad101808ef218731c7990f23e81b84efd31069d27ee3e3
+size 931

wit.py

@@ -0,0 +1,97 @@
+# coding=utf-8
+# Copyright 2020 The HuggingFace Datasets Authors and the current dataset script contributor.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+"""Wikipedia-based Image Text (WIT) Dataset is a large multimodal multilingual dataset"""
+import csv
+
+import datasets
+
+
+# Find for instance the citation on arxiv or on the dataset repo/website
+_CITATION = """\
+@article{srinivasan2021wit,
+  title={WIT: Wikipedia-based Image Text Dataset for Multimodal Multilingual Machine Learning},
+  author={Srinivasan, Krishna and Raman, Karthik and Chen, Jiecao and Bendersky, Michael and Najork, Marc},
+  journal={arXiv preprint arXiv:2103.01913},
+  year={2021}
+}
+"""
+
+# You can copy an official description
+_DESCRIPTION = """\
+Wikipedia-based Image Text (WIT) Dataset is a large multimodal multilingual dataset.
+WIT is composed of a curated set of 37.6 million entity rich image-text examples with 11.5 million unique images across 108 Wikipedia languages.
+Its size enables WIT to be used as a pretraining dataset for multimodal machine learning models.
+"""
+
+_HOMEPAGE = "https://github.com/google-research-datasets/wit"
+
+_LICENSE = "Data is available under the Creative Commons Attribution-ShareAlike 3.0 Unported license."
+
+_URLs = [f"https://storage.googleapis.com/gresearch/wit/wit_v1.train.all-{i:05}-of-00010.tsv.gz" for i in range(0, 10)]
+
+_FEATURES = datasets.Features(
+    {
+        "language": datasets.Value("string"),
+        "page_url": datasets.Value("string"),
+        "image_url": datasets.Value("string"),
+        "page_title": datasets.Value("string"),
+        "section_title": datasets.Value("string"),
+        "hierarchical_section_title": datasets.Value("string"),
+        "caption_reference_description": datasets.Value("string"),
+        "caption_attribution_description": datasets.Value("string"),
+        "caption_alt_text_description": datasets.Value("string"),
+        "mime_type": datasets.Value("string"),
+        "original_height": datasets.Value("int32"),
+        "original_width": datasets.Value("int32"),
+        "is_main_image": datasets.Value("bool"),
+        "attribution_passes_lang_id": datasets.Value("bool"),
+        "page_changed_recently": datasets.Value("bool"),
+        "context_page_description": datasets.Value("string"),
+        "context_section_description": datasets.Value("string"),
+    }
+)
+
+
+class WIT(datasets.GeneratorBasedBuilder):
+    """Builder for WIT."""
+
+    def _info(self):
+        return datasets.DatasetInfo(
+            description=_DESCRIPTION,
+            features=_FEATURES,
+            homepage=_HOMEPAGE,
+            license=_LICENSE,
+            citation=_CITATION,
+        )
+
+    def _split_generators(self, dl_manager):
+        files = dl_manager.download_and_extract(_URLs)
+        return [
+            datasets.SplitGenerator(
+                name=datasets.Split.TRAIN,
+                gen_kwargs={
+                    "files": files,
+                },
+            ),
+        ]
+
+    def _generate_examples(self, files):
+        idx = 0
+        for file in files:
+            with open(file, "r", encoding="utf-8") as f:
+                examples = csv.DictReader(f, delimiter="\t")
+                for example in examples:
+                    yield idx, {k: v if v != "" else None for k, v in example.items()}
+                    idx += 1