Bug Report: pip install . Fails in Tortoise-TTS Installation on macOS (Apple Silicon)

[Caparrini]

Bug Report: pip install . Fails in Tortoise-TTS Installation on macOS (Apple Silicon)

Description:
When following the official installation instructions for Tortoise-TTS on macOS 14.4 (Apple Silicon, M3 Pro), the command pip install . fails due to incompatible dependencies in requirements.txt.

---

System Information:

• macOS Version: macOS 14.4
• Chip: Apple Silicon M3 Pro
• Python Version: Python 3.10 (installed via Homebrew)
• pip Version: pip 25.0
• Installation Method: Virtual environment (venv)
• PyTorch Version: Installed via pip install --pre torch torchvision torchaudio --index-url https://download.pytorch.org/whl/nightly/cpu

---

Steps to Reproduce:

1. Install Python 3.10 via Homebrew:

   brew install [email protected]

2. Install PyTorch (before activating venv, as per tutorial):

   pip3.10 install --pre torch torchvision torchaudio --index-url https://download.pytorch.org/whl/nightly/cpu

3. Create and activate a virtual environment:

   python3.10 -m venv .venv
   source .venv/bin/activate

4. Install required dependencies:

   pip install numba inflect psutil
   pip install --pre torch torchvision torchaudio --index-url https://download.pytorch.org/whl/nightly/cpu
   pip install transformers

5. Clone Tortoise-TTS and attempt installation:

   git clone https://github.com/neonbjb/tortoise-tts.git
   cd tortoise-tts
   pip install .

---

Expected Behavior:

The pip install . command should resolve dependencies and install Tortoise-TTS correctly within the virtual environment.

Observed Behavior:

• The installation fails due to dependency resolution errors.
• pip reports conflicting requirements.
• Some dependencies appear to be incompatible on Apple Silicon.
• ERROR: Cannot install tortoise-tts==3.0.0 and transformers==4.31.0 because these package versions have conflicting dependencies.

---

Possible Causes:

1. Dependency conflicts in requirements.txt preventing proper resolution.
2. Apple Silicon incompatibility with certain packages.
3. Pre-installed PyTorch (outside venv) may interfere despite re-installation inside the venv.

---

Suggested Fixes or Workarounds:

• Clarify the correct installation sequence for Apple Silicon.
• Provide an updated requirements.txt or Apple-specific installation guide.
• Explicitly list known working versions of dependencies.

---

Logs and Errors:

Full error message when running pip install .

(.venv) paradox@macpro tortoise-tts % pip install .                                              
Processing /Users/paradox/workspace/tortoise-tts
  Installing build dependencies ... done
  Getting requirements to build wheel ... done
  Preparing metadata (pyproject.toml) ... done
Requirement already satisfied: tqdm in ./.venv/lib/python3.10/site-packages (from tortoise-tts==3.0.0) (4.67.1)
Requirement already satisfied: rotary_embedding_torch in ./.venv/lib/python3.10/site-packages (from tortoise-tts==3.0.0) (0.8.6)
Requirement already satisfied: inflect in ./.venv/lib/python3.10/site-packages (from tortoise-tts==3.0.0) (7.5.0)
Requirement already satisfied: progressbar in ./.venv/lib/python3.10/site-packages (from tortoise-tts==3.0.0) (2.5)
Requirement already satisfied: einops in ./.venv/lib/python3.10/site-packages (from tortoise-tts==3.0.0) (0.8.0)
Requirement already satisfied: unidecode in ./.venv/lib/python3.10/site-packages (from tortoise-tts==3.0.0) (1.3.8)
Requirement already satisfied: scipy in ./.venv/lib/python3.10/site-packages (from tortoise-tts==3.0.0) (1.15.1)
Requirement already satisfied: librosa in ./.venv/lib/python3.10/site-packages (from tortoise-tts==3.0.0) (0.10.2.post1)
Requirement already satisfied: transformers==4.31.0 in ./.venv/lib/python3.10/site-packages (from tortoise-tts==3.0.0) (4.31.0)
Collecting tokenizers==0.14.0 (from tortoise-tts==3.0.0)
  Using cached tokenizers-0.14.0-cp310-cp310-macosx_11_0_arm64.whl.metadata (6.7 kB)
Collecting scipy (from tortoise-tts==3.0.0)
  Using cached scipy-1.13.1-cp310-cp310-macosx_12_0_arm64.whl.metadata (60 kB)
Requirement already satisfied: numpy<2.3,>=1.22.4 in ./.venv/lib/python3.10/site-packages (from scipy->tortoise-tts==3.0.0) (2.1.3)
Collecting huggingface_hub<0.17,>=0.16.4 (from tokenizers==0.14.0->tortoise-tts==3.0.0)
  Using cached huggingface_hub-0.16.4-py3-none-any.whl.metadata (12 kB)
Requirement already satisfied: filelock in ./.venv/lib/python3.10/site-packages (from transformers==4.31.0->tortoise-tts==3.0.0) (3.16.1)
Requirement already satisfied: packaging>=20.0 in ./.venv/lib/python3.10/site-packages (from transformers==4.31.0->tortoise-tts==3.0.0) (24.2)
Requirement already satisfied: pyyaml>=5.1 in ./.venv/lib/python3.10/site-packages (from transformers==4.31.0->tortoise-tts==3.0.0) (6.0.2)
Requirement already satisfied: regex!=2019.12.17 in ./.venv/lib/python3.10/site-packages (from transformers==4.31.0->tortoise-tts==3.0.0) (2024.11.6)
Requirement already satisfied: requests in ./.venv/lib/python3.10/site-packages (from transformers==4.31.0->tortoise-tts==3.0.0) (2.32.3)
INFO: pip is looking at multiple versions of transformers to determine which version is compatible with other requirements. This could take a while.
ERROR: Cannot install tortoise-tts==3.0.0 and transformers==4.31.0 because these package versions have conflicting dependencies.

The conflict is caused by:
tortoise-tts 3.0.0 depends on tokenizers==0.14.0
transformers 4.31.0 depends on tokenizers!=0.11.3, <0.14 and >=0.11.1

To fix this you could try to:

1. loosen the range of package versions you've specified
2. remove package versions to allow pip to attempt to solve the dependency conflict

ERROR: ResolutionImpossible: for help visit https://pip.pypa.io/en/latest/topics/dependency-resolution/#dealing-with-dependency-conflicts

---

Would appreciate guidance on:

1. Confirming correct installation steps for Apple Silicon users.
2. Debugging dependency conflicts in requirements.txt.
3. Identifying a workaround to successfully install Tortoise-TTS.

Thanks for your help! 🚀

[Diliard]

Edit:

This issue is caused because the install.py is outdated change the requirement of tokenizers from 0.14.0 to 0.13.3.

reference:
#816