Update README.md
Browse files
README.md
CHANGED
|
@@ -1,3 +1,70 @@
|
|
| 1 |
---
|
| 2 |
license: mit
|
|
|
|
|
|
|
| 3 |
---
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
---
|
| 2 |
license: mit
|
| 3 |
+
language:
|
| 4 |
+
- ja
|
| 5 |
---
|
| 6 |
+
|
| 7 |
+
|
| 8 |
+
# Donut (base-sized model, fine-tuned on visual novel like synthetic dataset )
|
| 9 |
+
|
| 10 |
+
ビジュアルノベル風画像の合成データセットで[naver-clova-ix/donut-base](https://huggingface.co/naver-clova-ix/donut-base)を訓練したモデルです。
|
| 11 |
+
|
| 12 |
+
|
| 13 |
+
# 使い方
|
| 14 |
+
サンプルノートブック`sample_predictions_colab.ipynb`を参照してください。
|
| 15 |
+
|
| 16 |
+
[oshizo/donut-base-japanese-visual-novel](https://github.com/oshizo/donut-base-japanese-visual-novel/)
|
| 17 |
+
|
| 18 |
+
|
| 19 |
+
# 認識結果のサンプル
|
| 20 |
+
|
| 21 |
+
```{'options': '', 'names': '結月', 'messages': 'この神社には古い言い伝えがあるの。神樹の下で誓いを立てると、その願いは必ず叶うという。心を開いて、自分の想いを信じてみて。'}```
|
| 22 |
+
<img src="https://raw.githubusercontent.com/oshizo/donut-base-japanese-visual-novel/main/sample_images/sample_01.png" width="600">
|
| 23 |
+
|
| 24 |
+
---
|
| 25 |
+
|
| 26 |
+
```{'options': ['行こう!', '今回は見送る', '準備を整えるまで待って(会話から抜けます)', '旅の目的について詳しく教えてください'], 'names': 'リリアン', 'messages': '私たちの使命は、新たな発見と交流を通じて地球と宇宙の未来を築くこと。この壮大な旅に参加する準備はできているかしら?'}```
|
| 27 |
+
<img src="https://raw.githubusercontent.com/oshizo/donut-base-japanese-visual-novel/main/sample_images/sample_02.png" width="600">
|
| 28 |
+
|
| 29 |
+
---
|
| 30 |
+
|
| 31 |
+
```{'options': ['全力で攻撃する!勝利をつかめ!', '堅実に守り、敵の隙を待とう。'], 'names': '', 'messages': '敵を誘い込んで、戦術を駆使せよ。'}```
|
| 32 |
+
<img src="https://raw.githubusercontent.com/oshizo/donut-base-japanese-visual-novel/main/sample_images/sample_03.png" width="600">
|
| 33 |
+
|
| 34 |
+
---
|
| 35 |
+
|
| 36 |
+
```{'options': 'もちろん、手伝います!', 'names': '下尾崎 菊欠郎', 'messages': 'この書斎は重要な手がかりが隠されているかもしれない。君も協力してくれるか?'}```
|
| 37 |
+
<img src="https://raw.githubusercontent.com/oshizo/donut-base-japanese-visual-novel/main/sample_images/sample_04.png" width="600">
|
| 38 |
+
|
| 39 |
+
---
|
| 40 |
+
|
| 41 |
+
# 仕様
|
| 42 |
+
|
| 43 |
+
* ルビを読み取りません。ルビが表示されていても影響されずに本文を読み取ることを目標にしています。
|
| 44 |
+
* SAVE, LOADなどのUI要素と、2日目、4/3などの日付表示をなるべく読み取らないことを目標にしています
|
| 45 |
+
* options, names, messsages の3つのキーを持つjsonを出力します
|
| 46 |
+
|
| 47 |
+
## 学習に含むレイアウト
|
| 48 |
+
|
| 49 |
+
以下のレイアウトと、それぞれのパターンが存在しないパターンが学習データに含まれます。
|
| 50 |
+
|
| 51 |
+
<img src="https://raw.githubusercontent.com/oshizo/donut-base-japanese-visual-novel/main/model_card_images/trained_patterns.png" width="600">
|
| 52 |
+
|
| 53 |
+
|
| 54 |
+
## 学習に含まないレイアウト
|
| 55 |
+
|
| 56 |
+
以下のようなパターンなど、学習データに含まれないパターンはうまく読み取れません。
|
| 57 |
+
|
| 58 |
+
<img src="https://raw.githubusercontent.com/oshizo/donut-base-japanese-visual-novel/main/model_card_images/not_trained_patterns.png" width="600">
|
| 59 |
+
|
| 60 |
+
|
| 61 |
+
## その他の制約
|
| 62 |
+
|
| 63 |
+
* 幅1,920px, 高さ1,080pxの画像でのみ訓練、評価しているため、縦横比が大きく異なる場合認識精度が落ちる可能性があります
|
| 64 |
+
* decoderのtokenizerには`XLMRobertaTokenizer`をベースに日本語の漢字を1500種類程度追加したものを使用しています。tokenizerに存在せず出力されない漢字が存在します
|
| 65 |
+
|
| 66 |
+
# 学習方法
|
| 67 |
+
|
| 68 |
+
もう少し詳しい情報を以下のnote記事に記載しました。
|
| 69 |
+
|
| 70 |
+
[end-to-endの文書画像認識モデルDonutをファインチューニングするメモ](https://note.com/oshizo/n/n9681908a933b)
|