Upload README_ja.md

README_ja.md

@@ -0,0 +1,331 @@
+---
+language:
+- ja
+license: cc-by-4.0
+size_categories:
+- 10M<n<100M
+pretty_name: MOMIJI
+tags:
+- japanese
+- multimodal
+- image-text-interleaved
+- web-crawl
+viewer: false
+---
+
+
+# MOMIJI データセットカード
+
+[English](README.md) | 日本語
+
+**MOMIJI**（**M**odern **O**pen **M**ult**i**modal **J**apanese f**i**ltered Dataset）は、Common Crawl から構築した、大規模な日本語画像・テキストインターリーブデータセットです。
+
+「インターリーブ」とは、文書内でテキストと画像が現れる順序を保ったまま、それぞれを対応づけた形式を指します。MOMIJI では、画像の位置を `<image1>` のようなプレースホルダーで表します。
+
+- **データセット:** [turing-motors/MOMIJI](https://huggingface.co/datasets/turing-motors/MOMIJI)
+- **データセット構築コード:** [turingmotors/MOMIJI](https://github.com/turingmotors/MOMIJI)
+- **データ生成ユーティリティ:** [turingmotors/momiji_generator](https://github.com/turingmotors/momiji_generator)
+- **論文:** 公開予定
+
+## はじめに確認してください
+
+このリポジトリで配布しているのは、元の Web ページ本文や画像そのものではありません。
+
+配布対象は、MOMIJI のフィルタリングを通過した文書や画像を特定するための**公開レコード**です。各レコードには、元 Web ページの URL、画像 URL、画像の位置を表すプレースホルダー、画像サイズなどの付随情報（メタデータ）が含まれます。
+
+MOMIJI 公開レコードだけでは、構築時点の文書本文や画像をそのまま復元できません。`text` と `text_list` は、[`momiji_generator`](https://github.com/turingmotors/momiji_generator) を用いて、実行時点で取得可能な Web ページから生成します。Web ページの更新や削除により、生成結果は構築時点のデータと異なる場合があります。
+
+> [!WARNING]
+> MOMIJI は Web データから構築されています。NSFW（職場などでの閲覧に適さない可能性のある内容）フィルタを含む自動フィルタリングを適用していますが、公開レコードやリンク先のリソースには、不快、攻撃的、不正確、偏向的、またはその他の不適切な内容が含まれる可能性があります。利用にあたっては、内容を確認したうえで、ご自身の判断と責任のもとで取り扱ってください。
+
+## データセットの概要
+
+MOMIJI は、2024 年 2 月から 2025 年 1 月までの Common Crawl データを用いて構築しました。Common Crawl は、世界中の Web ページを継続的に収集し、そのデータを公開している非営利プロジェクトです。
+
+構築時点のデータには、約 **5,600 万文書**、**1,100 億文字**、**2 億 4,900 万件の画像参照**が含まれていました。ここでいう画像参照数は、各文書の `image_info` に記録された画像項目の総数であり、現在取得できる画像ファイル数を保証するものではありません。テキストと画像には、多段階の品質フィルタリングおよび安全性フィルタリングを適用しています。
+
+MOMIJI は、画像とテキストの両方を扱う大規模視覚言語モデル（Large Vision-Language Model; LVLM）の学習に利用できます。実際に、[Heron-NVILA-Lite](https://huggingface.co/turing-motors/Heron-NVILA-Lite-15B) は MOMIJI を用いて学習されています。
+
+MOMIJI から抽出した約 100 万件の文書は、Nomic Atlas 上で探索できます。近い内容を持つ文書が近くに配置されているため、データ全体の傾向を視覚的に確認できます。
+
+[![MOMIJI Nomic map](https://cdn-uploads.huggingface.co/production/uploads/67297c0bb5f7939284345463/gKQSb-ZLWcqmqTRa4ZKOO.png)](https://atlas.nomic.ai/data/onely7/momiji-1m/map)
+
+## 関連資源とそれぞれの役割
+
+MOMIJI では、用途に応じて利用できる 3 種類の資源を公開しています。
+
+| 資源 | 主な役割 | 含まれないもの・保証されないこと |
+| --- | --- | --- |
+| [MOMIJI 公開レコード](https://huggingface.co/datasets/turing-motors/MOMIJI) | フィルタリングを通過した文書と画像を特定するための URL、画像プレースホルダー、画像サイズ、その他のメタデータを提供します。 | 元 Web ページの全文、画像バイナリ、固定済みの `text` および `text_list` は含まれません。 |
+| [momiji_generator](https://github.com/turingmotors/momiji_generator) | 公開レコードの URL へアクセスし、実行時点で取得できる Web ページから `text` と `text_list` を生成します。 | MOMIJI 構築時点の Web ページを、完全に同じ状態で復元するものではありません。 |
+| [MOMIJI 構築コード](https://github.com/turingmotors/MOMIJI) | MOMIJI の構築に用いた AWS 版の実装と、主要な処理を小規模に再実行できるローカル版の実装を提供します。 | 外部 Web ページや画像が、構築時点から変更されずに残っていることは保証しません。 |
+
+## クイックスタート
+
+### 1. 公開レコードをダウンロードする
+
+[Hugging Face の Files and versions](https://huggingface.co/datasets/turing-motors/MOMIJI/tree/main) から、処理したい収集時期（Common Crawl リリース）の gzip 圧縮 JSONL ファイルをダウンロードします。
+
+初めて試す場合は、大量のファイルを一度に処理せず、1 ファイルと少数のレコードから始めることを推奨します。
+
+### 2. `momiji_generator` を準備する
+
+[`uv`](https://docs.astral.sh/uv/) を利用できる環境で、次のコマンドを実行します。
+
+```bash
+git clone https://github.com/turingmotors/momiji_generator.git
+cd momiji_generator
+uv sync
+```
+
+### 3. `text` と `text_list` を生成する
+
+次の例では、入力ファイルの先頭 20 件を処理します。
+
+```bash
+uv run python retrieve_text_from_jsonl.py \
+  --input_path /path/to/input.jsonl.gz \
+  --output_path /path/to/output.jsonl \
+  --limit 20
+```
+
+`--limit` は、処理するレコード数の上限です。動作確認が終わった後は、このオプションを省略して全レコードを処理できます。
+
+生成に成功したレコードには、`text` と `text_list` が追加されます。ただし、元 Web ページへアクセスできない場合や、ページ構造が変化している場合は、生成に失敗することがあります。
+
+Docker を用いた実行方法や最新のコマンドラインオプションについては、[momiji_generator の README](https://github.com/turingmotors/momiji_generator) を参照してください。
+
+## データファイルの構成
+
+公開レコードは、Common Crawl のリリースごとに分けて保存しています。
+
+```text
+CC-MAIN-2024-10/
+CC-MAIN-2024-18/
+CC-MAIN-2024-22/
+CC-MAIN-2024-26/
+CC-MAIN-2024-30/
+CC-MAIN-2024-33/
+CC-MAIN-2024-42/
+CC-MAIN-2024-46/
+CC-MAIN-2024-51/
+CC-MAIN-2025-05/
+```
+
+リポジトリ全体には約 **5,600 万件のレコード**が含まれ、ファイルサイズの合計は約 **14.7 GB** です。元 Web ページの全文や画像バイナリではなく、URL とメタデータを中心に保存しているため、構築時点のコーパス全体よりも小さな容量になっています。
+
+## データ形式
+
+### 公開レコードのトップレベルフィールド
+
+各 JSONL レコードは、MOMIJI の最終的なフィルタリングを通過した 1 件の文書に対応します。
+
+| フィールド | 型 | 説明 |
+| --- | --- | --- |
+| `docId` | `str` | 元の Common Crawl レコードに由来する文書 ID |
+| `url` | `str` | 元 Web ページの URL |
+| `image_info` | `list[dict]` | 文書内の画像に関するプレースホルダー、URL、サイズ、その他のメタデータ |
+
+### `image_info` のフィールド
+
+`image_info` の各要素には、次のフィールドが含まれる場合があります。
+
+| フィールド | 型 | 説明 |
+| --- | --- | --- |
+| `placeholder` | `str` | 文書内の画像位置を表す `<image1>` などの文字列 |
+| `url` | `str` | 元画像の URL |
+| `width` / `height` | `int` | 処理時に記録された画像の幅と高さ |
+| `original_width` / `original_height` | `int` | 取得できた場合に記録された元画像の幅と高さ |
+| `exif` | `str` またはオブジェクト | 取得できた場合に記録された EXIF（撮影機器や撮影条件などの画像付随情報） |
+| `alt` | `str` | 取得できた場合に記録された元ページの alt テキスト（画像の代替説明） |
+
+以下は、説明用の架空の値を用いた例です。
+
+```json
+{
+  "docId": "CC-MAIN-YYYYMMDDHHMMSS-EXAMPLE_00001",
+  "url": "https://example.com/article",
+  "image_info": [
+    {
+      "placeholder": "<image1>",
+      "url": "https://example.com/images/example.jpg",
+      "width": 1024,
+      "height": 768,
+      "original_width": 1024,
+      "original_height": 768,
+      "exif": "{}",
+      "alt": "画像の説明例"
+    }
+  ]
+}
+```
+
+### `momiji_generator` が追加するフィールド
+
+公開レコードには、固定済みの `text` と `text_list` は含まれていません。`momiji_generator` を実行すると、取得できた Web ページから次のフィールドを生成します。
+
+| フィールド | 型 | 説明 |
+| --- | --- | --- |
+| `text` | `str` | 画像プレースホルダーを含む、抽出後の文書全体のテキスト |
+| `text_list` | `list[str]` | 文書内の出現順に並べたテキストセグメントと画像プレースホルダー |
+
+以下は、説明用の架空の値を用いた例です。
+
+```json
+{
+  "docId": "CC-MAIN-YYYYMMDDHHMMSS-EXAMPLE_00001",
+  "url": "https://example.com/article",
+  "text_list": [
+    "最初のテキストセグメントです。",
+    "<image1>",
+    "2 番目のテキストセグメントです。"
+  ],
+  "text": "最初のテキストセグメントです。\n<image1>\n2 番目のテキストセグメントです。",
+  "image_info": [
+    {
+      "placeholder": "<image1>",
+      "url": "https://example.com/images/example.jpg",
+      "width": 1024,
+      "height": 768,
+      "original_width": 1024,
+      "original_height": 768,
+      "exif": "{}",
+      "alt": "画像の説明例"
+    }
+  ]
+}
+```
+
+`text` と `text_list` の内容は、`momiji_generator` の実行時点で取得できる Web ページに依存します。そのため、MOMIJI 構築時点のスナップショットと一致するとは限りません。
+
+## MOMIJI の統計情報
+
+以下の値は、MOMIJI 構築時点のデータに対して算出したものです。
+
+| 指標 | 値 |
+| --- | ---: |
+| 文書数 | 56,119,639 |
+| 画像参照数 | 249,745,953 |
+| 総文字数 | 109,980,725,957 |
+| 文書あたりの平均文字数 | 1,959 |
+| 文書あたりの平均画像参照数 | 4.45 |
+
+後から `momiji_generator` で生成したデータでは、元 Web ページの更新や削除により、文字数や画像数が上記の値と異なる場合があります。
+
+以下の棒グラフは、文書内の画像参照数ごとの文書数を示しています。見やすさのため、画像参照を 31 件以上含む文書は省略しています。
+
+<img src="https://cdn-uploads.huggingface.co/production/uploads/67297c0bb5f7939284345463/hTwNuGg_wNbeRsWu9ePvP.png" width="80%" alt="文書内の画像参照数ごとの文書数">
+
+## 構築パイプラインと公開コード
+
+MOMIJI の構築コードは、[MOMIJI GitHub リポジトリ](https://github.com/turingmotors/MOMIJI)を公開先としています。リポジトリには、次の 2 種類の実装が含まれます。
+
+- `build_momiji_on_aws`: Amazon S3（クラウドストレージ）、AWS Lambda（コード実行）、AWS Step Functions（処理フロー管理）などを用いて、MOMIJI 全体を構築した実装
+- `build_momiji`: AWS 固有のストレージや分散処理を、ローカルファイルと実行スクリプトに置き換えた実装
+
+ローカル版は、AWS 版の主要なフィルタリング規則、処理順序、閾値、画像プレースホルダーの扱い、出力フィールドに対応しています。ただし、大規模な分散実行環境そのものを再現する実装ではありません。
+
+## 再現できることと再現できないこと
+
+Web データは、時間とともに変化します。MOMIJI の再現性を考える際は、公開レコードの利用、現在の Web ページからのデータ生成、構築パイプラインの再実行を区別する必要があります。
+
+### 公開レコードを利用する
+
+Hugging Face から gzip 圧縮 JSONL ファイルをダウンロードすることで、構築パイプライン全体を再実行せずに、最終フィルタリングを通過した文書参照と画像参照を利用できます。
+
+### 現在取得できるインターリーブデータを生成する
+
+公開レコードに対して `momiji_generator` を実行すると、現在取得可能な Web ページから `text` と `text_list` を生成できます。
+
+ただし、この方法で得られるのは、実行時点の Web ページに基づくデータです。MOMIJI 構築時点の状態を固定的に復元するものではありません。
+
+### 構築パイプラインを再実行する
+
+`build_momiji` または `build_momiji_on_aws` に、同じ Common Crawl WARC ファイル、あるいはその一部を入力することで、本文抽出と主要なフィルタリング処理を再実行できます。
+
+MOMIJI 全体の再処理には、大規模なストレージと計算資源が必要です。全件の再処理が難しい場合でも、少数の WARC ファイルをローカル版で処理することで、次の内容を確認できます。
+
+- フィルタリング規則
+- フィルタの適用順序
+- 主要な閾値
+- 中間出力と最終出力
+
+### 完全な再現が難しい要因
+
+- **元 Web ページの変化:** ページが更新、削除、移転、アクセス制限、または構造変更されている場合があります。
+- **外部画像の変化:** 一部の画像は外部 URL から取得するため、差し替えや削除により構築時点の画像を再取得できない場合があります。
+- **自動処理の誤差:** 大規模な自動フィルタリングには、誤判定、不正確なメタデータ、アクセス不能な URL が残る可能性があります。
+- **実行環境の差:** 同じ WARC ファイルを用いる場合でも、依存関係や設定が異なると処理結果に差が生じる可能性があります。
+
+## 想定される利用方法
+
+MOMIJI は、主に次のような情報解���用途を想定しています。
+
+- 機械学習モデルの学習、評価、監査
+- 大規模言語モデル (LLM) および大規模視覚言語モデル (LVLM) の研究
+- 安全性およびバイアスの分析
+- テキストマイニングおよびデータマイニング
+- 統計分析
+
+日本では、一定の情報解析目的での利用が著作権法第 30 条の 4 の対象となる場合があります。詳しくは、文化庁の[AI と著作権に関する資料](https://www.bunka.go.jp/seisaku/chosakuken/aiandcopyright.html)を参照してください。
+
+MOMIJI にレコード、URL、または生成フィールドが含まれていることは、元コンテンツをあらゆる目的で利用できることを意味しません。利用者は、用途や利用地域に応じて、次の事項を確認してください。
+
+- 利用目的に適用できる法的根拠または許諾
+- 適用される法令
+- 元コンテンツの著作権者その他の権利者の権利
+- 元 Web サイトの利用条件およびアクセス制限
+- 第三者コンテンツの再配布または公衆送信の可否
+
+このデータセットカードは一般的な情報を提供するものであり、法的助言を構成するものではありません。
+
+<a id="license-and-rights"></a>
+
+## ライセンスと権利関係
+
+このリポジトリには、公開者が作成した資料と、第三者に由来する情報が含まれています。
+
+### 公開者が作成した資料
+
+このデータセットカード、公開者が作成したドキュメント、統計表、データ形式の説明など、公開者が必要な権利を有する資料には、[Creative Commons Attribution 4.0 International License](https://creativecommons.org/licenses/by/4.0/) を適用します。
+
+### 第三者に由来する情報
+
+元 Web ページの文章、画像、alt テキスト、URL、その他の第三者に由来する情報の権利は、それぞれの権利者に帰属します。権利者が別途 CC BY 4.0 で提供している場合を除き、これらの第三者由来情報に CC BY 4.0 は適用されません。
+
+MOMIJI は、元 Web ページの全文や元画像のバイナリを、固定済みのコーパスとして再配布していません。公開レコードは、フィルタリングを通過した Web 文書と画像を特定し、情報解析やデータ生成に必要な参照情報を提供するものです。
+
+### ソフトウェア
+
+`momiji_generator`、`build_momiji_on_aws`、`build_momiji` のソースコードは、別途 MIT License のもとで提供します。MIT License が適用されるのは、ソフトウェアとそれに付随するドキュメントです。ソフトウェアが取得または処理する第三者の文章や画像には適用されません。
+
+## コンテンツと品質に関する制約
+
+MOMIJI は大規模な Web データを自動処理して構築しています。NSFW フィルタを適用していますが、次のような内容や問題が残っている可能性があります。
+
+- 不快、露骨、暴力的、差別的、またはその他の不適切な内容
+- 不正確、偏向的、または古くなった情報
+- フィルタリングの誤判定
+- 不正確または欠落したメタデータ
+- 現在はアクセスできない URL
+- MOMIJI の構築後に変更された Web ページや画像
+
+データの利用前に、目的に応じた追加の品質確認、安全性確認、重複確認を行うことを推奨します。
+
+## 免責事項
+
+公開者は、公開レコードからリンクされる外部 Web サイトの現在の内容、可用性、安全性、または利用条件を管理していません。
+
+次の事項は保証されません。
+
+- すべての URL に引き続きアクセスできること
+- 現在の Web ページや画像が構築時点と一致すること
+- すべてのレコードおよびメタデータが正確であること
+- 自動フィルタによって、すべての不適切な内容が除去されていること
+- MOMIJI が特定の目的に適していること
+
+MOMIJI および外部リンク先のリソースは、内容と適用条件を確認したうえで、利用者ご自身の責任において利用してください。
+
+## 謝辞
+
+本データセットは、国立研究開発法人新エネルギー・産業技術総合開発機構（NEDO）の助成事業 JPNP20017 の成果に基づいています。