Initial commit

README.md

@@ -0,0 +1,61 @@
+# Dataset Card for llm-book/wrime-sentiment
+日本語の感情分析データセット WRIME を、ポジティブ/ネガティブの二値分類のタスクに加工したデータセットです。
+GitHub リポジトリ [ids-cv/wrime](https://github.com/ids-cv/wrime) で公開されているデータセットを利用しています。
+
+書籍『大規模言語モデル入門』のサンプルコードで利用することを想定しています。
+詳しくは[書籍のGitHubリポジトリ](https://github.com/ghmagazine/llm-book)をご覧ください。
+
+## 使い方
+以下のようにデータセットを読み込むことができます。
+```python
+from datasets import load_dataset
+
+dataset = load_dataset("hf_datasets/wrime-sentiment")
+print(dataset["train"].features["label"])
+print(dataset)
+```
+
+```python
+ClassLabel(names=['positive', 'negative'], id=None)
+DatasetDict({
+    train: Dataset({
+        features: ['sentence', 'label'],
+        num_rows: 20149
+    })
+    validation: Dataset({
+        features: ['sentence', 'label'],
+        num_rows: 1608
+    })
+    test: Dataset({
+        features: ['sentence', 'label'],
+        num_rows: 1781
+    })
+})
+```
+デフォルトの設定では、元のデータセットから極性がニュートラルであるものを除いています。
+`remove_netural=False`と指定することで、ニュートラルなデータも含めた三値分類のデータセットを読み込むことができます。
+```python
+from datasets import load_dataset
+
+dataset = load_dataset("hf_datasets/wrime-sentiment", remove_neutral=False)
+print(dataset["train"].features["label"])
+print(dataset)
+```
+
+```python
+ClassLabel(names=['positive', 'negative', 'neutral'], id=None)
+DatasetDict({
+    train: Dataset({
+        features: ['sentence', 'label'],
+        num_rows: 30000
+    })
+    validation: Dataset({
+        features: ['sentence', 'label'],
+        num_rows: 2500
+    })
+    test: Dataset({
+        features: ['sentence', 'label'],
+        num_rows: 2500
+    })
+})
+```

wrime-sentiment.py

@@ -0,0 +1,96 @@
+import csv
+from dataclasses import dataclass
+from typing import Any, Dict, List, Tuple
+
+import datasets
+
+logger = datasets.logging.get_logger(__name__)
+
+_DESCRIPTION = (
+    "日本語の感情分析データセット WRIME を、ポジティブ/ネガティブの二値分類のタスクに加工したデータセットです。"
+    "GitHub リポジトリ ids-cv/wrime で公開されているデータセットを利用しています。"
+)
+
+_URL = "https://raw.githubusercontent.com/ids-cv/wrime/master/wrime-ver2.tsv"
+
+
+@dataclass
+class WrimeSentimentConfig(datasets.BuilderConfig):
+    remove_neutral: bool = True
+
+
+class WrimeSentiment(datasets.GeneratorBasedBuilder):
+    BUILDER_CONFIG_CLASS = WrimeSentimentConfig
+
+    def _info(self) -> datasets.DatasetInfo:
+        labels = ["positive", "negative"]
+        if not self.config.remove_neutral:
+            labels += ["neutral"]
+        return datasets.DatasetInfo(
+            description=_DESCRIPTION,
+            features=datasets.Features(
+                {
+                    "sentence": datasets.Value("string"),
+                    "label": datasets.ClassLabel(
+                        num_classes=len(labels), names=labels
+                    ),
+                }
+            ),
+        )
+
+    def _split_generators(
+        self, dl_manager: datasets.DownloadManager
+    ) -> List[datasets.SplitGenerator]:
+        downloaded_file = dl_manager.download_and_extract(_URL)
+        return [
+            datasets.SplitGenerator(
+                name=datasets.Split.TRAIN,
+                gen_kwargs={
+                    "filepath": downloaded_file,
+                    "split": "train",
+                },
+            ),
+            datasets.SplitGenerator(
+                name=datasets.Split.VALIDATION,
+                gen_kwargs={
+                    "filepath": downloaded_file,
+                    "split": "dev",
+                },
+            ),
+            datasets.SplitGenerator(
+                name=datasets.Split.TEST,
+                gen_kwargs={
+                    "filepath": downloaded_file,
+                    "split": "test",
+                },
+            ),
+        ]
+
+    def _generate_examples(
+        self, filepath: str, split: str
+    ) -> Tuple[str, Dict[str, Any]]:
+        logger.info(f"generating examples from {filepath}")
+        _key = 0
+
+        with open(filepath, "r") as f:
+            reader = csv.DictReader(f, delimiter="\t")
+            for data in reader:
+                if data["Train/Dev/Test"].lower() != split:
+                    continue
+
+                sentiment_score = int(data["Avg. Readers_Sentiment"])
+                if sentiment_score > 0:
+                    label = "positive"
+                elif sentiment_score < 0:
+                    label = "negative"
+                else:
+                    label = "neutral"
+
+                if self.config.remove_neutral and label == "neutral":
+                    continue
+
+                yield _key, {
+                    "sentence": data["Sentence"],
+                    "label": label,
+                }
+                _key += 1