Update README.md

README.md

@@ -1,3 +1,151 @@
----
-license: apache-2.0
----
+---
+language:
+- ja
+license: apache-2.0
+size_categories:
+- 100M<n<1B
+pretty_name: MOMIJI
+configs:
+- config_name: default
+  data_files:
+  - split: train
+    path: data/train-*
+dataset_info:
+- config_name: default
+  features:
+  - name: docID
+    sequence: string
+  - name: url
+    dtype: string
+  - name: text_list
+    dtype: list
+  - name: text
+    sequence: string
+  - name: image_info
+    sequence: list
+  splits:
+  - name: train
+    num_examples: 56119639
+---
+
+^ メタデータは後で修正する
+
+# MOMIJI Dataset Card
+
+## データセットの説明
+
+- **Github リポジトリ：** (Coming soon)  
+
+`MOMIJI` は、大規模かつ厳選された、画像とテキストが交互に現れる（画像-テキストインターリーブ） Web 文書の公開データセットです。  
+2024 年 2 月から 2025 年 1 月までの Common Crawl ダンプから抽出されており、約 5,600 万 (56M) 件の日本語文書、約 1,100 億 (110B) 文字、約 2 億 4,900 万 (2.49B) 枚の画像が含まれています。  
+収集およびフィルタリングのプロセスは、将来詳しく説明される予定です。
+
+この画像-テキストインターリーブデータは、一般に様々な大規模視覚言語モデル (LVLM) の学習データとして用いられています ( [LLaVA-OneVision](https://arxiv.org/abs/2408.03326), [Idefics2](https://arxiv.org/abs/2405.02246), [NVILA](https://arxiv.org/abs/2412.04468), [Qwen2.5-VL](https://arxiv.org/abs/2502.13923), etc... )。
+我々は、提案した MOMIJI を用いて、[Heron-NVILA]() を訓練しました。
+
+
+## データフィールド
+
+サンプルの例 (一部省略):
+
+```json
+{
+  "docId": "CC-MAIN-20240518121005-20240518151005-00454_00091",
+  "url": "https://tanaka-yuki.com/spring/post-10813/",
+  "text_list": [
+    "大学の卒業式には、男性ならスーツを選ぶ方がとても多いですが、どんなスーツを着用すればいいのか？と悩みますよね。",
+    ...
+    "大学卒業式で男性はスーツが基本",
+    "<image1>",
+    "大学卒業式の服装には2種類があります。",
+    "- スーツ",
+    "- 和装(袴、振袖)",
+    ...
+    "安定感ならシングルデザイン",
+    "<image2>",
+    "参照元URL：https://mens.tasclap.jp/",
+    ...
+    "男性スーツの選び方や着こなした方のマナー、おすすめコーデ9選を紹介しました。"
+  ],
+  "text": "大学の卒業式には、男性ならスーツを選ぶ方がとても多いですが、どんなスーツを着用すればいいのか？と悩みますよね。\n ... 大学卒業式で男性はスーツが基本\n<image1>\n大学卒業式の服装には2種類があります。\n ... 安定感ならシングルデザイン\n<image2>\n参照元URL：https://mens.tasclap.jp/ ... 男性スーツの選び方や着こなした方のマナー、おすすめコーデ9選を紹介しました。",
+  "image_info": [
+    {
+      "placeholder": "<image1>",
+      "url": "https://tanaka-yuki.com/wp-content/uploads/2022/12/collage-1-1.webp",
+      "width": 1080,
+      "height": 620,
+      "original_width": 1080,
+      "original_height": 620,
+      "exif": "{}",
+      "alt": "大学卒業式で男性はスーツが基本"
+    },
+    {
+      "placeholder": "<image2>",
+      "url": "https://tanaka-yuki.com/wp-content/uploads/2020/12/4e0b43945add21d7af95fdd49d96f33f.png",
+      "width": 608,
+      "height": 404,
+      "original_width": 608,
+      "original_height": 404,
+      "exif": "{}",
+      "alt": "大学卒業式で男性に人気のデザイン：シングルデザイン"
+    },
+    ...
+  ]
+}
+```
+
+各サンプルは、`docId`, `url`, `text_list`, `text`, `image_info` の 5 つのフィールドで構成されています。
+
+- `docId` (str): 抽出元の Common Crawl ID を参考にして定められた（一意の）ID
+- `url` (str): 抽出元の Web URL リンク
+- `text_list` (list[str]): 文書単位で分割されたテキストリスト
+- `text` (str): 画像プレースホルダーを含む Web 文書テキスト
+- `image_info` (list[dict[str, Any]]): 画像のメタデータが格納されたリスト
+  - `placeholder` (str): 画像プレースホルダー名
+  - `url` (str): 画像URL
+  - `original_width` (int): 画像のサイズ(幅)
+  - `original_height` (int): 画像のサイズ(高)
+  - `exif` (dict): その他、メタ情報 (Optional)
+  - `alt` (str): 画像の代替 (alt) テキスト (Optional)
+
+
+## サイズとデータの分割
+
+このデータセットには `train` のみの分割が存在し、約5,600万 (56M) 件の日本語文書が含まれています。
+
+画像が URL で置き換えられている形式の `MOMIJI` は、約 188GB 程度のデータサイズになります。
+
+## MOMIJI の統計情報
+
+- 文書数: 56,119,639 (約56M) 件
+- 画像数: 249,745,953 (約249M) 件
+- 全文字数: 109,980,725,957 (約110B)
+- 1 文書あたりの���均文字数: 1,959 文字
+- 1 文書あたりの平均画像枚数: 4.45 枚
+
+また、参考までに画像枚数ごとの文書数の棒グラフを以下に示します（※ 全文書サンプルの中には、画像の枚数が 30 枚以上のものも含まれますが、見やすさのために除いています）。
+
+<img src="https://cdn-uploads.huggingface.co/production/uploads/67297c0bb5f7939284345463/2LZP2cVh-Qc-0PBeWQnKC.png" width="90%">
+
+
+## コンテンツに関する注意
+
+私たちは、MOMIJI を [The Apache License, Version 2.0](https://www.apache.org/licenses/LICENSE-2.0) ライセンスで公開しています。  
+このデータセットは、様々なオープンソース・マルチモーダル基盤モデルに関する研究開発を行うためにリリースします。  
+MOMIJI データセットには、NSFW (Not Safe for Work) フィルタリングを適用していますが、見る人に強い不快感を与えるさまざまなテキストサンプルあるいは、画像サンプルへのリンクが含まれている可能性があり、訓練を受けた研究者によって行われる科学的または安全分析の目的以外において、気軽に見るためのものではないことを明確に警告します。
+
+
+<!-- ## 利用規約 -->
+
+<!-- MOMIJI は、Huggingface Gated Access を通じて公開されており、所属情報の提出と、様々な明示的で不快な内容を含む可能性のあるデータを研究目的で使用することへの同意が必要です。   -->
+<!-- このデータセットを使用することで、元のコンテンツのライセンスおよびデータセットのライセンス（CC-BY-4.0）を遵守することに同意したものとみなされます。  
+また、このデータセットで機械学習モデルを訓練する場合、その使用を明記した上でモデルやアプリケーションを公開する必要があります。 -->
+
+## 免責事項
+MOMIJI では、画像コンテンツそのものの配布は行っておらず、MOMIJI の画像データにはリンクとメタデータのみが含まれています。  
+MOMIJI は、リンクを通じてアクセスできるコンテンツについて責任を負いません。  
+また、膨大なデータのため、フィルタリングは自動化されています。
+
+## ライセンス情報
+
+[The Apache License, Version 2.0](https://www.apache.org/licenses/LICENSE-2.0)