Installation¶

本パッケージは Python3.9+, Pytorch が実行に必要です。Pytorch はご自身の環境に合わせて、インストールが必要です。計算機は GPU(> VRAM 8G)を推奨しています。CPU でも動作しますが、現在、CPU 向けに処理が最適化されておらず、実行に時間がかかりますのでご注意ください。

PYPI からインストール¶

pip install yomitoku

uv でのインストール¶

本リポジトリはパッケージ管理ツールに uv を使用しています。uv をインストール後、リポジトリをクローンし、以下のコマンドを実行してください

uv sync

uvを利用する場合、pyproject.tomlの以下の部分をご自身のcudaのバージョンに合わせて修正する必要があります。デフォルトではCUDA12.4に対応したpytorchがダウンロードされます。

[[tool.uv.index]]
name = "pytorch-cuda124"
url = "https://download.pytorch.org/whl/cu124"
explicit = true

Docker 環境での実行¶

リポジトリの直下に dockerfile を配置していますので、そちらも活用いただけます。

docker build -t yomitoku .

GPUCPU

docker run -it --gpus all -v $(pwd):/workspace --name yomitoku yomitoku /bin/bash

docker run -it -v $(pwd):/workspace --name yomitoku yomitoku /bin/bash