===============================================
IndexTTS2 Model Download Guide
模型下载指南 | モデルダウンロードガイド | Guía de Descarga de Modelos
===============================================

Version: 1.0
Last Updated: 2025-11-24

===============================================
ENGLISH VERSION
===============================================

IMPORTANT NOTICE
----------------
This project requires model files that are NOT included in the Git repository 
due to GitHub's file size limitations. You must download these models before 
using the application.

Total Model Size: ~8-10 GB


QUICK START
-----------
Option 1: Automatic Download (Recommended)
   Run: download_models.bat
   
   The script will:
   - Try international sources first
   - Fallback to Chinese mirrors if needed
   - Verify downloads automatically

Option 2: Manual Download
   See "MANUAL DOWNLOAD INSTRUCTIONS" section below


REQUIRED MODELS
---------------

The models are stored in two locations:

1. LOCAL MODEL FILES (checkpoints/)
   - These are custom-trained models specific to IndexTTS2
   
2. HUGGINGFACE MODELS (checkpoints/hf_cache/)
   - These are public models from Hugging Face Hub


AUTOMATIC DOWNLOAD
-------------------

Step 1: Run the download script
   Double-click: download_models.bat
   
   Or in terminal:
   cd G:\LMdownloader\lmd_data_root\apps\index-tts2
   download_models.bat

Step 2: Wait for completion
   - Progress will be displayed
   - Download may take 30-60 minutes depending on your connection
   - Script will verify all files

Step 3: Verification
   If successful, you will see:
   "✓ All models downloaded successfully!"


MANUAL DOWNLOAD INSTRUCTIONS
-----------------------------

If automatic download fails, you can download manually:

A. HUGGING FACE MODELS
-----------------------

1. amphion/MaskGCT
   International: https://huggingface.co/amphion/MaskGCT
   China Mirror: https://hf-mirror.com/amphion/MaskGCT
   
   Required Files:
   - semantic_codec/model.safetensors
   
   Save to: checkpoints/hf_cache/models--amphion--MaskGCT/


2. facebook/w2v-bert-2.0
   International: https://huggingface.co/facebook/w2v-bert-2.0
   China Mirror: https://hf-mirror.com/facebook/w2v-bert-2.0
   
   Required Files:
   - model.safetensors
   - config.json
   - preprocessor_config.json
   
   Save to: checkpoints/hf_cache/models--facebook--w2v-bert-2.0/


3. funasr/campplus
   International: https://huggingface.co/funasr/campplus
   China Mirror: https://hf-mirror.com/funasr/campplus
   
   Required Files:
   - campplus_cn_common.bin
   
   Save to: checkpoints/hf_cache/models--funasr--campplus/


4. nvidia/bigvgan_v2_22khz_80band_256x
   International: https://huggingface.co/nvidia/bigvgan_v2_22khz_80band_256x
   China Mirror: https://hf-mirror.com/nvidia/bigvgan_v2_22khz_80band_256x
   
   Required Files:
   - bigvgan_generator.pt
   - config.json
   
   Save to: checkpoints/hf_cache/models--nvidia--bigvgan_v2_22khz_80band_256x/


B. CUSTOM MODEL FILES
---------------------

These files are NOT on Hugging Face. You need to obtain them from:

Option 1: Project Release Page
   Download from: [Project GitHub Releases]
   File: checkpoints.zip
   Extract to: checkpoints/

Option 2: Alternative Sources
   Contact project maintainers for access

Required Files:
- bpe.model
- config.yaml
- configuration.json
- feat1.pt
- feat2.pt
- gpt.pth
- s2mel.pth
- wav2vec2bert_stats.pt
- pinyin.vocab
- qwen0.6bemo4-merge/ (entire folder with Qwen model)


DIRECTORY STRUCTURE
-------------------

After downloading all models, your directory should look like:

checkpoints/
├── bpe.model
├── config.yaml
├── configuration.json
├── feat1.pt
├── feat2.pt
├── gpt.pth
├── s2mel.pth
├── wav2vec2bert_stats.pt
├── pinyin.vocab
├── qwen0.6bemo4-merge/
│   ├── model.safetensors
│   ├── config.json
│   ├── tokenizer.json
│   └── ... (other files)
└── hf_cache/
    ├── models--amphion--MaskGCT/
    │   └── snapshots/.../semantic_codec/model.safetensors
    ├── models--facebook--w2v-bert-2.0/
    │   └── snapshots/.../model.safetensors
    ├── models--funasr--campplus/
    │   └── snapshots/.../campplus_cn_common.bin
    └── models--nvidia--bigvgan_v2_22khz_80band_256x/
        └── snapshots/.../bigvgan_generator.pt


TROUBLESHOOTING
---------------

Problem: "Cannot access huggingface.co"
Solution: 
   - Use Chinese mirror: hf-mirror.com
   - Or run: download_models.bat
     (It will automatically try mirrors)

Problem: "Download interrupted"
Solution:
   - Re-run download_models.bat
   - It will resume from where it stopped

Problem: "Model file not found"
Solution:
   - Verify directory structure matches above
   - Check file names (case-sensitive on Linux)
   - Ensure files are fully downloaded (check file sizes)

Problem: "Out of disk space"
Solution:
   - Free up at least 12 GB of disk space
   - Delete temp files: cleanup_duplicates.bat


VERIFICATION
------------

To verify all models are correctly installed:

1. Check file existence:
   - All files listed above should be present
   
2. Check file sizes:
   - qwen0.6bemo4-merge/model.safetensors: ~1.2 GB
   - gpt.pth: ~800 MB
   - s2mel.pth: ~500 MB
   - w2v-bert-2.0 model.safetensors: ~600 MB
   
3. Run the application:
   - If it starts without errors, models are OK
   - Try generating a test audio


ADDITIONAL RESOURCES
--------------------

- Hugging Face China Mirror: https://hf-mirror.com
- Project Repository: [Your GitHub URL]
- Documentation: See SETUP_GUIDE.txt
- User Manual: See USER_MANUAL.txt


===============================================
中文版本
===============================================

重要提示
--------
由于 GitHub 文件大小限制，本项目所需的模型文件未包含在 Git 仓库中。
您必须在使用应用程序之前下载这些模型。

模型总大小：约 8-10 GB


快速开始
--------
方式1：自动下载（推荐）
   运行：download_models.bat
   
   脚本将：
   - 优先尝试国际源
   - 失败时自动切换到国内镜像
   - 自动验证下载

方式2：手动下载
   查看下方"手动下载说明"部分


所需模型
--------

模型存储在两个位置：

1. 本地模型文件（checkpoints/）
   - 这些是 IndexTTS2 专用的定制训练模型
   
2. HUGGINGFACE 模型（checkpoints/hf_cache/）
   - 这些是来自 Hugging Face Hub 的公开模型


自动下载
--------

步骤 1：运行下载脚本
   双击：download_models.bat
   
   或在终端中：
   cd G:\LMdownloader\lmd_data_root\apps\index-tts2
   download_models.bat

步骤 2：等待完成
   - 将显示进度
   - 根据您的网络连接，下载可能需要 30-60 分钟
   - 脚本将验证所有文件

步骤 3：验证
   如果成功，您将看到：
   "✓ 所有模型下载成功！"


手动下载说明
-----------

如果自动下载失败，您可以手动下载：

A. HUGGING FACE 模型
--------------------

1. amphion/MaskGCT
   国际源：https://huggingface.co/amphion/MaskGCT
   国内镜像：https://hf-mirror.com/amphion/MaskGCT
   
   所需文件：
   - semantic_codec/model.safetensors
   
   保存到：checkpoints/hf_cache/models--amphion--MaskGCT/


2. facebook/w2v-bert-2.0
   国际源：https://huggingface.co/facebook/w2v-bert-2.0
   国内镜像：https://hf-mirror.com/facebook/w2v-bert-2.0
   
   所需文件：
   - model.safetensors
   - config.json
   - preprocessor_config.json
   
   保存到：checkpoints/hf_cache/models--facebook--w2v-bert-2.0/


3. funasr/campplus
   国际源：https://huggingface.co/funasr/campplus
   国内镜像：https://hf-mirror.com/funasr/campplus
   
   所需文件：
   - campplus_cn_common.bin
   
   保存到：checkpoints/hf_cache/models--funasr--campplus/


4. nvidia/bigvgan_v2_22khz_80band_256x
   国际源：https://huggingface.co/nvidia/bigvgan_v2_22khz_80band_256x
   国内镜像：https://hf-mirror.com/nvidia/bigvgan_v2_22khz_80band_256x
   
   所需文件：
   - bigvgan_generator.pt
   - config.json
   
   保存到：checkpoints/hf_cache/models--nvidia--bigvgan_v2_22khz_80band_256x/


B. 定制模型文件
---------------

这些文件不在 Hugging Face 上。您需要从以下位置获取：

方式1：项目发布页面
   下载地址：[项目 GitHub Releases]
   文件：checkpoints.zip
   解压到：checkpoints/

方式2：其他来源
   联系项目维护者获取访问权限

所需文件：
- bpe.model
- config.yaml
- configuration.json
- feat1.pt
- feat2.pt
- gpt.pth
- s2mel.pth
- wav2vec2bert_stats.pt
- pinyin.vocab
- qwen0.6bemo4-merge/（整个文件夹及Qwen模型）


目录结构
--------

下载所有模型后，您的目录应如下所示：

checkpoints/
├── bpe.model
├── config.yaml
├── configuration.json
├── feat1.pt
├── feat2.pt
├── gpt.pth
├── s2mel.pth
├── wav2vec2bert_stats.pt
├── pinyin.vocab
├── qwen0.6bemo4-merge/
│   ├── model.safetensors
│   ├── config.json
│   ├── tokenizer.json
│   └── ...（其他文件）
└── hf_cache/
    ├── models--amphion--MaskGCT/
    │   └── snapshots/.../semantic_codec/model.safetensors
    ├── models--facebook--w2v-bert-2.0/
    │   └── snapshots/.../model.safetensors
    ├── models--funasr--campplus/
    │   └── snapshots/.../campplus_cn_common.bin
    └── models--nvidia--bigvgan_v2_22khz_80band_256x/
        └── snapshots/.../bigvgan_generator.pt


故障排除
--------

问题："无法访问 huggingface.co"
解决：
   - 使用国内镜像：hf-mirror.com
   - 或运行：download_models.bat
     （它会自动尝试镜像）

问题："下载中断"
解决：
   - 重新运行 download_models.bat
   - 它将从停止的地方继续

问题："找不到模型文件"
解决：
   - 验证目录结构是否与上面匹配
   - 检查文件名（Linux 上区分大小写）
   - 确保文件已完全下载（检查文件大小）

问题："磁盘空间不足"
解决：
   - 至少释放 12 GB 磁盘空间
   - 删除临时文件：cleanup_duplicates.bat


验证
----

要验证所有模型是否正确安装：

1. 检查文件存在性：
   - 上面列出的所有文件都应该存在
   
2. 检查文件大小：
   - qwen0.6bemo4-merge/model.safetensors：约 1.2 GB
   - gpt.pth：约 800 MB
   - s2mel.pth：约 500 MB
   - w2v-bert-2.0 model.safetensors：约 600 MB
   
3. 运行应用程序：
   - 如果启动时没有错误，则模型正常
   - 尝试生成测试音频


其他资源
--------

- Hugging Face 国内镜像：https://hf-mirror.com
- 项目仓库：[您的 GitHub URL]
- 文档：查看 SETUP_GUIDE.txt
- 用户手册：查看 USER_MANUAL.txt


===============================================
日本語版
===============================================

重要なお知らせ
--------------
GitHubのファイルサイズ制限により、このプロジェクトに必要なモデルファイルは
Gitリポジトリに含まれていません。アプリケーションを使用する前に、
これらのモデルをダウンロードする必要があります。

モデル総サイズ：約 8-10 GB


クイックスタート
----------------
方法1：自動ダウンロード（推奨）
   実行：download_models.bat
   
   スクリプトは：
   - まず国際ソースを試みます
   - 必要に応じて中国ミラーにフォールバック
   - ダウンロードを自動的に検証

方法2：手動ダウンロード
   下記の「手動ダウンロード手順」セクションを参照


必要なモデル
-----------

モデルは2つの場所に保存されます：

1. ローカルモデルファイル（checkpoints/）
   - これらはIndexTTS2専用のカスタム訓練モデルです
   
2. HUGGINGFACE モデル（checkpoints/hf_cache/）
   - これらはHugging Face Hubの公開モデルです


自動ダウンロード
---------------

ステップ 1：ダウンロードスクリプトを実行
   ダブルクリック：download_models.bat
   
   またはターミナルで：
   cd G:\LMdownloader\lmd_data_root\apps\index-tts2
   download_models.bat

ステップ 2：完了を待つ
   - 進行状況が表示されます
   - 接続によっては30〜60分かかる場合があります
   - スクリプトがすべてのファイルを検証します

ステップ 3：検証
   成功すると次のように表示されます：
   "✓ すべてのモデルが正常にダウンロードされました！"


手動ダウンロード手順
-------------------

自動ダウンロードが失敗した場合、手動でダウンロードできます：

A. HUGGING FACE モデル
----------------------

1. amphion/MaskGCT
   国際：https://huggingface.co/amphion/MaskGCT
   中国ミラー：https://hf-mirror.com/amphion/MaskGCT
   
   必要なファイル：
   - semantic_codec/model.safetensors
   
   保存先：checkpoints/hf_cache/models--amphion--MaskGCT/


2. facebook/w2v-bert-2.0
   国際：https://huggingface.co/facebook/w2v-bert-2.0
   中国ミラー：https://hf-mirror.com/facebook/w2v-bert-2.0
   
   必要なファイル：
   - model.safetensors
   - config.json
   - preprocessor_config.json
   
   保存先：checkpoints/hf_cache/models--facebook--w2v-bert-2.0/


3. funasr/campplus
   国際：https://huggingface.co/funasr/campplus
   中国ミラー：https://hf-mirror.com/funasr/campplus
   
   必要なファイル：
   - campplus_cn_common.bin
   
   保存先：checkpoints/hf_cache/models--funasr--campplus/


4. nvidia/bigvgan_v2_22khz_80band_256x
   国際：https://huggingface.co/nvidia/bigvgan_v2_22khz_80band_256x
   中国ミラー：https://hf-mirror.com/nvidia/bigvgan_v2_22khz_80band_256x
   
   必要なファイル：
   - bigvgan_generator.pt
   - config.json
   
   保存先：checkpoints/hf_cache/models--nvidia--bigvgan_v2_22khz_80band_256x/


B. カスタムモデルファイル
------------------------

これらのファイルはHugging Faceにありません。以下から取得する必要があります：

方法1：プロジェクトリリースページ
   ダウンロード：[プロジェクトGitHub Releases]
   ファイル：checkpoints.zip
   展開先：checkpoints/

方法2：代替ソース
   アクセスについてはプロジェクトメンテナーにお問い合わせください

必要なファイル：
- bpe.model
- config.yaml
- configuration.json
- feat1.pt
- feat2.pt
- gpt.pth
- s2mel.pth
- wav2vec2bert_stats.pt
- pinyin.vocab
- qwen0.6bemo4-merge/（Qwenモデルを含むフォルダ全体）


ディレクトリ構造
---------------

すべてのモデルをダウンロードした後、ディレクトリは次のようになります：

checkpoints/
├── bpe.model
├── config.yaml
├── configuration.json
├── feat1.pt
├── feat2.pt
├── gpt.pth
├── s2mel.pth
├── wav2vec2bert_stats.pt
├── pinyin.vocab
├── qwen0.6bemo4-merge/
│   ├── model.safetensors
│   ├── config.json
│   ├── tokenizer.json
│   └── ...（その他のファイル）
└── hf_cache/
    ├── models--amphion--MaskGCT/
    │   └── snapshots/.../semantic_codec/model.safetensors
    ├── models--facebook--w2v-bert-2.0/
    │   └── snapshots/.../model.safetensors
    ├── models--funasr--campplus/
    │   └── snapshots/.../campplus_cn_common.bin
    └── models--nvidia--bigvgan_v2_22khz_80band_256x/
        └── snapshots/.../bigvgan_generator.pt


トラブルシューティング
---------------------

問題："huggingface.coにアクセスできません"
解決策：
   - 中国ミラーを使用：hf-mirror.com
   - または実行：download_models.bat
     （自動的にミラーを試みます）

問題："ダウンロードが中断されました"
解決策：
   - download_models.batを再実行
   - 停止した場所から再開されます

問題："モデルファイルが見つかりません"
解決策：
   - ディレクトリ構造が上記と一致することを確認
   - ファイル名を確認（Linuxでは大文字小文字を区別）
   - ファイルが完全にダウンロードされていることを確認（ファイルサイズを確認）

問題："ディスク容量不足"
解決策：
   - 少なくとも12 GBのディスク容量を解放
   - 一時ファイルを削除：cleanup_duplicates.bat


検証
----

すべてのモデルが正しくインストールされているか確認するには：

1. ファイルの存在を確認：
   - 上記のすべてのファイルが存在する必要があります
   
2. ファイルサイズを確認：
   - qwen0.6bemo4-merge/model.safetensors：約 1.2 GB
   - gpt.pth：約 800 MB
   - s2mel.pth：約 500 MB
   - w2v-bert-2.0 model.safetensors：約 600 MB
   
3. アプリケーションを実行：
   - エラーなく起動すれば、モデルは正常です
   - テスト音声を生成してみてください


その他のリソース
---------------

- Hugging Face 中国ミラー：https://hf-mirror.com
- プロジェクトリポジトリ：[GitHubのURL]
- ドキュメント：SETUP_GUIDE.txtを参照
- ユーザーマニュアル：USER_MANUAL.txtを参照


===============================================
VERSIÓN EN ESPAÑOL
===============================================

AVISO IMPORTANTE
----------------
Debido a las limitaciones de tamaño de archivo de GitHub, los archivos de 
modelo requeridos para este proyecto NO están incluidos en el repositorio Git.
Debe descargar estos modelos antes de usar la aplicación.

Tamaño total del modelo: ~8-10 GB


INICIO RÁPIDO
-------------
Opción 1: Descarga Automática (Recomendado)
   Ejecutar: download_models.bat
   
   El script:
   - Intentará primero fuentes internacionales
   - Cambiará a espejos chinos si es necesario
   - Verificará descargas automáticamente

Opción 2: Descarga Manual
   Ver sección "INSTRUCCIONES DE DESCARGA MANUAL" abajo


MODELOS REQUERIDOS
------------------

Los modelos se almacenan en dos ubicaciones:

1. ARCHIVOS DE MODELO LOCAL (checkpoints/)
   - Estos son modelos personalizados específicos de IndexTTS2
   
2. MODELOS HUGGINGFACE (checkpoints/hf_cache/)
   - Estos son modelos públicos de Hugging Face Hub


DESCARGA AUTOMÁTICA
-------------------

Paso 1: Ejecutar el script de descarga
   Doble clic: download_models.bat
   
   O en terminal:
   cd G:\LMdownloader\lmd_data_root\apps\index-tts2
   download_models.bat

Paso 2: Esperar a que se complete
   - Se mostrará el progreso
   - La descarga puede tardar 30-60 minutos según su conexión
   - El script verificará todos los archivos

Paso 3: Verificación
   Si tiene éxito, verá:
   "✓ ¡Todos los modelos descargados con éxito!"


INSTRUCCIONES DE DESCARGA MANUAL
---------------------------------

Si la descarga automática falla, puede descargar manualmente:

A. MODELOS HUGGING FACE
------------------------

1. amphion/MaskGCT
   Internacional: https://huggingface.co/amphion/MaskGCT
   Espejo China: https://hf-mirror.com/amphion/MaskGCT
   
   Archivos Requeridos:
   - semantic_codec/model.safetensors
   
   Guardar en: checkpoints/hf_cache/models--amphion--MaskGCT/


2. facebook/w2v-bert-2.0
   Internacional: https://huggingface.co/facebook/w2v-bert-2.0
   Espejo China: https://hf-mirror.com/facebook/w2v-bert-2.0
   
   Archivos Requeridos:
   - model.safetensors
   - config.json
   - preprocessor_config.json
   
   Guardar en: checkpoints/hf_cache/models--facebook--w2v-bert-2.0/


3. funasr/campplus
   Internacional: https://huggingface.co/funasr/campplus
   Espejo China: https://hf-mirror.com/funasr/campplus
   
   Archivos Requeridos:
   - campplus_cn_common.bin
   
   Guardar en: checkpoints/hf_cache/models--funasr--campplus/


4. nvidia/bigvgan_v2_22khz_80band_256x
   Internacional: https://huggingface.co/nvidia/bigvgan_v2_22khz_80band_256x
   Espejo China: https://hf-mirror.com/nvidia/bigvgan_v2_22khz_80band_256x
   
   Archivos Requeridos:
   - bigvgan_generator.pt
   - config.json
   
   Guardar en: checkpoints/hf_cache/models--nvidia--bigvgan_v2_22khz_80band_256x/


B. ARCHIVOS DE MODELO PERSONALIZADOS
-------------------------------------

Estos archivos NO están en Hugging Face. Necesita obtenerlos de:

Opción 1: Página de Lanzamiento del Proyecto
   Descargar de: [Lanzamientos de GitHub del Proyecto]
   Archivo: checkpoints.zip
   Extraer en: checkpoints/

Opción 2: Fuentes Alternativas
   Contactar a los mantenedores del proyecto para acceso

Archivos Requeridos:
- bpe.model
- config.yaml
- configuration.json
- feat1.pt
- feat2.pt
- gpt.pth
- s2mel.pth
- wav2vec2bert_stats.pt
- pinyin.vocab
- qwen0.6bemo4-merge/ (carpeta completa con modelo Qwen)


ESTRUCTURA DE DIRECTORIOS
--------------------------

Después de descargar todos los modelos, su directorio debería verse así:

checkpoints/
├── bpe.model
├── config.yaml
├── configuration.json
├── feat1.pt
├── feat2.pt
├── gpt.pth
├── s2mel.pth
├── wav2vec2bert_stats.pt
├── pinyin.vocab
├── qwen0.6bemo4-merge/
│   ├── model.safetensors
│   ├── config.json
│   ├── tokenizer.json
│   └── ... (otros archivos)
└── hf_cache/
    ├── models--amphion--MaskGCT/
    │   └── snapshots/.../semantic_codec/model.safetensors
    ├── models--facebook--w2v-bert-2.0/
    │   └── snapshots/.../model.safetensors
    ├── models--funasr--campplus/
    │   └── snapshots/.../campplus_cn_common.bin
    └── models--nvidia--bigvgan_v2_22khz_80band_256x/
        └── snapshots/.../bigvgan_generator.pt


SOLUCIÓN DE PROBLEMAS
---------------------

Problema: "No se puede acceder a huggingface.co"
Solución:
   - Use espejo chino: hf-mirror.com
   - O ejecute: download_models.bat
     (Intentará automáticamente espejos)

Problema: "Descarga interrumpida"
Solución:
   - Vuelva a ejecutar download_models.bat
   - Reanudará desde donde se detuvo

Problema: "Archivo de modelo no encontrado"
Solución:
   - Verifique que la estructura de directorios coincida con la anterior
   - Verifique nombres de archivo (sensible a mayúsculas en Linux)
   - Asegúrese de que los archivos estén completamente descargados (verifique tamaños)

Problema: "Sin espacio en disco"
Solución:
   - Libere al menos 12 GB de espacio en disco
   - Elimine archivos temporales: cleanup_duplicates.bat


VERIFICACIÓN
------------

Para verificar que todos los modelos estén instalados correctamente:

1. Verificar existencia de archivos:
   - Todos los archivos listados arriba deben estar presentes
   
2. Verificar tamaños de archivo:
   - qwen0.6bemo4-merge/model.safetensors: ~1.2 GB
   - gpt.pth: ~800 MB
   - s2mel.pth: ~500 MB
   - w2v-bert-2.0 model.safetensors: ~600 MB
   
3. Ejecutar la aplicación:
   - Si inicia sin errores, los modelos están bien
   - Intente generar un audio de prueba


RECURSOS ADICIONALES
--------------------

- Espejo de Hugging Face China: https://hf-mirror.com
- Repositorio del Proyecto: [Su URL de GitHub]
- Documentación: Ver SETUP_GUIDE.txt
- Manual de Usuario: Ver USER_MANUAL.txt


===============================================
END OF GUIDE | 指南结束 | ガイド終了 | Fin de la Guía
===============================================

For setup and installation, see: SETUP_GUIDE.txt
安装和配置请查看：SETUP_GUIDE.txt
インストールとセットアップについては：SETUP_GUIDE.txt
Para configuración e instalación, consulte: SETUP_GUIDE.txt

Version: 1.0
Last Updated: 2025-11-24
Document: MODEL_DOWNLOAD_GUIDE.txt
===============================================

