yomitoku 0.5.3__tar.gz → 0.7.0__tar.gz

{yomitoku-0.5.3 → yomitoku-0.7.0}/.github/workflows/lint-and-test.yml

@@ -30,6 +30,8 @@ jobs:
           enable-cache: true
       - name: pin python version
         run: uv python pin 3.12
+      - name: Update apt
+        run: sudo apt update
       - name: Install dependencies
         run: sudo apt install -y libopencv-dev poppler-utils
       - name: Install tox-uv
@@ -37,4 +39,4 @@ jobs:
       - name: Run linter
         run: tox -e lint
       - name: Run tests
-        run:  tox -p -e py39,py310,py311,py312
+        run: tox -p -e py310,py311,py312

{yomitoku-0.5.3 → yomitoku-0.7.0}/.gitignore

@@ -20,4 +20,6 @@ dataset/
 weights/
 results/
 
-.coverage*
+.coverage*
+
+*.onnx

yomitoku-0.7.0/.python-version

@@ -0,0 +1 @@
+3.10

{yomitoku-0.5.3 → yomitoku-0.7.0}/PKG-INFO

@@ -1,14 +1,16 @@
-Metadata-Version: 2.3
+Metadata-Version: 2.4
 Name: yomitoku
-Version: 0.5.3
+Version: 0.7.0
 Summary: Yomitoku is an AI-powered document image analysis package designed specifically for the Japanese language.
 Author-email: Kotaro Kinoshita <kotaro.kinoshita@mlism.com>
 License: CC BY-NC-SA 4.0
 Keywords: Deep Learning,Japanese,OCR
-Requires-Python: <3.13,>=3.9
+Requires-Python: <3.13,>=3.10
 Requires-Dist: huggingface-hub>=0.26.1
 Requires-Dist: lxml>=5.3.0
 Requires-Dist: omegaconf>=2.3.0
+Requires-Dist: onnx>=1.17.0
+Requires-Dist: onnxruntime>=1.20.1
 Requires-Dist: opencv-python>=4.10.0.84
 Requires-Dist: pyclipper>=1.3.0.post6
 Requires-Dist: pydantic>=2.9.2
@@ -17,13 +19,15 @@ Requires-Dist: shapely>=2.0.6
 Requires-Dist: timm>=1.0.11
 Requires-Dist: torch>=2.5.0
 Requires-Dist: torchvision>=0.20.0
+Provides-Extra: gpu
+Requires-Dist: onnxruntime-gpu>=1.20.1; extra == 'gpu'
 Description-Content-Type: text/markdown
 
 日本語版 | [English](README_EN.md)
 
 <img src="static/logo/horizontal.png" width="800px">
 
-![Python](https://img.shields.io/badge/Python-3.9|3.10|3.11|3.12-F9DC3E.svg?logo=python&logoColor=&style=flat)
+![Python](https://img.shields.io/badge/Python-3.10|3.11|3.12-F9DC3E.svg?logo=python&logoColor=&style=flat)
 ![Pytorch](https://img.shields.io/badge/Pytorch-2.5-EE4C2C.svg?logo=Pytorch&style=fla)
 ![CUDA](https://img.shields.io/badge/CUDA->=11.8-76B900.svg?logo=NVIDIA&style=fla)
 ![OS](https://img.shields.io/badge/OS-Linux|Mac|Win-1793D1.svg?&style=fla)
@@ -69,23 +73,30 @@ Markdown でエクスポートした結果は関してはリポジトリ内の[s
 pip install yomitoku
 ```
 
-- pytorch はご自身の CUDAのバージョンにあったものをインストールしてください。デフォルトではCUDA12.4以上に対応したものがインストールされます。
-- pytorch は2.5以上のバージョンに対応しています。その関係でCUDA11.8以上のバージョンが必要になります。対応できない場合は、リポジトリ内のDockerfileを利用してください。
+onnxruntimeの実行にGPUを使用する場合
+```
+pip install yomitoku[gpu]
+```
+
+- pytorch はご自身の CUDA のバージョンにあったものをインストールしてください。デフォルトでは CUDA12.4 以上に対応したものがインストールされます。
+- pytorch は 2.5 以上のバージョンに対応しています。その関係で CUDA11.8 以上のバージョンが必要になります。対応できない場合は、リポジトリ内の Dockerfile を利用してください。
 
 ## 🚀 実行方法
 
 ```
-yomitoku ${path_data} -f md -o results -v --figure
+yomitoku ${path_data} -f md -o results -v --figure　--lite
 ```
 
 - `${path_data}` 解析対象の画像が含まれたディレクトリか画像ファイルのパスを直接して指定してください。ディレクトリを対象とした場合はディレクトリのサブディレクトリ内の画像も含めて処理を実行します。
 - `-f`, `--format` 出力形式のファイルフォーマットを指定します。(json, csv, html, md をサポート)
 - `-o`, `--outdir` 出力先のディレクトリ名を指定します。存在しない場合は新規で作成されます。
 - `-v`, `--vis` を指定すると解析結果を可視化した画像を出力します。
+- `-l`, `--lite` を指定すると軽量モデルで推論を実行します。通常より高速に推論できますが、若干、精度が低下する可能性があります。
 - `-d`, `--device` モデルを実行するためのデバイスを指定します。gpu が利用できない場合は cpu で推論が実行されます。(デフォルト: cuda)
 - `--ignore_line_break` 画像の改行位置を無視して、段落内の文章を連結して返します。（デフォルト：画像通りの改行位置位置で改行します。）
 - `--figure_letter` 検出した図表に含まれる文字も出力ファイルにエクスポートします。
-- `--figure` 検出した図、画像を出力ファイルにエクスポートします。(html と markdown のみ)
+- `--figure` 検出した図、画像を出力ファイルにエクスポートします。
+- `--encoding` エクスポートする出力ファイルの文字エンコーディングを指定します。サポートされていない文字コードが含まれる場合は、その文字を無視します。(utf-8, utf-8-sig, shift-jis, enc-jp, cp932)
 
 その他のオプションに関しては、ヘルプを参照
 
@@ -94,6 +105,7 @@ yomitoku --help
 ```
 
 **NOTE**
+
 - GPU での実行を推奨します。CPU を用いての推論向けに最適化されておらず、処理時間が長くなります。
 - 活字のみ識別をサポートしております。手書き文字に関しては、読み取れる場合もありますが、公式にはサポートしておりません。
 - Yomitoku は文書 OCR 向けに最適化されており、情景 OCR(看板など紙以外にプリントされた文字の読み取り)向けには最適化されていません。
@@ -107,6 +119,6 @@ yomitoku --help
 
 本リポジトリ内に格納されているソースコードおよび本プロジェクトに関連する HuggingFaceHub 上のモデルの重みファイルのライセンスは CC BY-NC-SA 4.0 に従います。
 非商用での個人利用、研究目的での利用はご自由にお使いください。
-商用目的での利用に関しては、別途、商用ライセンスを提供しますので、開発者にお問い合わせください。
+商用目的での利用に関しては、別途、商用ライセンスを提供しますので、https://www.mlism.com/ にお問い合わせください。
 
 YomiToku © 2024 by Kotaro Kinoshita is licensed under CC BY-NC-SA 4.0. To view a copy of this license, visit https://creativecommons.org/licenses/by-nc-sa/4.0/

{yomitoku-0.5.3 → yomitoku-0.7.0}/README.md

@@ -2,7 +2,7 @@
 
 <img src="static/logo/horizontal.png" width="800px">
 
-![Python](https://img.shields.io/badge/Python-3.9|3.10|3.11|3.12-F9DC3E.svg?logo=python&logoColor=&style=flat)
+![Python](https://img.shields.io/badge/Python-3.10|3.11|3.12-F9DC3E.svg?logo=python&logoColor=&style=flat)
 ![Pytorch](https://img.shields.io/badge/Pytorch-2.5-EE4C2C.svg?logo=Pytorch&style=fla)
 ![CUDA](https://img.shields.io/badge/CUDA->=11.8-76B900.svg?logo=NVIDIA&style=fla)
 ![OS](https://img.shields.io/badge/OS-Linux|Mac|Win-1793D1.svg?&style=fla)
@@ -48,23 +48,30 @@ Markdown でエクスポートした結果は関してはリポジトリ内の[s
 pip install yomitoku
 ```
 
-- pytorch はご自身の CUDAのバージョンにあったものをインストールしてください。デフォルトではCUDA12.4以上に対応したものがインストールされます。
-- pytorch は2.5以上のバージョンに対応しています。その関係でCUDA11.8以上のバージョンが必要になります。対応できない場合は、リポジトリ内のDockerfileを利用してください。
+onnxruntimeの実行にGPUを使用する場合
+```
+pip install yomitoku[gpu]
+```
+
+- pytorch はご自身の CUDA のバージョンにあったものをインストールしてください。デフォルトでは CUDA12.4 以上に対応したものがインストールされます。
+- pytorch は 2.5 以上のバージョンに対応しています。その関係で CUDA11.8 以上のバージョンが必要になります。対応できない場合は、リポジトリ内の Dockerfile を利用してください。
 
 ## 🚀 実行方法
 
 ```
-yomitoku ${path_data} -f md -o results -v --figure
+yomitoku ${path_data} -f md -o results -v --figure　--lite
 ```
 
 - `${path_data}` 解析対象の画像が含まれたディレクトリか画像ファイルのパスを直接して指定してください。ディレクトリを対象とした場合はディレクトリのサブディレクトリ内の画像も含めて処理を実行します。
 - `-f`, `--format` 出力形式のファイルフォーマットを指定します。(json, csv, html, md をサポート)
 - `-o`, `--outdir` 出力先のディレクトリ名を指定します。存在しない場合は新規で作成されます。
 - `-v`, `--vis` を指定すると解析結果を可視化した画像を出力します。
+- `-l`, `--lite` を指定すると軽量モデルで推論を実行します。通常より高速に推論できますが、若干、精度が低下する可能性があります。
 - `-d`, `--device` モデルを実行するためのデバイスを指定します。gpu が利用できない場合は cpu で推論が実行されます。(デフォルト: cuda)
 - `--ignore_line_break` 画像の改行位置を無視して、段落内の文章を連結して返します。（デフォルト：画像通りの改行位置位置で改行します。）
 - `--figure_letter` 検出した図表に含まれる文字も出力ファイルにエクスポートします。
-- `--figure` 検出した図、画像を出力ファイルにエクスポートします。(html と markdown のみ)
+- `--figure` 検出した図、画像を出力ファイルにエクスポートします。
+- `--encoding` エクスポートする出力ファイルの文字エンコーディングを指定します。サポートされていない文字コードが含まれる場合は、その文字を無視します。(utf-8, utf-8-sig, shift-jis, enc-jp, cp932)
 
 その他のオプションに関しては、ヘルプを参照
 
@@ -73,6 +80,7 @@ yomitoku --help
 ```
 
 **NOTE**
+
 - GPU での実行を推奨します。CPU を用いての推論向けに最適化されておらず、処理時間が長くなります。
 - 活字のみ識別をサポートしております。手書き文字に関しては、読み取れる場合もありますが、公式にはサポートしておりません。
 - Yomitoku は文書 OCR 向けに最適化されており、情景 OCR(看板など紙以外にプリントされた文字の読み取り)向けには最適化されていません。
@@ -86,6 +94,6 @@ yomitoku --help
 
 本リポジトリ内に格納されているソースコードおよび本プロジェクトに関連する HuggingFaceHub 上のモデルの重みファイルのライセンスは CC BY-NC-SA 4.0 に従います。
 非商用での個人利用、研究目的での利用はご自由にお使いください。
-商用目的での利用に関しては、別途、商用ライセンスを提供しますので、開発者にお問い合わせください。
+商用目的での利用に関しては、別途、商用ライセンスを提供しますので、https://www.mlism.com/ にお問い合わせください。
 
 YomiToku © 2024 by Kotaro Kinoshita is licensed under CC BY-NC-SA 4.0. To view a copy of this license, visit https://creativecommons.org/licenses/by-nc-sa/4.0/

{yomitoku-0.5.3 → yomitoku-0.7.0}/README_EN.md

@@ -2,7 +2,7 @@
 
 <img src="static/logo/horizontal.png" width="800px">
 
-![Python](https://img.shields.io/badge/Python-3.9|3.10|3.11|3.12-F9DC3E.svg?logo=python&logoColor=&style=flat)
+![Python](https://img.shields.io/badge/Python-3.10|3.11|3.12-F9DC3E.svg?logo=python&logoColor=&style=flat)
 ![Pytorch](https://img.shields.io/badge/Pytorch-2.5-EE4C2C.svg?logo=Pytorch&style=fla)
 ![CUDA](https://img.shields.io/badge/CUDA->=11.8-76B900.svg?logo=NVIDIA&style=fla)
 ![OS](https://img.shields.io/badge/OS-Linux|Mac|Win-1793D1.svg?&style=fla)
@@ -49,6 +49,10 @@ Source of the image: Created by processing content from “Reiwa 6 Edition Infor
 pip install yomitoku
 ```
 
+Using GPU with onnxruntime
+```
+pip install yomitoku[gpu]
+```
 
 - Please install the version of PyTorch that matches your CUDA version. By default, a version compatible with CUDA 12.4 or higher will be installed.
 - PyTorch versions 2.5 and above are supported. As a result, CUDA version 11.8 or higher is required. If this is not feasible, please use the Dockerfile provided in the repository.
@@ -63,10 +67,12 @@ yomitoku ${path_data} -f md -o results -v --figure
 - `-f`, `--format`: Specify the output file format. Supported formats are json, csv, html, and md.
 - `-o`, `--outdir`: Specify the name of the output directory. If it does not exist, it will be created.
 - `-v`, `--vis`: If specified, outputs visualized images of the analysis results.
+- `-l`, `--lite`: inference is performed using a lightweight model. This enables fast inference even on a CPU.
 - `-d`, `--device`: Specify the device for running the model. If a GPU is unavailable, inference will be executed on the CPU. (Default: cuda)
 - `--ignore_line_break`: Ignores line breaks in the image and concatenates sentences within a paragraph. (Default: respects line breaks as they appear in the image.)
 - `--figure_letter`: Exports characters contained within detected figures and tables to the output file.
-- `--figure`: Exports detected figures and images to the output file (supported only for html and markdown).
+- `--figure`: Exports detected figures and images to the output file 
+- `--encoding` Specifies the character encoding for the output file to be exported. If unsupported characters are included, they will be ignored. (utf-8, utf-8-sig, shift-jis, enc-jp, cp932)
 
 
 For other options, please refer to the help documentation.

yomitoku-0.7.0/configs/table_structure_recognitizer.yaml

@@ -0,0 +1,67 @@
+hf_hub_repo: KotaroKinoshita/yomitoku-table-structure-recognizer-rtdtrv2-open-beta
+thresh_score: 0.4
+data:
+  img_size:
+  - 640
+  - 640
+PResNet:
+  depth: 50
+  variant: d
+  freeze_at: 0
+  return_idx:
+  - 1
+  - 2
+  - 3
+  num_stages: 4
+  freeze_norm: true
+HybridEncoder:
+  in_channels:
+  - 512
+  - 1024
+  - 2048
+  feat_strides:
+  - 8
+  - 16
+  - 32
+  hidden_dim: 256
+  use_encoder_idx:
+  - 2
+  num_encoder_layers: 1
+  nhead: 8
+  dim_feedforward: 1024
+  dropout: 0.0
+  enc_act: gelu
+  expansion: 1.0
+  depth_mult: 1
+  act: silu
+RTDETRTransformerv2:
+  num_classes: 3
+  feat_channels:
+  - 256
+  - 256
+  - 256
+  feat_strides:
+  - 8
+  - 16
+  - 32
+  hidden_dim: 256
+  num_levels: 3
+  num_layers: 6
+  num_queries: 300
+  num_denoising: 100
+  label_noise_ratio: 0.5
+  box_noise_scale: 1.0
+  eval_spatial_size:
+  - 640
+  - 640
+  eval_idx: -1
+  num_points:
+  - 4
+  - 4
+  - 4
+  cross_attn_method: default
+  query_select_method: default
+category:
+- row
+- col
+- span

yomitoku-0.7.0/configs/text_recognizer.yaml

@@ -0,0 +1,32 @@
+hf_hub_repo: KotaroKinoshita/yomitoku-text-recognizer-parseq-open-beta
+charset: /home/kinoshita/Projects/know-how/yomitoku/src/yomitoku/resource/charset.txt
+num_tokens: 7312
+max_label_length: 100
+decode_ar: 1
+refine_iters: 1
+data:
+  num_workers: 4
+  batch_size: 128
+  img_size:
+  - 32
+  - 800
+encoder:
+  patch_size:
+  - 8
+  - 8
+  num_heads: 8
+  embed_dim: 512
+  mlp_ratio: 4
+  depth: 12
+decoder:
+  embed_dim: 512
+  num_heads: 8
+  mlp_ratio: 4
+  depth: 1
+visualize:
+  font: /home/kinoshita/Projects/know-how/yomitoku/src/yomitoku/resource/MPLUS1p-Medium.ttf
+  color:
+  - 0
+  - 0
+  - 255
+  font_size: 18

yomitoku-0.7.0/demo/setting_document_anaysis.py

@@ -0,0 +1,6 @@
+from yomitoku import DocumentAnalyzer
+
+if __name__ == "__main__":
+    configs = {"ocr": {"text_detector": {"path_cfg": "demo/text_detector.yaml"}}}
+
+    analyzer = DocumentAnalyzer(configs=configs, visualize=True, device="cuda")

{yomitoku-0.5.3 → yomitoku-0.7.0}/demo/simple_document_analysis.py

@@ -4,17 +4,14 @@ from yomitoku import DocumentAnalyzer
 from yomitoku.data.functions import load_pdf
 
 if __name__ == "__main__":
-    PATH_IMGE = ""
-
-    analyzer = DocumentAnalyzer(configs=None, visualize=True, device="cuda")
+    PATH_IMGE = "demo/sample.pdf"
+    analyzer = DocumentAnalyzer(visualize=True, device="cuda")
     # PDFファイルを読み込み
-    imgs = load_pdf("demo/sample.pdf")
+    imgs = load_pdf(PATH_IMGE)
     for i, img in enumerate(imgs):
         results, ocr_vis, layout_vis = analyzer(img)
-
         # HTML形式で解析結果をエクスポート
-        results.to_html(f"output_{i}.html")
-
+        results.to_html(f"output_{i}.html", img=img)
         # 可視化画像を保存
         cv2.imwrite(f"output_ocr_{i}.jpg", ocr_vis)
         cv2.imwrite(f"output_layout_{i}.jpg", layout_vis)

{yomitoku-0.5.3 → yomitoku-0.7.0}/demo/simple_layout.py

@@ -4,7 +4,7 @@ from yomitoku import LayoutAnalyzer
 from yomitoku.data.functions import load_pdf
 
 if __name__ == "__main__":
-    analyzer = LayoutAnalyzer(configs=None, visualize=True, device="cuda")
+    analyzer = LayoutAnalyzer(visualize=True, device="cuda")
     # PDFファイルを読み込み
     imgs = load_pdf("demo/sample.pdf")
     for i, img in enumerate(imgs):

{yomitoku-0.5.3 → yomitoku-0.7.0}/demo/simple_ocr.py

@@ -4,7 +4,7 @@ from yomitoku import OCR
 from yomitoku.data.functions import load_pdf
 
 if __name__ == "__main__":
-    ocr = OCR(configs=None, visualize=True, device="cuda")
+    ocr = OCR(visualize=True, device="cuda")
     # PDFファイルを読み込み
     imgs = load_pdf("demo/sample.pdf")
     for i, img in enumerate(imgs):

{yomitoku-0.5.3 → yomitoku-0.7.0}/docs/installation.en.md

@@ -1,7 +1,7 @@
 # Installation
 
 
-This package requires Python 3.9 or later and PyTorch 2.5 or later for execution. PyTorch must be installed according to your CUDA version. A GPU with more than 8GB of VRAM is recommended. While it can run on a CPU, please note that the processing is not currently optimized for CPUs, which may result in longer execution times.
+This package requires Python 3.10 or later and PyTorch 2.5 or later for execution. PyTorch must be installed according to your CUDA version. A GPU with more than 8GB of VRAM is recommended. While it can run on a CPU, please note that the processing is not currently optimized for CPUs, which may result in longer execution times.
 
 ## from PYPI
 
@@ -9,6 +9,12 @@ This package requires Python 3.9 or later and PyTorch 2.5 or later for execution
 pip install yomitoku
 ```
 
+Using GPU with onnxruntime
+```bash
+pip install yomitoku[gpu]
+```
+
+
 ## using uv
 This repository uses the package management tool [uv](https://docs.astral.sh/uv/). After installing uv, clone the repository and execute the following commands:
 
@@ -16,6 +22,11 @@ This repository uses the package management tool [uv](https://docs.astral.sh/uv/
 uv sync
 ```
 
+Using GPU with onnxruntime
+```bash
+uv sync --extra gpu
+```
+
 When using uv, you need to modify the following part of the pyproject.toml file to match your CUDA version. By default, PyTorch compatible with CUDA 12.4 will be downloaded.
 
 ```pyproject.tom

{yomitoku-0.5.3 → yomitoku-0.7.0}/docs/installation.ja.md

@@ -1,6 +1,6 @@
 # Installation
 
-本パッケージは Python3.9+, Pytorch が実行に必要です。Pytorch はご自身の環境に合わせて、インストールが必要です。計算機は GPU(> VRAM 8G)を推奨しています。CPU でも動作しますが、現在、CPU 向けに処理が最適化されておらず、実行に時間がかかりますのでご注意ください。
+本パッケージは Python3.10+, Pytorch が実行に必要です。Pytorch はご自身の環境に合わせて、インストールが必要です。計算機は GPU(> VRAM 8G)を推奨しています。CPU でも動作しますが、現在、CPU 向けに処理が最適化されておらず、実行に時間がかかりますのでご注意ください。
 
 ## PYPI からインストール
 
@@ -8,6 +8,11 @@
 pip install yomitoku
 ```
 
+onnxruntimeの実行にGPUを使用する場合
+```bash
+pip install yomitoku[gpu]
+```
+
 ## uv でのインストール
 
 本リポジトリはパッケージ管理ツールに [uv](https://docs.astral.sh/uv/) を使用しています。uv をインストール後、リポジトリをクローンし、以下のコマンドを実行してください
@@ -16,6 +21,11 @@ pip install yomitoku
 uv sync
 ```
 
+onnxruntimeの実行にGPUを使用する場合
+```bash
+uv sync --extra gpu
+```
+
 uvを利用する場合、`pyproject.toml`の以下の部分をご自身のcudaのバージョンに合わせて修正する必要があります。デフォルトではCUDA12.4に対応したpytorchがダウンロードされます。
 
 ```pyproject.tom

{yomitoku-0.5.3 → yomitoku-0.7.0}/docs/usage.en.md

@@ -12,12 +12,16 @@ yomitoku ${path_data} -f md -o results -v
 - `-f`, `--format`: Specify the output file format. Supported formats are json, csv, html, and md.
 - `-o`, `--outdir`: Specify the name of the output directory. If it does not exist, it will be created.
 - `-v`, `--vis`: If specified, outputs visualized images of the analysis results.
+- `-l`, `--lite`: inference is performed using a lightweight model. This enables fast inference even on a CPU.
 - `-d`, `--device`: Specify the device for running the model. If a GPU is unavailable, inference will be executed on the CPU. (Default: cuda)
 - `--ignore_line_break`: Ignores line breaks in the image and concatenates sentences within a paragraph. (Default: respects line breaks as they appear in the image.)
 - `--figure_letter`: Exports characters contained within detected figures and tables to the output file.
-- `--figure`: Exports detected figures and images to the output file (supported only for html and markdown).
+- `--figure`: Exports detected figures and images to the output file
+- `--encoding` Specifies the character encoding for the output file to be exported. If unsupported characters are included, they will be ignored. (utf-8, utf-8-sig, shift-jis, enc-jp, cp932)
+
 
 **NOTE**
+
 - It is recommended to run on a GPU. The system is not optimized for inference on CPUs, which may result in significantly longer processing times.
 - Only printed text recognition is supported. While it may occasionally read handwritten text, official support is not provided.
 - YomiToku is optimized for document OCR and is not designed for scene OCR (e.g., text printed on non-paper surfaces like signs).
@@ -29,24 +33,11 @@ yomitoku ${path_data} -f md -o results -v
 
 The Document Analyzer performs OCR and layout analysis, integrating these results into a comprehensive analysis output. It can be used for various use cases, including paragraph and table structure analysis, extraction, and figure/table detection.
 
-```python
-import cv2
-
-from yomitoku import DocumentAnalyzer
-from yomitoku.data.functions import load_image
-
-if __name__ == "__main__":
-    img = load_image(PATH_IMAGE)
-    analyzer = DocumentAnalyzer(configs=None, visualize=True, device="cuda")
-    results, ocr_vis, layout_vis = analyzer(img)
+<!--codeinclude-->
 
-    # HTML形式で解析結果をエクスポート
-    results.to_html(PATH_OUTPUT)
+[demo/simple_document_analysis.py](../demo/simple_document_analysis.py)
 
-    # 可視化画像を保存
-    cv2.imwrite("output_ocr.jpg", ocr_vis)
-    cv2.imwrite("output_layout.jpg", layout_vis)
-```
+<!--/codeinclude-->
 
 - Setting `visualize` to True enables the visualization of each processing result. The second and third return values will contain the OCR and layout analysis results, respectively. If set to False, None will be returned. Since visualization adds computational overhead, it is recommended to set it to False unless needed for debugging purposes.
 - The `device` parameter specifies the computation device to be used. The default is "cuda". If a GPU is unavailable, it automatically switches to CPU mode for processing.
@@ -54,31 +45,20 @@ if __name__ == "__main__":
 
 The results of DocumentAnalyzer can be exported in the following formats:
 
-`to_json()`: JSON format (*.json)
-`to_html()`: HTML format (*.html)
-`to_csv()`: Comma-separated CSV format (*.csv)
-`to_markdown()`: Markdown format (*.md)
-
+`to_json()`: JSON format (_.json)
+`to_html()`: HTML format (_.html)
+`to_csv()`: Comma-separated CSV format (_.csv)
+`to_markdown()`: Markdown format (_.md)
 
 ### Using AI-OCR Only
 
-AI-OCR performs text detection and recognition on the detected text, returning the positions of the text within the image along with the recognition results.
+AI-OCR performs text detection and recognition on the detected text, returning the positions of the text within the image along with the
 
-```python
-import cv2
+<!--codeinclude-->
 
-from yomitoku import OCR
-from yomitoku.data.functions import load_image
+[demo/simple_ocr.py](../demo/simple_ocr.py)
 
-if __name__ == "__main__":
-    img = load_image(PATH_IMAGE)
-    ocr = OCR(configs=None, visualize=True, device="cuda")
-    results, ocr_vis = ocr(img)
-
-    # JSON形式で解析結果をエクスポート
-    results.to_json(PATH_OUTPUT)
-    cv2.imwrite("output_ocr.jpg", ocr_vis)
-```
+<!--/codeinclude-->
 
 - Setting `visualize` to True enables the visualization of each processing result. The second and third return values will contain the OCR and layout analysis results, respectively. If set to False, None will be returned. Since visualization adds computational overhead, it is recommended to set it to False unless needed for debugging purposes.
 - The `device` parameter specifies the computation device to be used. The default is "cuda". If a GPU is unavailable, it automatically switches to CPU mode for processing.
@@ -90,22 +70,11 @@ The results of OCR processing support export in JSON format (`to_json()`) only.
 
 The `LayoutAnalyzer` performs text detection, followed by AI-based paragraph, figure/table detection, and table structure analysis. It analyzes the layout structure within the document.
 
-```python
-import cv2
+<!--codeinclude-->
 
-from yomitoku import LayoutAnalyzer
-from yomitoku.data.functions import load_image
-
-if __name__ == "__main__":
-    img = load_image(PATH_IMAGE)
-    analyzer = LayoutAnalyzer(configs=None, visualize=True, device="cuda")
-    results, layout_vis = analyzer(img)
-
-    # JSON形式で解析結果をエクスポート
-    results.to_json(PATH_OUTPUT)
-    cv2.imwrite("output_layout.jpg", layout_vis)
-```
+[demo/simple_layout.py](../demo/simple_layout.py)
 
+<!--/codeinclude-->
 
 - Setting `visualize` to True enables the visualization of each processing result. The second and third return values will contain the OCR and layout analysis results, respectively. If set to False, None will be returned. Since visualization adds computational overhead, it is recommended to set it to False unless needed for debugging purposes.
 - The `device` parameter specifies the computation device to be used. The default is "cuda". If a GPU is unavailable, it automatically switches to CPU mode for processing.
@@ -149,7 +118,6 @@ if __name__ == "__main__":
 
 ### Defining Parameters in an YAML File
 
-
 By providing the path to a YAML file in the config, you can adjust detailed parameters for inference. Examples of YAML files can be found in the `configs` directory within the repository. While the model's network parameters cannot be modified, certain aspects like post-processing parameters and input image size can be adjusted.
 
 For instance, you can define post-processing thresholds for the Text Detector in a YAML file and set its path in the config. The config file does not need to include all parameters; you only need to specify the parameters that require changes.
@@ -162,21 +130,11 @@ post_process:
 
 Storing the Path to a YAML File in the Config
 
-```python
-from yomitoku import DocumentAnalyzer
+<!--codeinclude-->
 
-if __name__ == "__main__":
-    # path_cfgに設定したymalのパスを記述する
-    configs = {
-        "ocr": {
-            "text_detector": {
-                "path_cfg": "text_detector.yaml"
-            }
-        }
-    }
+[demo/setting_document_anaysis.py](../demo/setting_document_anaysis.py)
 
-    DocumentAnalyzer(configs=configs)
-```
+<!--/codeinclude-->
 
 ## Using in an Offline Environment
 
@@ -185,7 +143,6 @@ Yomitoku automatically downloads models from Hugging Face Hub during the first e
 1. Install [Git Large File Storage](https://docs.github.com/ja/repositories/working-with-files/managing-large-files/installing-git-large-file-storage)
 2. In an environment with internet access, download the model repository. Copy the cloned repository to your target environment using your preferred tools.
 
-
 The following is the command to download the model repository from Hugging Face Hub.
 
 ```sh
@@ -206,18 +163,8 @@ hf_hub_repo: yomitoku-text-detector-dbnet-open-beta
 
 4. Storing the Path to a YAML File in the Config
 
-```python
-from yomitoku import DocumentAnalyzer
+<!--codeinclude-->
 
-if __name__ == "__main__":
-    # path_cfgに設定したymalのパスを記述する
-    configs = {
-        "ocr": {
-            "text_detector": {
-                "path_cfg": "text_detector.yaml"
-            }
-        }
-    }
+[demo/setting_document_anaysis.py](../demo/setting_document_anaysis.py)
 
-    DocumentAnalyzer(configs=configs)
-```
+<!--/codeinclude-->