Initialize (#1)

* add file

* add files for tests

* add poetry files

* add .gitignore

* add settings for CI

* update test

* update test

* update test

* update scripts

* add settings for CI

* add README.md

* update README.md

* update scripts

* update README.md

.github/workflows/ci.yaml

@@ -0,0 +1,45 @@
+name: CI
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+    paths-ignore:
+      - 'README.md'
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ['3.8', '3.9', '3.10']
+
+    steps:
+      - uses: actions/checkout@v2
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v2
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: Install dependencies
+        run: |
+          pip install -U pip setuptools wheel poetry
+          poetry install
+      - name: Format
+        run: |
+          poetry run black --check .
+      - name: Lint
+        run: |
+          poetry run flake8 . --ignore=E501,W503,E203
+      - name: Type check
+        run: |
+          poetry run mypy . \
+            --ignore-missing-imports \
+            --no-strict-optional \
+            --no-site-packages \
+            --cache-dir=/dev/null
+            
+      - name: Run tests
+        run: |
+          poetry run pytest --color=yes -rf

.github/workflows/push_to_hub.yaml

@@ -0,0 +1,26 @@
+name: Sync to Hugging Face Hub
+
+on:
+  workflow_run:
+    workflows:
+      - CI
+    branches:
+      - main
+    types: 
+      - completed
+
+jobs:
+  push_to_hub:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v2
+        
+      - name: Push to Huggingface hub
+        env:
+          HF_TOKEN: ${{ secrets.HF_TOKEN }}
+          HF_USERNAME: ${{ secrets.HF_USERNAME }}
+        run: |
+          git fetch --unshallow
+          git push --force https://${HF_USERNAME}:${HF_TOKEN}@huggingface.co/datasets/${HF_USERNAME}/livedoor-news-corpus main

.gitignore

@@ -0,0 +1,170 @@
+# Created by https://www.toptal.com/developers/gitignore/api/python
+# Edit at https://www.toptal.com/developers/gitignore?templates=python
+
+### Python ###
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+.python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#pdm.lock
+#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
+#   in version control.
+#   https://pdm.fming.dev/#use-with-ide
+.pdm.toml
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+#.idea/
+
+### Python Patch ###
+# Poetry local configuration file - https://python-poetry.org/docs/configuration/#local-configuration
+poetry.toml
+
+# End of https://www.toptal.com/developers/gitignore/api/python

README.md

@@ -0,0 +1,148 @@
+# Dataset Card for Livedoor News Corpus
+
+[![CI](https://github.com/shunk031/huggingface-datasets_livedoor-news-corpus/actions/workflows/ci.yaml/badge.svg)](https://github.com/shunk031/huggingface-datasets_livedoor-news-corpus/actions/workflows/ci.yaml)
+
+## Table of Contents
+- [Table of Contents](#table-of-contents)
+- [Dataset Description](#dataset-description)
+  - [Dataset Summary](#dataset-summary)
+  - [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:** http://www.rondhuit.com/download.html#ldcc
+- **Repository:** https://github.com/shunk031/huggingface-datasets_livedoor-news-corpus
+
+### Dataset Summary
+
+> 本コーパスは、NHN Japan 株式会社が運営する「livedoor ニュース」のうち、下記のクリエイティブ・コモンズライセンスが適用されるニュース記事を収集し、可能な限り HTML タグを取り除いて作成したものです。
+
+### Supported Tasks and Leaderboards
+
+[More Information Needed]
+
+### Languages
+
+[More Information Needed]
+
+## Dataset Structure
+
+### Data Instances
+
+```python
+from datasets import load_dataset
+
+dataset = load_dataset(
+    "shunk031/livedoor-news-corpus", 
+    train_ratio=0.8,
+    val_ratio=0.1,
+    test_ratio=0.1,
+    random_state=42, 
+    shuffle=True,
+)
+
+print(dataset)
+# DatasetDict({
+#     train: Dataset({
+#         features: ['url', 'date', 'title', 'content', 'category'],
+#         num_rows: 5894
+#     })
+#     validation: Dataset({
+#         features: ['url', 'date', 'title', 'content', 'category'],
+#         num_rows: 737
+#     })
+#     test: Dataset({
+#         features: ['url', 'date', 'title', 'content', 'category'],
+#         num_rows: 736
+#     })
+# })
+```
+
+### Data Fields
+
+[More Information Needed]
+
+### Data Splits
+
+[More Information Needed]
+
+## Dataset Creation
+
+### Curation Rationale
+
+[More Information Needed]
+
+### Source Data
+
+#### Initial Data Collection and Normalization
+
+[More Information Needed]
+
+#### Who are the source language producers?
+
+[More Information Needed]
+
+### Annotations
+
+#### Annotation process
+
+[More Information Needed]
+
+#### 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
+
+[More Information Needed]
+
+### Other Known Limitations
+
+[More Information Needed]
+
+## Additional Information
+
+### Dataset Curators
+
+[More Information Needed]
+
+### Licensing Information
+
+> 各記事ファイルにはクリエイティブ・コモンズライセンス「表示 – 改変禁止」が適用されます。 クレジット表示についてはニュースカテゴリにより異なるため、ダウンロードしたファイルを展開したサブディレクトリにあるそれぞれの LICENSE.txt をご覧ください。 livedoor は NHN Japan 株式会社の登録商標です。
+
+### Citation Information
+
+[More Information Needed]
+
+### Contributions
+
+Thanks to [RONDHUIT Co., Ltd.](https://www.rondhuit.com/) for creating this dataset.

livedoor_news_corpus.py

@@ -0,0 +1,161 @@
+import logging
+import pathlib
+from typing import Dict, List, Union, Optional
+import random
+import datasets as ds
+import math
+
+logger = logging.getLogger(__name__)
+
+_CITATION = """\
+https://www.rondhuit.com/download.html#ldcc
+"""
+
+_DESCRIPTION = """\
+本コーパスは、NHN Japan株式会社が運営する「livedoor ニュース」のうち、下記のクリエイティブ・コモンズライセンスが適用されるニュース記事を収集し、可能な限りHTMLタグを取り除いて作成したものです。
+"""
+
+_HOMEPAGE = "https://www.rondhuit.com/download.html#ldcc"
+
+_LICENSE = """\
+各記事ファイルにはクリエイティブ・コモンズライセンス「表示 – 改変禁止」が適用されます。 クレジット表示についてはニュースカテゴリにより異なるため、ダウンロードしたファイルを展開したサブディレクトリにあるそれぞれの LICENSE.txt をご覧ください。 livedoor はNHN Japan株式会社の登録商標です。
+"""
+
+
+_DOWNLOAD_URL = "https://www.rondhuit.com/download/ldcc-20140209.tar.gz"
+
+
+class LivedoorNewsCorpusConfig(ds.BuilderConfig):
+    def __init__(
+        self,
+        train_ratio: float = 0.8,
+        val_ratio: float = 0.1,
+        test_ratio: float = 0.1,
+        shuffle: bool = False,
+        random_state: int = 0,
+        name: str = "default",
+        version: Optional[Union[ds.utils.Version, str]] = ds.utils.Version("0.0.0"),
+        data_dir: Optional[str] = None,
+        data_files: Optional[ds.data_files.DataFilesDict] = None,
+        description: Optional[str] = None,
+    ) -> None:
+        super().__init__(
+            name=name,
+            version=version,
+            data_dir=data_dir,
+            data_files=data_files,
+            description=description,
+        )
+        assert train_ratio + val_ratio + test_ratio == 1.0
+
+        self.train_ratio = train_ratio
+        self.val_ratio = val_ratio
+        self.test_ratio = test_ratio
+
+        self.shuffle = shuffle
+        self.random_state = random_state
+
+
+class LivedoorNewsCorpusDataset(ds.GeneratorBasedBuilder):
+    VERSION = ds.Version("1.0.0")  # type: ignore
+
+    BUILDER_CONFIG_CLASS = LivedoorNewsCorpusConfig  # type: ignore
+
+    BUILDER_CONFIGS = [
+        LivedoorNewsCorpusConfig(
+            version=VERSION,  # type: ignore
+            description="Livedoor ニュースコーパス",
+        )
+    ]
+
+    def _info(self) -> ds.DatasetInfo:
+        features = ds.Features(
+            {
+                "url": ds.Value("string"),
+                "date": ds.Value("string"),
+                "title": ds.Value("string"),
+                "content": ds.Value("string"),
+                "category": ds.ClassLabel(
+                    names=[
+                        "movie-enter",
+                        "it-life-hack",
+                        "kaden-channel",
+                        "topic-news",
+                        "livedoor-homme",
+                        "peachy",
+                        "sports-watch",
+                        "dokujo-tsushin",
+                        "smax",
+                    ]
+                ),
+            }
+        )
+        return ds.DatasetInfo(
+            description=_DESCRIPTION,
+            citation=_CITATION,
+            homepage=_HOMEPAGE,
+            license=_LICENSE,
+            features=features,
+        )
+
+    def _split_generators(self, dl_manager: ds.DownloadManager):
+        dataset_root = dl_manager.download_and_extract(_DOWNLOAD_URL)
+        dataset_root_dir = pathlib.Path(dataset_root) / "text"
+
+        article_paths = list(dataset_root_dir.glob("*/**/*.txt"))
+        article_paths = list(filter(lambda p: p.name != "LICENSE.txt", article_paths))
+
+        if self.config.shuffle:  # type: ignore
+            random.seed(self.config.random_state)  # type: ignore
+            random.shuffle(article_paths)
+
+        num_articles = len(article_paths)
+        num_tng = math.ceil(num_articles * self.config.train_ratio)  # type: ignore
+        num_val = math.ceil(num_articles * self.config.val_ratio)  # type: ignore
+        num_tst = math.ceil(num_articles * self.config.test_ratio)  # type: ignore
+
+        tng_articles = article_paths[:num_tng]
+        val_articles = article_paths[num_tng : num_tng + num_val]
+        tst_articles = article_paths[num_tng + num_val : num_tng + num_val + num_tst]
+
+        assert len(tng_articles) + len(val_articles) + len(tst_articles) == num_articles
+
+        return [
+            ds.SplitGenerator(
+                name=ds.Split.TRAIN,  # type: ignore
+                gen_kwargs={"article_paths": tng_articles},
+            ),
+            ds.SplitGenerator(
+                name=ds.Split.VALIDATION,  # type: ignore
+                gen_kwargs={"article_paths": val_articles},
+            ),
+            ds.SplitGenerator(
+                name=ds.Split.TEST,  # type: ignore
+                gen_kwargs={"article_paths": tst_articles},
+            ),
+        ]
+
+    def parse_article(self, article_data: List[str]) -> Dict[str, str]:
+        article_url = article_data[0]
+        article_date = article_data[1]
+        article_title = article_data[2]
+        article_content = " ".join(article_data[3:])
+
+        example_dict = {
+            "url": article_url,
+            "date": article_date,
+            "title": article_title,
+            "content": article_content,
+        }
+        return example_dict
+
+    def _generate_examples(self, article_paths: List[pathlib.Path]):  # type: ignore[override]
+
+        for i, article_path in enumerate(article_paths):
+            article_category = article_path.parent.name
+            with open(article_path, "r") as rf:
+                article_data = [line.strip() for line in rf]
+
+            example_dict = self.parse_article(article_data=article_data)
+            example_dict["category"] = article_category
+            yield i, example_dict

pyproject.toml

@@ -0,0 +1,23 @@
+[tool.poetry]
+name = "huggingface-datasets-livedoor-news-corpus"
+version = "0.1.0"
+description = ""
+authors = ["Shunsuke KITADA <shunsuke.kitada.0831@gmail.com>"]
+readme = "README.md"
+packages = []
+
+[tool.poetry.dependencies]
+python = ">=3.8.1,<4.0"
+datasets = "^2.8.0"
+
+
+[tool.poetry.group.dev.dependencies]
+black = "^22.12.0"
+isort = "^5.11.4"
+flake8 = "^6.0.0"
+mypy = "^0.991"
+pytest = "^7.2.1"
+
+[build-system]
+requires = ["poetry-core"]
+build-backend = "poetry.core.masonry.api"

tests/livedoor_news_corpus_test.py

@@ -0,0 +1,49 @@
+import datasets as ds
+import pytest
+
+
+@pytest.fixture
+def dataset_path() -> str:
+    return "livedoor_news_corpus.py"
+
+
+def test_load_dataset(dataset_path: str):
+    dataset = ds.load_dataset(path=dataset_path, random_state=42, shuffle=True)
+
+    assert (
+        dataset["train"].num_rows  # type: ignore
+        + dataset["validation"].num_rows  # type: ignore
+        + dataset["test"].num_rows  # type: ignore
+        == 7367
+    )
+
+    assert len(set(dataset["train"]["category"])) == 9  # type: ignore
+
+
+@pytest.mark.parametrize(
+    argnames="tng_ratio, val_ratio, tst_ratio,",
+    argvalues=(
+        (0.8, 0.1, 0.1),
+        (0.6, 0.2, 0.2),
+    ),
+)
+def test_train_valid_test_split(
+    dataset_path: str,
+    tng_ratio: float,
+    val_ratio: float,
+    tst_ratio: float,
+):
+    assert tng_ratio + val_ratio + tst_ratio == 1.0
+    dataset = ds.load_dataset(
+        path=dataset_path,
+        train_ratio=tng_ratio,
+        val_ratio=val_ratio,
+        test_ratio=tst_ratio,
+    )
+
+    assert (
+        dataset["train"].num_rows  # type: ignore
+        + dataset["validation"].num_rows  # type: ignore
+        + dataset["test"].num_rows  # type: ignore
+        == 7367
+    )