add dataset script

README.md

@@ -227,7 +227,27 @@ More stastics are listed here:
 
 ### Licensing Information
 
-[Needs More Information]
+MIT License
+
+Copyright (c) 2020 silver
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
 
 ### Citation Information
 

mmchat.py

@@ -18,8 +18,6 @@ We design various strategies to ensure the quality of the dialogues in MMChat.
 """
 
 import json
-import os
-
 import datasets
 
 
@@ -52,29 +50,38 @@ _HOMEPAGE = "https://github.com/silverriver/MMChat"
 _LICENSE = "MIT"
 
 _URLS = {
-    "mmchat": ["https://huggingface.co/datasets/silver/mmchat/resolve/main/mmchat.tgz"],
-    "mmchat_hf": ["https://huggingface.co/datasets/silver/mmchat/resolve/main/mmchat_hf.tgz"],
+    "mmchat": { 
+        "train": [ 
+            "https://huggingface.co/datasets/silver/mmchat/resolve/main/mmchat/dialog_train.jsonl.gz",
+            "https://huggingface.co/datasets/silver/mmchat/resolve/main/mmchat/img_url_train.jsonl.gz",
+            "https://huggingface.co/datasets/silver/mmchat/resolve/main/mmchat/weibo_train.jsonl.gz",
+        ],
+        "dev": [ 
+            "https://huggingface.co/datasets/silver/mmchat/resolve/main/mmchat/dialog_dev.jsonl.gz",
+            "https://huggingface.co/datasets/silver/mmchat/resolve/main/mmchat/img_url_dev.jsonl.gz",
+            "https://huggingface.co/datasets/silver/mmchat/resolve/main/mmchat/weibo_dev.jsonl.gz",
+        ],
+        "test": [ 
+            "https://huggingface.co/datasets/silver/mmchat/resolve/main/mmchat/dialog_test.jsonl.gz",
+            "https://huggingface.co/datasets/silver/mmchat/resolve/main/mmchat/img_url_test.jsonl.gz",
+            "https://huggingface.co/datasets/silver/mmchat/resolve/main/mmchat/weibo_test.jsonl.gz",
+        ]
+    },
+    "mmchat_hf": [
+        "https://huggingface.co/datasets/silver/mmchat/resolve/main/mmchat_hf/dialog.jsonl.gz",
+        "https://huggingface.co/datasets/silver/mmchat/resolve/main/mmchat_hf/weibo_img_expanded_url.jsonl.gz",
+        "https://huggingface.co/datasets/silver/mmchat/resolve/main/mmchat_hf/weibo.jsonl.gz",
+        "https://huggingface.co/datasets/silver/mmchat/resolve/main/mmchat_hf/human_annotation.jsonl.gz",
+    ],
     "mmchat_raw": [
-        "https://huggingface.co/datasets/silver/mmchat/resolve/main/mmchat_raw/MMChat_split0.tgz",
-        "https://huggingface.co/datasets/silver/mmchat/resolve/main/mmchat_raw/MMChat_split1.tgz",
-        "https://huggingface.co/datasets/silver/mmchat/resolve/main/mmchat_raw/MMChat_split2.tgz",
-        "https://huggingface.co/datasets/silver/mmchat/resolve/main/mmchat_raw/MMChat_split3.tgz",
-        "https://huggingface.co/datasets/silver/mmchat/resolve/main/mmchat_raw/MMChat_split4.tgz",
-        "https://huggingface.co/datasets/silver/mmchat/resolve/main/mmchat_raw/MMChat_split5.tgz",
-        "https://huggingface.co/datasets/silver/mmchat/resolve/main/mmchat_raw/MMChat_split6.tgz",
-        "https://huggingface.co/datasets/silver/mmchat/resolve/main/mmchat_raw/MMChat_split7.tgz",
-        "https://huggingface.co/datasets/silver/mmchat/resolve/main/mmchat_raw/MMChat_split8.tgz",
+        "https://huggingface.co/datasets/silver/mmchat/resolve/main/mmchat_raw/dialog_raw.jsonl.gz",
+        "https://huggingface.co/datasets/silver/mmchat/resolve/main/mmchat_raw/weibo_img_expanded_url_raw.jsonl.gz",
+        "https://huggingface.co/datasets/silver/mmchat/resolve/main/mmchat_raw/weibo_raw.jsonl.gz",
     ],
     "mmchat_lccc_filtered": [
-        "https://huggingface.co/datasets/silver/mmchat/resolve/main/mmchat_lccc_filtered/MMChat_lccc_flt_split0.tgz",
-        "https://huggingface.co/datasets/silver/mmchat/resolve/main/mmchat_lccc_filtered/MMChat_lccc_flt_split1.tgz",
-        "https://huggingface.co/datasets/silver/mmchat/resolve/main/mmchat_lccc_filtered/MMChat_lccc_flt_split2.tgz",
-        "https://huggingface.co/datasets/silver/mmchat/resolve/main/mmchat_lccc_filtered/MMChat_lccc_flt_split3.tgz",
-        "https://huggingface.co/datasets/silver/mmchat/resolve/main/mmchat_lccc_filtered/MMChat_lccc_flt_split4.tgz",
-        "https://huggingface.co/datasets/silver/mmchat/resolve/main/mmchat_lccc_filtered/MMChat_lccc_flt_split5.tgz",
-        "https://huggingface.co/datasets/silver/mmchat/resolve/main/mmchat_lccc_filtered/MMChat_lccc_flt_split6.tgz",
-        "https://huggingface.co/datasets/silver/mmchat/resolve/main/mmchat_lccc_filtered/MMChat_lccc_flt_split7.tgz",
-        "https://huggingface.co/datasets/silver/mmchat/resolve/main/mmchat_lccc_filtered/MMChat_lccc_flt_split8.tgz",
+        "https://huggingface.co/datasets/silver/mmchat/resolve/main/mmchat_lccc_filtered/dialog_lccc_flt.jsonl.gz",
+        "https://huggingface.co/datasets/silver/mmchat/resolve/main/mmchat_lccc_filtered/weibo_img_expanded_url_lccc_flt.jsonl.gz",
+        "https://huggingface.co/datasets/silver/mmchat/resolve/main/mmchat_lccc_filtered/weibo_lccc_flt.jsonl.gz",
     ],
 }
 
@@ -138,116 +145,87 @@ class MMChat(datasets.GeneratorBasedBuilder):
                 datasets.SplitGenerator(
                     name=datasets.Split.TRAIN,
                     gen_kwargs={
-                        "dialog_files": [os.path.join(i, "dialog_train.jsonl") for i in data_dir],
-                        "weibo_files": [os.path.join(i, "weibo_train.jsonl") for i in data_dir],
-                        "img_files": [os.path.join(i, "img_url_train.jsonl") for i in data_dir],
-                        "label_files": [],
+                        "dialog_file": data_dir["train"][0],
+                        "weibo_file": data_dir["train"][2],
+                        "img_file": data_dir["train"][1],
+                        "label_file": None,
                     },
                 ),
                 datasets.SplitGenerator(
                     name=datasets.Split.TEST,
                     gen_kwargs={
-                        "dialog_files": [os.path.join(i, "dialog_test.jsonl") for i in data_dir],
-                        "weibo_files": [os.path.join(i, "weibo_test.jsonl") for i in data_dir],
-                        "img_files": [os.path.join(i, "img_url_test.jsonl") for i in data_dir],
-                        "label_files": [],
+                        "dialog_file": data_dir["test"][0],
+                        "weibo_file": data_dir["test"][2],
+                        "img_file": data_dir["test"][1],
+                        "label_file": None,
                     },
                 ),
                 datasets.SplitGenerator(
                     name=datasets.Split.VALIDATION,
                     gen_kwargs={
-                        "dialog_files": [os.path.join(i, "dialog_dev.jsonl") for i in data_dir],
-                        "weibo_files": [os.path.join(i, "weibo_dev.jsonl") for i in data_dir],
-                        "img_files": [os.path.join(i, "img_url_dev.jsonl") for i in data_dir],
-                        "label_files": [],
-                    },
-                ),
-            ]
-        elif self.config.name == "mmchat_hf":
-            return [
-                datasets.SplitGenerator(
-                    name=datasets.Split.TRAIN,
-                    gen_kwargs={
-                        "dialog_files": [os.path.join(i, "dialog.jsonl") for i in data_dir],
-                        "weibo_files": [os.path.join(i, "weibo.jsonl") for i in data_dir],
-                        "img_files": [os.path.join(i, "weibo_img_expanded_url.jsonl") for i in data_dir],
-                        "label_files": [os.path.join(i, "human_annotation.jsonl") for i in data_dir],
+                        "dialog_file": data_dir["dev"][0],
+                        "weibo_file": data_dir["dev"][2],
+                        "img_file": data_dir["dev"][1],
+                        "label_file": None,
                     },
                 ),
             ]
-        elif self.config.name == "mmchat_lccc_filtered":
-            return [
-                datasets.SplitGenerator(
-                    name=datasets.Split.TRAIN,
-                    gen_kwargs={
-                        "dialog_files": [os.path.join(i, "dialog_lccc_flt.jsonl") for i in data_dir],
-                        "weibo_files": [os.path.join(i, "weibo_lccc_flt.jsonl") for i in data_dir],
-                        "img_files": [os.path.join(i, "weibo_img_expanded_url_lccc_flt.jsonl") for i in data_dir],
-                        "label_files": [],
-                    },
-                ),
-            ]
-        elif self.config.name == "mmchat_raw":
+        else:
             return [
                 datasets.SplitGenerator(
                     name=datasets.Split.TRAIN,
                     gen_kwargs={
-                        "dialog_files": [os.path.join(i, "dialog.jsonl") for i in data_dir],
-                        "weibo_files": [os.path.join(i, "weibo.jsonl") for i in data_dir],
-                        "img_files": [os.path.join(i, "weibo_img_expanded_url.jsonl") for i in data_dir],
-                        "label_files": [],
+                        "dialog_file": data_dir[0],
+                        "weibo_file": data_dir[2],
+                        "img_file": data_dir[1],
+                        "label_file": data_dir[3] if len(data_dir) == 4 else None,
                     },
                 ),
             ]
 
     # method parameters are unpacked from `gen_kwargs` as given in `_split_generators`
-    def _generate_examples(self, dialog_files, weibo_files, img_files, label_files):
+    def _generate_examples(self, dialog_file, weibo_file, img_file, label_file):
         id = 0
-        assert len(dialog_files) == len(weibo_files) == len(img_files)
-        if len(label_files) == 0:
-            label_files = [None] * len(dialog_files)
-        for dialog_file, weibo_file, img_file, label_file in zip(dialog_files, weibo_files, img_files, label_files):
-            if label_file is not None:
-                label_f = open(label_file, encoding="utf-8")
-
-            with open(dialog_file, encoding="utf-8") as dialog_f, open(weibo_file, encoding="utf-8") as weibo_f, open(
-                img_file, encoding="utf-8"
-            ) as img_f:
-                while True:
-                    try:
-                        dialog_line = dialog_f.readline().strip()
-                        if len(dialog_line) == 0:
-                            break
-                        dialog = json.loads(dialog_line)  # dialog_f.readline())
-                        weibo = json.loads(weibo_f.readline())
-                        if self.config.name == "mmchat":
-                            imgs = img_f.readline().strip().split(";")
-                        else:
-                            imgs = json.loads(img_f.readline())["weibo_img"].split(";")
-
-                        if self.config.name == "mmchat_hf":
-                            label = json.loads(label_f.readline())
-                            # Yields examples as (key, example) tuples
-                            yield id, {
-                                "dialog": dialog,
-                                "weibo_content": weibo,
-                                "imgs": imgs,
-                                "labels": {
-                                    "image_qualified": True if label["image_quality"] == "1" else False,
-                                    "dialog_qualified": True if label["dialog_quality"] == "1" else False,
-                                    "dialog_image_related": True
-                                    if label["dialog_image_relativeness"] == "1"
-                                    else False,
-                                },
-                            }
-                        else:
-                            yield id, {
-                                "dialog": dialog,
-                                "weibo_content": weibo,
-                                "imgs": imgs,
-                            }
-                        id += 1
-                    except EOFError:
+        if label_file is not None:
+            label_f = open(label_file, encoding="utf-8")
+
+        with open(dialog_file, encoding="utf-8") as dialog_f, open(weibo_file, encoding="utf-8") as weibo_f, open(
+            img_file, encoding="utf-8") as img_f:
+            while True:
+                try:
+                    dialog_line = dialog_f.readline().strip()
+                    if len(dialog_line) == 0:
                         break
-            if label_file is not None:
-                label_f.close()
+                    dialog = json.loads(dialog_line)  # dialog_f.readline())
+                    weibo = json.loads(weibo_f.readline())
+                    if self.config.name == "mmchat":
+                        imgs = img_f.readline().strip().split(";")
+                    else:
+                        imgs = json.loads(img_f.readline())["weibo_img"].split(";")
+
+                    if self.config.name == "mmchat_hf":
+                        label = json.loads(label_f.readline())
+                        # Yields examples as (key, example) tuples
+                        yield id, {
+                            "dialog": dialog,
+                            "weibo_content": weibo,
+                            "imgs": imgs,
+                            "labels": {
+                                "image_qualified": True if label["image_quality"] == "1" else False,
+                                "dialog_qualified": True if label["dialog_quality"] == "1" else False,
+                                "dialog_image_related": True
+                                if label["dialog_image_relativeness"] == "1"
+                                else False,
+                            },
+                        }
+                    else:
+                        yield id, {
+                            "dialog": dialog,
+                            "weibo_content": weibo,
+                            "imgs": imgs,
+                        }
+                    id += 1
+                except EOFError:
+                    break
+        if label_file is not None:
+            label_f.close()