Skip to content

Latest commit

 

History

History
368 lines (292 loc) · 12.6 KB

README_JP.md

File metadata and controls

368 lines (292 loc) · 12.6 KB

AutoGenBook

AutoGenBookは、LLMを使用して自動的に本を生成するPythonベースのツールです。ユーザーが定義したコンテンツに基づいて、章、セクション、サブセクションを再帰的に作成し、最終的な本をLaTeXを使用してPDFとして出力します。

変更点

hooked-on-masによって作成されたAutoGenBookに対して、以下の修正が行われました：

  • LLM:
    • OpenAIに加えてClaude/Ollamaから選択できるように変更
  • 実行環境:
    • Google ColabからDockerコンテナとコマンドラインでの実行に変更
  • コンテンツ:
    • O'REILLY風のカバーを追加
    • プログラミング言語のサンプルコードの掲載を増加

使用方法

  1. リポジトリをクローンします：

    git clone https://github.com/Tomatio13/AutoGenBook.git
cd AutoGenBook

  2. .envファイルにAPI_KEYを指定します：1つのPROVIDERとMODELを必ず指定する必要があります。

    cp -p env.example .env
    PROVIDER=ANTHROPIC
MODEL=claude-3-5-sonnet-20240620
ANTHROPIC_API_KEY=<あなたのClaude APIキー>

# PROVIDER=OPENAI
# MODEL=gpt-4o
# OPENAI_API_KEY=<あなたのOpenAI APIキー>

#PROVIDER=GEMINI
#MODEL=gemini-1.5-pro
#GEMINI_API_KEY=<あなたのGoogle APIキー>
#GEMINI_BASE_URL=https://generativelanguage.googleapis.com/v1beta/

#PROVIDER=OLLAMA
#MODEL=qwen2.5-coder:latest
#OLLAMA_BASE_URL=http://localhost:11434/v1/
#OLLAMA_MAX_TOKENS=256

# VOICEVOXを使用する場合は以下のように指定します。
# VOICE_KIND=VOICEVOX
# VOICEVOX_API_URL=http://host.docker.internal:50021
# AivisSpeach-Engineを使用する場合は以下のように指定します。
# VOICE_KIND=AIVIS
# AivisSPEECH_API_URL=http://host.docker.internal:10101

    注意 Ollamaを指定することもできますが、MODELのmax_tokensとnum_ctxが小さいため、生成に失敗することが多く、推奨されません。

  3. コンテナをビルドします。

    docker compose build

  4. コンテナを起動します。

    docker compose up -d

  5. ターミナルで以下のコマンドを実行します：

     docker exec autogenbook-autogenbook-1 python AutoGenBook.py "Next.jsに関する教科書" "Next.js初学者" 5 --wav 13

 [実行ログは同じなので省略...]

  6. PDFファイルがoutputフォルダの下に出力されます。 ステップ5の例では、"output/py_prog_getting_st"フォルダに"Pythonプログラミング入門.pdf"というファイル名で出力されます。

AutoGenBook.pyの使用方法

AutoGenBook.pyは本を生成するためのスクリプトです。指定されたコンテンツ、対象読者、ページ数に基づいて本を作成します。

コマンドライン引数

  • book_content（必須）：本の内容に関する情報を指定します。
  • target_readers（必須）：本の対象読者を定義します。
  • n_pages（必須）：本のページ数を指定します。
  • --level LEVEL（オプション）：数式の使用レベルを指定します。
  • --wav SPEAKER_ID（オプション）：wavファイルの出力時のキャラクタ番号を指定します。

使用例

以下はAutoGenBook.pyの基本的な使用例です：

docker exec autogenbook-autogenbook-1 python AutoGenBook.py "本の内容" "想定読者" 5 --level 0 --wav 13

PDF変換時の対処

texまでは作成されたが最後にPDFに変換できない場合は、以下のようにしてみてください。

docker exec -it autogenbook-autogenbook-1 /bin/bash
cd output/py_prog_getting_st
vi py_prog_getting_st.log
((変換が失敗している箇所が最後の方に記載されているので、失敗箇所を確認して下さい))
vi py_prog_getting_st.tex
((変換が失敗している箇所を確認して、修正して下さい))
latexmk -pdfdvi -pv  py_prog_getting_st.tex

latexmkを何回か実行-->ログの確認-->再度コンパイルを繰り返すとPDFに変換できる場合があります。

数式表現の使用レベル

1: ほとんど数式を使用せず、すべての概念を平易な言葉で説明します。数式は絶対に必要な場合のみ最小限使用します。

2: 数式の使用を控えめにし、主にテキストでの説明に重点を置きます。必要な場合のみ簡単な数式を使用します。

3: 数式とテキストによる説明をバランスよく組み合わせます。重要な概念は数式で表現し、それ以外はテキストで補足します。

4: 概念や関係を正確に表現するために数式を積極的に使用します。ただし、重要な説明はテキストでも提供します。

5: 数式を最大限活用します。できるだけ多くの概念や関係を数式で表現します。

VOICEVOXを使用したwavファイルの出力

WAVファイルは、VOICEVOXの音声キャラクターを使用して本の内容を読み上げ、WAVファイルを出力します。

出力にはVoicevox Core Engineを使用します。 日本語のみ対応しているため、英語表示では出力できません。

以下の方法で、Voicevox Core Engineを起動してください。

mkdir voicevox
cp docker-compose-voicevox.yml voicevox/docker-compose.yml
cd voicevox
docker compose up -d

Voicevoxのキャラクターはキャラクター一覧をご覧ください。

音声キャラクターとスピーカーIDの一覧

コマンドラインからWAVファイルを出力する場合は、以下の一覧からスピーカーIDを指定してください。

キャラクター スピーカーID
四国めたん 3
ずんだもん 3
春日部つむぎ 8
雨晴はう 10
波音リツ 9
玄野武宏 11
白上虎太郎 12
青山龍星 13
冥鳴ひまり 14
九州そら 16
もち子さん 20
剣崎雌雄 21
WhiteCUL 23
後鬼 27
No.7 29
ちび式じい 42
櫻歌ミコ 43
小夜/SAYO 46
ナースロボ_タイプT 47
✝聖騎士 紅櫻✝ 51
雀松朱司 52
麒ヶ島宗麟 53
春歌ナナ 54
猫使アル 55
猫使ビィ 58
中国うさぎ 61
栗田まろん 67
あいえるたん 68
満別花丸 69
琴詠ニア 74
Voidoll(CV:丹下桜) 89

音声キャラクターのクレジット

以下、クレジットです。 音声ファイルはクレジットを記載すれば、商用・非商用で利用可能とされています。 キャラクター一覧の利用規約をよく読んでください。

VOICEVOX：ずんだもん,四国めたん、春日部つむぎ、雨晴はう、波音リツ、玄野武宏、白上虎太郎、青山龍星、冥鳴ひまり、九州そら、 もち子さん、剣崎雌雄、WhiteCUL、後鬼、No.7、ちび式じい、櫻歌ミコ、小夜/SAYO、ナースロボ_タイプT、✝聖騎士 紅櫻✝、 雀松朱司、麒ヶ島宗麟、春歌ナナ、猫使アル、猫使ビィ、中国うさぎ、栗田まろん、あいえるたん、満別花丸、琴詠ニア、Voidoll(CV:丹下桜)

AivisSpeach-Engineを使用したwavファイルの出力

WAVファイルは、AivisSpeach-Engineを使用して本の内容を読み上げ、WAVファイルを出力します。

以下の方法で、AivisSpeach-Engineを起動してください。

実行方法：

git clone https://github.com/Aivis-Project/AivisSpeech-Engine.git
cp docker-compose-aivis.yml AivisSpeech-Engine/docker-compose.yml
cd AivisSpeech-Engine
mkdir .local
docker build -t aivisspeech .
docker compose up -d

注意：GPUを使用しない場合は、以下のようにDockerfileの最終２行をコメントアウトしてください。

Dockerfile:

# Enable use_gpu
#FROM runtime-env AS runtime-nvidia-env
#CMD [ "gosu", "user", "/opt/python/bin/poetry", "run", "python", "./run.py", "--use_gpu", "--host", "0.0.0.0" ]

AivisSpeach-EngineのAPI URLは以下のように.envファイル内で指定してください。

.envファイルの例：

VOICEVOX_API_URL=http://host.docker.internal:10101

(補足) 音声合成モデルのダウンロード

上記手順でAivisSpeach-Engineを起動した場合、http://localhost:10101/docsにアクセスするとAPIドキュメントが表示されます。

音声合成モデルのダウンロードは、APIドキュメントの音声合成モデル管理/avim_models/installを使用してください。 AivisHubからモデルを手動でダウンロードするか、 音声合成モデルのURLを指定してダウンロードすることができます。

(補足) 音声合成モデルのIDの確認方法

音声合成モデルのIDは、APIドキュメントhttp://localhost:10101/docsにその他にある/speakersを使用して確認することができます。

以下のようなJSONデータが表示さるのでIDを確認して下さい。

[
  {
    "name": "Anneli",
    "speaker_uuid": "e756b8e4-b606-4e15-99b1-3f9c6a1b2317",
    "styles": [
      {
        "name": "ノーマル",
        "id": 888753760,
        "type": "talk"
      }
    ],
    "version": "1.0.0",
    "supported_features": {
      "permitted_synthesis_morphing": "NOTHING"
    }
  },
  {
    "name": "fumifumi",
    "speaker_uuid": "754d769b-7128-4172-964e-b10945d55e39",
    "styles": [
      {
        "name": "ノーマル",
        "id": 606865152,
        "type": "talk"
      }
    ],
    "version": "1.0.0",
    "supported_features": {
      "permitted_synthesis_morphing": "NOTHING"
    }
  }
]

APIエンドポイント

サービスはhttp://localhost:8100で実行されます。

1. 本の生成開始

エンドポイント: POST /generate-book

リクエストボディ:

{
    "book_content": "本の内容の説明",
    "target_readers": "対象読者の説明",
    "n_pages": 50,
    "level": 1  // オプション：数式の使用頻度（1-5）
}

レスポンス:

{
    "status": "accepted",
    "message": "本の生成を開始しました",
    "task_id": "生成されたタスクID",
    "author": null
}

2. タスク状態の確認

エンドポイント: GET /task/{task_id}

レスポンス:

{
    "status": "completed",  // "processing", "completed", "failed"
    "output_dir": "出力ディレクトリのパス",
    "title": "生成された本のタイトル",
    "author": "PROVIDER:MODEL_NAME"  // 例："OPENAI:gpt-4"または"ANTHROPIC:claude-3-sonnet"
}

3. PDFのダウンロード

エンドポイント: GET /download/{task_id}

生成されたPDF本をダウンロードします。タスクが完了している場合のみ利用可能です。

4. カバー画像のダウンロード

エンドポイント: GET /download-cover/{task_id}

生成されたカバー画像をPNG形式でダウンロードします。タスクが完了している場合のみ利用可能です。

5. ヘルスチェック

エンドポイント: GET /health

レスポンス:

{
    "status": "healthy"
}

使用例

  1. 本の生成をリクエスト：
curl -X POST "http://localhost:8100/generate-book" \
     -H "Content-Type: application/json" \
     -d '{
           "book_content": "Pythonプログラミング入門",
           "target_readers": "プログラミング初心者",
           "n_pages": 50,
           "level": 1
         }'
  1. タスク状態の確認：
curl "http://localhost:8100/task/{task_id}"
  1. PDFのダウンロード：
curl -O -J "http://localhost:8100/download/{task_id}"
  1. カバー画像のダウンロード：
curl -O -J "http://localhost:8100/download-cover/{task_id}"
  1. WAVファイルのダウンロード：
curl -O -J "http://localhost:8100/download-wav/{task_id}"

APIドキュメント

Swagger UIを使用したAPIドキュメントは以下で利用可能です：

謝辞

O'REILLY風のカバー画像は、O-RLY-Book-GeneratorPublicのソースコードを基に作成されました。