diff --git a/README.md b/README.md index 7cce6d3..5d484ba 100644 --- a/README.md +++ b/README.md @@ -22,14 +22,18 @@ Documentation: https://docs.sillytavern.app/ ## How to run -### :exclamation: **IMPORTANT!** - Default **requirements.txt** contains only basic packages for text processing +### :exclamation: **IMPORTANT!** Requirement files explained -If you want to use the most advanced features (like Stable Diffusion, TTS), change that to **requirements-complete.txt** in commands below. See [Modules](#modules) section for more details. +* Default **requirements.txt** installs PyTorch CUDA by default. +* If you run on AMD GPU, use **requirements-rocm.txt** file instead. +* If you run on Apple Silicon (ARM series), use the **requirements-silicon.txt** file instead. +* If you want to use Coqui TTS, install **requirements-coqui.txt** after choosing the requirements from the list above. +* If you want to use RVC, install **requirements-rvc.txt** after choosing the requirements from the list above. +* BE WARNED THAT: + - Coqui package is extremely unstable and may break other packages or not work at all in your environment. + - It's not really worth it. -If you run on Apple Silicon (M1/M2), use the **requirements-silicon.txt** file instead. - -### Getting an error when installing from requirements-complete.txt? +### Common errors when installing requirements > ERROR: Could not build wheels for hnswlib, which is required to install pyproject.toml-based projects @@ -134,17 +138,18 @@ cd SillyTavern-extras ## Modules -| Name | Description | Included in default requirements.txt | -| ----------- | --------------------------------- | ------ | -| `caption` | Image captioning | ✔️ Yes | -| `summarize` | Text summarization | ✔️ Yes | -| `classify` | Text sentiment classification | ✔️ Yes | -| `sd` | Stable Diffusion image generation | :x: No (✔️ remote) | -| `silero-tts` | [Silero TTS server](https://github.com/ouoertheo/silero-api-server) | :x: No | -| `edge-tts` | [Microsoft Edge TTS client](https://github.com/rany2/edge-tts) | ✔️ Yes | -| `coqui-tts` | [Coqui TTS server](https://github.com/coqui-ai/TTS) | :x: No | -| `chromadb` | Vector storage server | :x: No | -| `talkinghead` | Talking Head Sprites | :x: No | +| Name | Description | +| ------------- | ------------------------------------------------------------------- | +| `caption` | Image captioning | +| `summarize` | Text summarization | +| `classify` | Text sentiment classification | +| `sd` | Stable Diffusion image generation (remote A1111 server by default) | +| `silero-tts` | [Silero TTS server](https://github.com/ouoertheo/silero-api-server) | +| `chromadb` | Vector storage server | +| `talkinghead` | Talking Head Sprites | +| `edge-tts` | [Microsoft Edge TTS client](https://github.com/rany2/edge-tts) | +| `coqui-tts` | [Coqui TTS server](https://github.com/coqui-ai/TTS) | +| `rvc` | Real-time voice cloning | ## Additional options | Flag | Description | diff --git a/requirements-complete.txt b/requirements-complete.txt deleted file mode 100644 index ec3d97c..0000000 --- a/requirements-complete.txt +++ /dev/null @@ -1,31 +0,0 @@ -flask==2.3.2 -flask-cloudflared==0.0.13 -flask-cors==4.0.0 -flask-compress==1.13 -markdown==3.4.3 -Pillow==9.5.0 -colorama==0.4.6 -webuiapi==0.9.5 ---extra-index-url https://download.pytorch.org/whl/cu118 -torch==2.0.0+cu118 -torchvision==0.15.1 -torchaudio==2.0.1+cu118 -accelerate==0.20.3 -transformers==4.28.1 -diffusers==0.17.1 -silero-api-server==0.2.9 -chromadb==0.4.10 -sentence_transformers==2.2.2 -edge-tts==6.1.8 - -vosk==0.3.44 -sounddevice==0.4.6 -openai-whisper==20230314 - -TTS==0.15.6 -fastapi==0.99.1 -wxpython==4.2.1; sys_platform == 'win32' or sys_platform == 'darwin' -mecab-python3==1.0.6 -unidic-lite==1.0.8 -py-espeak-ng==0.1.8 -TTS[ja] diff --git a/requirements-coqui.txt b/requirements-coqui.txt new file mode 100644 index 0000000..8738187 --- /dev/null +++ b/requirements-coqui.txt @@ -0,0 +1,5 @@ +TTS +mecab-python3 +unidic-lite +py-espeak-ng +TTS[ja] diff --git a/requirements-dev.txt b/requirements-dev.txt deleted file mode 100644 index 7e66a17..0000000 --- a/requirements-dev.txt +++ /dev/null @@ -1 +0,0 @@ -black diff --git a/requirements-rocm.txt b/requirements-rocm.txt index 2e22a2d..71d270e 100644 --- a/requirements-rocm.txt +++ b/requirements-rocm.txt @@ -1,24 +1,22 @@ -flask==2.3.2 -flask-cloudflared==0.0.13 -flask-cors==4.0.0 -flask-compress==1.13 -markdown==3.4.3 +flask +flask-cloudflared +flask-cors +flask-compress +markdown Pillow==9.5.0 -colorama==0.4.6 -webuiapi==0.9.5 +colorama +webuiapi --extra-index-url https://download.pytorch.org/whl/rocm5.6 torch>=2.0.0+rocm5.4.2,<=2.1.0+rocm5.6 torchvision>=0.15.0+rocm5.4.2,<=0.16.0+rocm5.6 torchaudio>=2.0.0+rocm5.4.2,<=2.1.0+rocm5.6 -accelerate==0.20.3 -transformers==4.28.1 -diffusers==0.17.1 -silero-api-server==0.2.9 -chromadb==0.4.10 -sentence_transformers==2.2.2 -edge-tts==6.1.8 -TTS==0.15.6 -fastapi==0.99.1 -wxpython==4.2.1 -mecab-python3==1.0.6 -unidic-lite==1.0.8 +transformers +silero-api-server +diffusers +accelerate +chromadb +sentence_transformers +edge-tts +matplotlib +fastapi +wxpython diff --git a/requirements-rvc.txt b/requirements-rvc.txt index b4540e4..27223ca 100644 --- a/requirements-rvc.txt +++ b/requirements-rvc.txt @@ -6,6 +6,6 @@ omegaconf==2.3.0 hydra-core==1.3.0 bitarray==2.8.1 sacrebleu==2.3.1 -numpy==1.23.0 +numpy>=1.24.2 ffmpeg-python==0.2.0 py7zr==0.20.6 \ No newline at end of file diff --git a/requirements-silicon.txt b/requirements-silicon.txt index ed55409..94a4ea9 100644 --- a/requirements-silicon.txt +++ b/requirements-silicon.txt @@ -1,24 +1,21 @@ -flask==2.3.2 -flask-cloudflared==0.0.13 -flask-cors==4.0.0 -flask-compress==1.13 -markdown==3.4.3 +flask +flask-cloudflared +flask-cors +flask-compress +markdown Pillow==9.5.0 -colorama==0.4.6 -torch==2.0.0 -transformers==4.28.1 -webuiapi==0.9.5 -edge-tts==6.1.8 -silero-api-server==0.2.9 -torchvision==0.15.1 -torchaudio==2.0.1 -diffusers==0.17.1 -accelerate==0.20.3 -chromadb==0.4.10 -sentence_transformers==2.2.2 -edge-tts==6.1.8 -TTS==0.15.6 -fastapi==0.99.1 -wxpython==4.2.1 -mecab-python3==1.0.6 -unidic-lite==1.0.8 +colorama +webuiapi +transformers +silero-api-server +torch +torchvision +torchaudio +diffusers +accelerate +chromadb +sentence_transformers +edge-tts +matplotlib +fastapi +wxpython diff --git a/requirements.txt b/requirements.txt index b0f0f12..8dcb254 100644 --- a/requirements.txt +++ b/requirements.txt @@ -1,12 +1,27 @@ -flask==2.3.2 -flask-cloudflared==0.0.13 -flask-cors==4.0.0 -flask-compress==1.13 -markdown==3.4.3 +flask +flask-cloudflared +flask-cors +flask-compress +markdown +black Pillow==9.5.0 -colorama==0.4.6 +colorama +webuiapi --extra-index-url https://download.pytorch.org/whl/cu118 -torch==2.0.0+cu118 -transformers==4.28.1 -webuiapi==0.9.5 -edge-tts==6.1.8 +torch +torchvision +torchaudio +accelerate +transformers +diffusers +silero-api-server +chromadb +sentence_transformers +edge-tts +matplotlib +vosk +sounddevice +openai-whisper + +fastapi +wxpython; sys_platform == 'win32' or sys_platform == 'darwin'