diff --git a/README.md b/README.md index 1db0062..f296956 100644 --- a/README.md +++ b/README.md @@ -101,6 +101,7 @@ I did leave a mistake in the `/extensions/alltalk_tts/.gitignore` file at one po voices/*.* models/*.* outputs/*.* +finetune/*.* config.json confignew.json models.json @@ -253,10 +254,29 @@ I would suggest following [Problems Updating](https://github.com/erew123/alltalk As far as I am aware, these are to do with the chrome browser the gradio text-generation-webui in some way. I raised an issue about this on the text-generation-webui [here](https://github.com/oobabooga/text-generation-webui/issues/4788) where you can see that AllTalk is not loaded and the messages persist. Either way, this is more a warning than an actual issue, so shouldnt affect any functionality of either AllTalk or text-generation-webui, they are more just an annoyance. +#### 🟨 I have multiple GPU's and I have problems running Finetuning + +
+ Click to expand
+ +Finetuning pulls in various other scripts and some of those scripts can have issues with multiple Nvidia GPU's being present. Until the people that created those other scripts fix up their code, there is a workaround to temporarily tell your system to only use the 1x of your Nvidia GPU's. To do this: + +- **Windows** - You will start the script with `set CUDA_VISIBLE_DEVICES=0 && python finetune.py`
+After you have completed training, you can reset back with `set CUDA_VISIBLE_DEVICES=`
+ +- **Linux** - You will start the script with `CUDA_VISIBLE_DEVICES=0 python finetune.py`
+After you have completed training, you can reset back with `unset CUDA_VISIBLE_DEVICES`
+ +Rebooting your system will also unset this. The setting is only applied temporarily. + +Depending on which of your Nvidia GPU's is the more powerful one, you can change the `0` to `1` or whichever of your GPU's is the most powerful. + +
+ ## âš« Finetuning a model If you have a voice that the model doesnt quite reproduce correctly, or indeed you just want to improve the reproduced voice, then finetuning is a way to train your "XTTSv2 local" model **(stored in `/alltalk_tts/models/xxxxx/`)** on a specific voice. For this you will need: -- An Nvidia graphics card +- An Nvidia graphics card. (Please see this [note](https://github.com/erew123/alltalk_tts#i-have-multiple-gpus-and-i-have-problems-running-finetuning) if you have multiple Nvidia GPU's). - To install a few portions of the Nvidia CUDA 11.8 Toolkit (this will not impact text-generation-webui's cuda setup. - 18GB of disk space free (most of this is used temporarily) - At least 2 minutes of good quality speech from your chosen speaker in mp3, wav or flacc format, in one or more files (have tested as far as 20 minutes worth of audio). @@ -314,6 +334,18 @@ As mentioned you must have a small portion of the Nvidia CUDA Toolkit **11.8** i 11) Follow the on-screen instructions when the web interface starts up. 12) When you have finished finetuning, the final tab will tell you what to do with your files and how to move your newly trained model to the correct location on disk. +#### âš« Using a Finetuned model in Text-generation-webui + +At the end of the finetune process, you will have an option to `Compact and move model to /trainedmodel/` this will compact the raw training file and move it to `/model/trainedmodel/`. When AllTalk starts up within Text-generation-webui, if it finds a model in this location a new loader will appear in the interface for `XTTSv2 FT` and you can use this to load your finetuned model.

**Be careful** not to train a new model from the base model, then overwrite your current `/model/trainedmodel/` **if** you want a seperately trained model. This is why there is an `OPTION B` to move your just trained model to `/models/lastfinetuned/`. + +#### ⚫ Training one model with multiple voices + +At the end of the finetune process, you will have an option to `Compact and move model to /trainedmodel/` this will compact the raw training file and move it to `/model/trainedmodel/`. This model will become available when you start up finetuning. You will have a choice to train the Base Model or the `Existing finetuned model` (which is the one in `/model/trainedmodel/`). So you can use this to keep further training this model with additional voices, then copying it back to `/model/trainedmodel/` at the end of training. + +#### ⚫ Do I need to keep the raw training data/model? + +If you've compacted and moved your model, its highly unlikely you would want to keep that data, however the choice is there to keep it if you wish. It will be between 5-10GB in size, so most people will want to delete it. + ## 🔵🟢🟡 DeepSpeed Installation Options **NOTE**: You **DO NOT** need to set Text-generation-webUI's **--deepspeed** setting for AllTalk to be able to use DeepSpeed. These are two completely separate things and incorrectly setting that on Text-generation-webUI may cause other complications. diff --git a/finetune.py b/finetune.py index f156a6f..c94a725 100644 --- a/finetune.py +++ b/finetune.py @@ -48,6 +48,20 @@ else: print("[FINETUNE] \033[91mWarning\033[0m modeldownload.json is missing. Please run this script in the /alltalk_tts/ folder") sys.exit(1) +################################################## +#### Check to see if a finetuned model exists #### +################################################## +# Set the path to the directory +trained_model_directory = this_dir / "models" / "trainedmodel" +# Check if the directory "trainedmodel" exists +finetuned_model = trained_model_directory.exists() +# If the directory exists, check for the existence of the required files +# If true, this will add a extra option in the Gradio interface for loading Xttsv2 FT +if finetuned_model: + required_files = ["model.pth", "config.json", "vocab.json", "mel_stats.pth", "dvae.pth"] + finetuned_model = all((trained_model_directory / file).exists() for file in required_files) +basemodel_or_finetunedmodel = True + ##################### #### STEP 1 BITS #### ##################### @@ -272,6 +286,8 @@ def format_audio_list(target_language, whisper_model, out_path, gradio_progress= # deallocate VRAM and RAM del asr_model, final_eval_set, final_training_set, new_data_df, existing_metadata gc.collect() + existing_train_df = None + existing_eval_df = None print("[FINETUNE] Train CSV:", train_metadata_path) print("[FINETUNE] Eval CSV:", eval_metadata_path) print("[FINETUNE] Audio Total:", audio_total_size) @@ -289,6 +305,13 @@ from TTS.tts.layers.xtts.trainer.gpt_trainer import GPTArgs, GPTTrainer, GPTTrai from TTS.utils.manage import ModelManager +def basemodel_or_finetunedmodel_choice(value): + global basemodel_or_finetunedmodel + if value == "Base Model": + basemodel_or_finetunedmodel = True + elif value == "Existing finetuned model": + basemodel_or_finetunedmodel = False + def train_gpt(language, num_epochs, batch_size, grad_acumm, train_csv, eval_csv, output_path, max_audio_length=255995): # Logging parameters RUN_NAME = "XTTS_FT" @@ -321,12 +344,22 @@ def train_gpt(language, num_epochs, batch_size, grad_acumm, train_csv, eval_csv, # Add here the configs of the datasets DATASETS_CONFIG_LIST = [config_dataset] - # XTTS model checkpoints for fine-tuning. - TOKENIZER_FILE = str(this_dir / base_path / model_path / "vocab.json") # vocab.json file - XTTS_CHECKPOINT = str(this_dir / base_path / model_path / "model.pth") # model.pth file - XTTS_CONFIG_FILE = str(this_dir / base_path / model_path / "config.json") # config.json file - DVAE_CHECKPOINT = str(this_dir / base_path / model_path / "dvae.pth") - MEL_NORM_FILE = str(this_dir / base_path / model_path / "mel_stats.pth") + if basemodel_or_finetunedmodel: + # BASE XTTS model checkpoints for fine-tuning. + print("[FINETUNE] Starting finetuning on Base Model") + TOKENIZER_FILE = str(this_dir / base_path / model_path / "vocab.json") + XTTS_CHECKPOINT = str(this_dir / base_path / model_path / "model.pth") + XTTS_CONFIG_FILE = str(this_dir / base_path / model_path / "config.json") + DVAE_CHECKPOINT = str(this_dir / base_path / model_path / "dvae.pth") + MEL_NORM_FILE = str(this_dir / base_path / model_path / "mel_stats.pth") + else: + # FINETUNED XTTS model checkpoints for fine-tuning. + print("[FINETUNE] Starting finetuning on Existing Finetuned Model") + TOKENIZER_FILE = str(this_dir / base_path / "trainedmodel" / "vocab.json") + XTTS_CHECKPOINT = str(this_dir / base_path / "trainedmodel" / "model.pth") + XTTS_CONFIG_FILE = str(this_dir / base_path / "trainedmodel" / "config.json") + DVAE_CHECKPOINT = str(this_dir / base_path / "trainedmodel" / "dvae.pth") + MEL_NORM_FILE = str(this_dir / base_path / "trainedmodel" / "mel_stats.pth") # init args and config model_args = GPTArgs( @@ -417,9 +450,14 @@ def train_gpt(language, num_epochs, batch_size, grad_acumm, train_csv, eval_csv, trainer_out_path = trainer.output_path # deallocate VRAM and RAM - del model, trainer, train_samples, eval_samples + del model, trainer, train_samples, eval_samples, config, model_args, config_dataset gc.collect() - + train_samples = None + eval_samples = None + config_dataset = None + trainer = None + model = None + model_args = None return XTTS_CONFIG_FILE, XTTS_CHECKPOINT, TOKENIZER_FILE, trainer_out_path, speaker_ref ########################## @@ -514,7 +552,7 @@ def compact_model(): # Check if the best model file exists if best_model_path_str is None: - print("No trained model was found.") + print("[FINETUNE] No trained model was found.") return "No trained model was found." # Convert model_path_str to Path @@ -524,7 +562,7 @@ def compact_model(): try: checkpoint = torch.load(best_model_path, map_location=torch.device("cpu")) except Exception as e: - print("Error loading checkpoint:", e) + print("[FINETUNE] Error loading checkpoint:", e) raise del checkpoint["optimizer"] @@ -565,20 +603,128 @@ def compact_model(): return "Model copied to '/models/trainedmodel/'" +def compact_lastfinetuned_model(): + this_dir = Path(__file__).parent.resolve() + + best_model_path_str = find_latest_best_model(this_dir / "finetune" / "tmp-trn" / "training") + + # Check if the best model file exists + if best_model_path_str is None: + print("[FINETUNE] No trained model was found.") + return "No trained model was found." + + # Convert model_path_str to Path + best_model_path = Path(best_model_path_str) + + # Attempt to load the model + try: + checkpoint = torch.load(best_model_path, map_location=torch.device("cpu")) + except Exception as e: + print("[FINETUNE] Error loading checkpoint:", e) + raise + + del checkpoint["optimizer"] + + for key in list(checkpoint["model"].keys()): + if "dvae" in key: + del checkpoint["model"][key] + + # Define the target directory + target_dir = this_dir / "models" / "lastfinetuned" + + # Create the target directory if it doesn't exist + target_dir.mkdir(parents=True, exist_ok=True) + + # Save the modified checkpoint in the target directory + torch.save(checkpoint, target_dir / "model.pth") + + # Specify the files you want to copy + files_to_copy = ["vocab.json", "config.json", "dvae.pth", "mel_stats.pth"] + + for file_name in files_to_copy: + src_path = this_dir / base_path / base_model_path / file_name + dest_path = target_dir / file_name + shutil.copy(str(src_path), str(dest_path)) + + source_wavs_dir = this_dir / "finetune" / "tmp-trn" / "wavs" + target_wavs_dir = target_dir / "wavs" + target_wavs_dir.mkdir(parents=True, exist_ok=True) + + # Iterate through files in the source directory + for file_path in source_wavs_dir.iterdir(): + # Check if it's a file and larger than 1000 KB + if file_path.is_file() and file_path.stat().st_size > 1000 * 1024: + # Copy the file to the target directory + shutil.copy(str(file_path), str(target_wavs_dir / file_path.name)) + + print("[FINETUNE] Model copied to '/models/lastfinetuned/'") + return "Model copied to '/models/lastfinetuned/'" + + +def compact_legacy_model(): + this_dir = Path(__file__).parent.resolve() + + best_model_path_str = os.path.join(this_dir, "finetune", "best_model.pth") + + # Check if the best model file exists + if not os.path.exists(best_model_path_str): + print("[FINETUNE] No model called best_model.pth was found in /finetune/") + return "No model called best_model.pth was found in /finetune/" + + # Convert model_path_str to Path + best_model_path = Path(best_model_path_str) + + # Attempt to load the model + try: + checkpoint = torch.load(best_model_path, map_location=torch.device("cpu")) + except Exception as e: + print("[FINETUNE] Error loading checkpoint:", e) + raise + + del checkpoint["optimizer"] + + for key in list(checkpoint["model"].keys()): + if "dvae" in key: + del checkpoint["model"][key] + + # Define the target directory + target_dir = this_dir / "finetune" + + # Create the target directory if it doesn't exist + target_dir.mkdir(parents=True, exist_ok=True) + + # Save the modified checkpoint in the target directory + torch.save(checkpoint, target_dir / "model.pth") + + print("[FINETUNE] model.pth created in '/finetune/'") + return "model.pth created in '/finetune/'" + + def delete_training_data(): # Define the folder to be deleted folder_to_delete = Path(this_dir / "finetune" / "tmp-trn") # Check if the folder exists before deleting if folder_to_delete.exists(): - # Delete the folder and its contents - shutil.rmtree(folder_to_delete) - print(f"[FINETUNE] Folder {folder_to_delete} and its contents deleted successfully.") - return "Folder '/finetune/tmp-trn/' and its contents deleted successfully." + # Iterate over all files and subdirectories + for item in folder_to_delete.iterdir(): + # Exclude trainer_0_log.txt from deletion + if item.name != "trainer_0_log.txt": + try: + if item.is_file(): + item.unlink() + elif item.is_dir(): + shutil.rmtree(item) + except PermissionError: + print(f"[FINETUNE] PermissionError: Could not delete {item}. Skipping.") + + print(f"[FINETUNE] Folder {folder_to_delete} contents (excluding trainer_0_log.txt) deleted successfully.") + return "Folder '/finetune/tmp-trn/' contents (excluding trainer_0_log.txt) deleted successfully." else: print(f"[FINETUNE] Folder {folder_to_delete} does not exist.") return "Folder '/finetune/tmp-trn/' does not exist." + def delete_voice_sample_contents(): # Define the folder to be cleared folder_to_clear = Path(this_dir / "finetune" / "put-voice-samples-in-here") @@ -729,20 +875,20 @@ if __name__ == "__main__": f""" ## Finetuning Information
### 🟥 Important Note - ####      🟥 finetune.py needs to be run from the /alltalk_tts/ folder. Don't move the location of this script. - ####      🟥 Have you run AllTalk at least once? It needs to have downloaded+updated the voice model, before we can finetune it. + ####      - finetune.py needs to be run from the /alltalk_tts/ folder. Don't move the location of this script. + ####      - Have you run AllTalk at least once? It needs to have downloaded+updated the voice model, before we can finetune it. ### 🟦 What you need to run finetuning - ####      🟦 An Nvidia GPU. Tested on Windows with extended shared VRAM and training used about 16GB's total (which worked on a 12GB card). - ####      🟦 I have not been able to test this on a GPU with less than 12GB of VRAM, so cannot say if it will work or how that would affect performance. - ####      🟦 Version 11.8 of Nvidia cuBLAS and cuDNN (guide below). Only 11.8 of cuBLAS and cuDNN work for this process currently. - ####      🟦 Minimum 18GB free disk space (most of it is used temporarily). - ####      🟦 Some decent quality audio, multiple files if you like. Minimum of 2 minutes and Ive tested up to 20 minutes of audio. - ####      🟦 There is no major need to chop down your audio files into small slices as Step 1 will do that for you automatically and prepare the training set. Ive been testing with 5 minute long clips. - ####      🟦 This process will need access to all your GPU and VRAM, so close any other software that's using your GPU currently. + ####      - An Nvidia GPU. Tested on Windows with extended shared VRAM and training used about 16GB's total (which worked on a 12GB card). + ####      - I have not been able to test this on a GPU with less than 12GB of VRAM, so cannot say if it will work or how that would affect performance. + ####      - Version 11.8 of Nvidia cuBLAS and cuDNN (guide below). Only 11.8 of cuBLAS and cuDNN work for this process currently. + ####      - Minimum 18GB free disk space (most of it is used temporarily). + ####      - Some decent quality audio, multiple files if you like. Minimum of 2 minutes and Ive tested up to 20 minutes of audio. + ####      - There is no major need to chop down your audio files into small slices as Step 1 will do that for you automatically and prepare the training set. Ive been testing with 5 minute long clips. + ####      - This process will need access to all your GPU and VRAM, so close any other software that's using your GPU currently. ### 🟨 Setting up cuBLAS and cuDNN Version 11.8 - ####      🟨 If you have the Nvidia CUDA Toolkit Version 11.8 installed and can type nvcc --version at the command prompt/terminal and it reports Cuda compilation tools, release 11.8 you should be good to go. - ####      🟨 If you dont have the toolkit installed, the idea is just to install the smallest bit possible and this will not affect or impact other things on your system. - ####      🟨 You will need to download the Nvidia Cuda Toolkit 11.8 network install from [here](https://developer.nvidia.com/cuda-11-8-0-download-archive) + ####      - If you have the Nvidia CUDA Toolkit Version 11.8 installed and can type nvcc --version at the command prompt/terminal and it reports Cuda compilation tools, release 11.8 you should be good to go. + ####      - If you dont have the toolkit installed, the idea is just to install the smallest bit possible and this will not affect or impact other things on your system. + ####      - You will need to download the Nvidia Cuda Toolkit 11.8 network install from [here](https://developer.nvidia.com/cuda-11-8-0-download-archive) ####          1) Run the installer and select Custom Advanced Uncheck everything at the top then expand CUDA, Development > Compiler > and select nvcc then expand Libraries and select CUBLAS. ####          2) Back at the top of CUDA, expand Runtime > Libraries and select CUBLAS. Click Next, accept the default path (taking a note of its location) and let the install run. ####          3) You should be able to drop to your terminal or command prompt and type nvcc --version and have it report Cuda compilation tools, release 11.8. If it does you are good to go. If it doesn't > Step 4. @@ -766,16 +912,16 @@ if __name__ == "__main__": f""" ## STEP 1 - Preparing Audio/Generating the dataset
### 🟦 What you need to do - ####      🟦 Please read Coqui's guide on what makes a good dataset [here](https://docs.coqui.ai/en/latest/what_makes_a_good_dataset.html#what-makes-a-good-dataset) - ####      🟦 Place your audio files in {str(audio_folder)} - ####      🟦 Your audio samples can be in the format mp3, wav, or flac. - ####      🟦 You will need a minimum of 2 minutes of audio in either one or multiple audio files. - ####      🟦 When you have completed Steps 1, 2, and 3, you are welcome to delete your samples from "put-voice-samples-in-here".
+ ####      - Please read Coqui's guide on what makes a good dataset [here](https://docs.coqui.ai/en/latest/what_makes_a_good_dataset.html#what-makes-a-good-dataset) + ####      - Place your audio files in {str(audio_folder)} + ####      - Your audio samples can be in the format mp3, wav, or flac. + ####      - You will need a minimum of 2 minutes of audio in either one or multiple audio files. Very small sample files cause errors, so I would suggest 30 seconds and longer samples. + ####      - When you have completed Steps 1, 2, and 3, you are welcome to delete your samples from "put-voice-samples-in-here".
### 🟨 What this step is doing - ####      🟨 With step one, we are going to be stripping your audio file(s) into smaller files, using Whisper to find spoken words/sentences, compile that into excel sheets of training data, ready for finetuning the model on Step 2. - ####      🟨 Whilst you can choose multiple Whisper models, its best only to use the 1 model as each one is about 3GB in size and will download to your local huggingface cache on first-time use. If and when you have completed training, you wish to delete this 3GB model from your system, you are welcome to do so. + ####      - With step one, we are going to be stripping your audio file(s) into smaller files, using Whisper to find spoken words/sentences, compile that into excel sheets of training data, ready for finetuning the model on Step 2. + ####      - Whilst you can choose multiple Whisper models, its best only to use the 1 model as each one is about 3GB in size and will download to your local huggingface cache on first-time use. If and when you have completed training, you wish to delete this 3GB model from your system, you are welcome to do so. ### 🟩 How long will this take? - ####      🟩 First time, it needs to download the Whisper model which is 3GB. After that a few minutes on an average 3-4 year old system. + ####      - First time, it needs to download the Whisper model which is 3GB. After that a few minutes on an average 3-4 year old system. """ ) @@ -784,41 +930,41 @@ if __name__ == "__main__": value=out_path, visible=False, ) + with gr.Row(): + whisper_model = gr.Dropdown( + label="Whisper Model", + value="large-v3", + choices=[ + "large-v3", + "large-v2", + "large", + "medium", + "small" + ], + ) - whisper_model = gr.Dropdown( - label="Whisper Model", - value="large-v3", - choices=[ - "large-v3", - "large-v2", - "large", - "medium", - "small" - ], - ) - - lang = gr.Dropdown( - label="Dataset Language", - value="en", - choices=[ - "en", - "es", - "fr", - "de", - "it", - "pt", - "pl", - "tr", - "ru", - "nl", - "cs", - "ar", - "zh", - "hu", - "ko", - "ja" - ], - ) + lang = gr.Dropdown( + label="Dataset Language", + value="en", + choices=[ + "en", + "es", + "fr", + "de", + "it", + "pt", + "pl", + "tr", + "ru", + "nl", + "cs", + "ar", + "zh", + "hu", + "ko", + "ja" + ], + ) progress_data = gr.Label( label="Progress:" ) @@ -863,51 +1009,67 @@ if __name__ == "__main__": f""" ## STEP 2 - Fine-tuning the XTTS Encoder
### 🟦 What you need to do - ####      🟦 The Train CSV and Eval CSV should already be populated. If not, just go back to Step 1 and click the button again. - ####      🟦 If for any reason it crashed, close the app and re-start the finetuning and kick it off again, clicking through setp 1 (it doesnt need to regenerate the data) - ####      🟦 The settings below are factory and should be ok.
+ ####      - The Train CSV and Eval CSV should already be populated. If not, just go back to Step 1 and click the button again. + ####      - If for any reason it crashed, close the app and re-start the finetuning and kick it off again, clicking through setp 1 (it doesnt need to regenerate the data) + ####      - The settings below are factory and should be ok.
### 🟨 What this step is doing - ####      🟨 Very simply put, it's taking all our wav files generated in Step 1, along with our recorded speech in out excel documents and its training the model on that voice. + ####      - Very simply put, it's taking all our wav files generated in Step 1, along with our recorded speech in out excel documents and its training the model on that voice. ### 🟩 How long will this take? - ####      🟩 On a RTX 4070 with factory settings (as below) and 20 minutes of audio, this took 20 minutes. Again, it will vary by system and how much audio you are throwing at it. You have time to go make a coffee. - ####      🟩 Look at your command prompt/terminal window if you want to see what it is doing. + ####      - On a RTX 4070 with factory settings (as below) and 20 minutes of audio, this took 20 minutes. Again, it will vary by system and how much audio you are throwing at it. You have time to go make a coffee. + ####      - Look at your command prompt/terminal window if you want to see what it is doing. """ ) + with gr.Row(): + train_csv = gr.Textbox( + label="Train CSV:", + ) + eval_csv = gr.Textbox( + label="Eval CSV:", + ) + with gr.Row(): + num_epochs = gr.Slider( + label="Number of epochs:", + minimum=1, + maximum=100, + step=1, + value=args.num_epochs, + ) + batch_size = gr.Slider( + label="Batch size:", + minimum=2, + maximum=512, + step=1, + value=args.batch_size, + ) + grad_acumm = gr.Slider( + label="Grad accumulation steps:", + minimum=2, + maximum=128, + step=1, + value=args.grad_acumm, + ) + max_audio_length = gr.Slider( + label="Max permitted audio size in seconds:", + minimum=2, + maximum=20, + step=1, + value=args.max_audio_length, + ) + with gr.Row(): + model_to_train_choices = ["Base Model"] + if finetuned_model: + model_to_train_choices.append("Existing finetuned model") + model_to_train = gr.Radio( + choices=model_to_train_choices, + label="Which model do you want to train?", + value="Base Model" + ) + gr.Markdown( + f""" + ##### If you have an existing finetuned model in /models/trainedmodel/ you will have an option to select Existing finetuned model, allowing you to further train it. Otherwise, you will only have Base Model as an option. + """ + ) - train_csv = gr.Textbox( - label="Train CSV:", - ) - eval_csv = gr.Textbox( - label="Eval CSV:", - ) - num_epochs = gr.Slider( - label="Number of epochs:", - minimum=1, - maximum=100, - step=1, - value=args.num_epochs, - ) - batch_size = gr.Slider( - label="Batch size:", - minimum=2, - maximum=512, - step=1, - value=args.batch_size, - ) - grad_acumm = gr.Slider( - label="Grad accumulation steps:", - minimum=2, - maximum=128, - step=1, - value=args.grad_acumm, - ) - max_audio_length = gr.Slider( - label="Max permitted audio size in seconds:", - minimum=2, - maximum=20, - step=1, - value=args.max_audio_length, - ) progress_train = gr.Label( label="Progress:" ) @@ -949,16 +1111,16 @@ if __name__ == "__main__": f""" ## STEP 3 - Inference/Testing
### 🟥 Important Note - ####      🟥 This step will error if you are using TTS version 0.22.0. Please re-run pip install -r requirements_finetune.txt if it errors loading the model. - ####      🟥 If you dont see multiple speaker reference files and you used more than 3 minutes of speech, try refreshing the page as it may not have loaded them correctly. + ####      - This step will error if you are using TTS version 0.22.0. Please re-run pip install -r requirements_finetune.txt if it errors loading the model. + ####      - If you dont see multiple speaker reference files and you used more than 3 minutes of speech, try refreshing the page as it may not have loaded them correctly. ### 🟦 What you need to do - ####      🟦 The model is now trained and you are at the testing stage. Hopefully all the dropdowns should be pre-populated now. - ####      🟦 You need to Load Fine-tuned XTTS model and then select your Speaker Reference Audio. You can choose various Speaker Reference Audios to see which works best. - ####      🟦 All the Speaker Reference Audios in the dropdown are ones that are 8 seconds long or more. You can use one of these later for your voice sample in All Talk, so remember the one you like. - ####      🟦 Some Speaker Reference Audios are a bit long and may cause issues generating the TTS, so try different ones. - ####      🟦 Once you are happy, move to the next tab for instruction on cleaning out the training data and how to copy your newly trained model over your current model. + ####      - The model is now trained and you are at the testing stage. Hopefully all the dropdowns should be pre-populated now. + ####      - You need to Load Fine-tuned XTTS model and then select your Speaker Reference Audio. You can choose various Speaker Reference Audios to see which works best. + ####      - All the Speaker Reference Audios in the dropdown are ones that are 8 seconds long or more. You can use one of these later for your voice sample in All Talk, so remember the one you like. + ####      - Some Speaker Reference Audios are a bit long and may cause issues generating the TTS, so try different ones. + ####      - Once you are happy, move to the next tab for instruction on cleaning out the training data and how to copy your newly trained model over your current model. ### 🟨 What this step is doing - ####      🟨 Its loading the finetuned model into memory, loading a voice sample and generating TTS, so that you can test out how well fine tuning worked. + ####      - Its loading the finetuned model into memory, loading a voice sample and generating TTS, so that you can test out how well fine tuning worked. """ ) @@ -1051,25 +1213,57 @@ if __name__ == "__main__": f""" ## What to do next
### 🟦 What you need to do - ####      🟦 There are 3x buttons below: - ####          🔹 Compact & move model. This will compress the trained model and move it, along with any large enough wav files created to /models/trainedmodel/. You can use the wav files as sample voices.. + ####      - You have a few options below: + ####          🔹 Compact & move model. This will compress the raw finetuned model and move it, along with any large enough wav files created to one of two locations (please read text next to the button).
                 You can use the wav files in that location as sample voices with your model. Models moved to /models/trainedmodel/ will be loadable within Text-gen-webui on the XTTSv2 FT loader. ####          🔹 Delete Generated Training data. This will delete the finetuned model and any other training data generated during this process. You will more than likely want to do this after you have Compacted & moved the model. ####          🔹 Delete original voice samples. This will delete the voice samples you placed in put-voice-samples-in-here (if you no longer have a use for them). - ####      🟦 I will at some point add an option within AllTalk to load a finetuned model as a seperate model. However, for now, you will have to copy it over the model in the /models/xttsv2_2.0.2/ model, if you wish to use it. - ####      🟦 If you wish to further train this model, you will also need to copy it over the model in the /models/xttsv2_2.0.2/ model folder.. + ####          🔹 Compress a legacy finetuned model. For any models that were generated pre the current version of finetuning, you can still compact them down. + ####      - Instructions on using the finetuned model in Text-generation-webui and also further tuning this model you just created are on OPTION A - Compact and move model to '/trainedmodel/'. ### 🟨 Clearing up disk space - ####      🟨 If you are not going to train anything again, you can delete the whisper model from inside of your huggingface cache (3GB approx) + ####      - If you are not going to train anything again, you can delete the whisper model from inside of your huggingface cache (3GB approx) ####          Linux ~/.cache/huggingface/hub/(folder-here) ####          Windows C:\users(your-username)\.cache\huggingface\hub\(folder-here). - ####      🟨 You can also uninstall the Nvidia CUDA 11.8 Toolkit if you wish and remove your environment variable entries. + ####      - You can also uninstall the Nvidia CUDA 11.8 Toolkit if you wish and remove your environment variable entries. """ ) final_progress_data = gr.Label( label="Progress:" ) - compact_btn = gr.Button(value="Compact and move model to '/models/trainedmodel/' (THIS WILL OVER-WRITE ANY MODEL IN THAT LOCATION)") - delete_training_btn = gr.Button(value="Delete generated training data") - delete_voicesamples_btn = gr.Button(value="Delete original voice samples") + with gr.Row(): + compact_btn = gr.Button(value="OPTION A - Compact and move model to '/trainedmodel/'") + gr.Markdown( + f""" + ##### This will compact the model and move it, along with the reference wav's to /models/trainedmodel/ and will OVERWRITE any model in that location. This model will become available to load in Text-gen-webui with the XTTSv2 FT loader. It will also be detected by Finetune as a model that can be further trained (Reload finetune.py). + """ + ) + with gr.Row(): + compact_lastfinetuned_btn = gr.Button(value="OPTION B - Compact and move model to '/lastfinetuned/'") + gr.Markdown( + f""" + ##### This will compact the model and move it, along with the reference wav's to /models/lastfinetuned/ and will OVERWRITE any model in that location. This will just leave you a finetuned model that you can do with as you please. It will NOT be available in Text-gen-webui unless you copy it over one of the other model loader locations. + """ + ) + with gr.Row(): + delete_training_btn = gr.Button(value="Delete generated training data") + gr.Markdown( + f""" + ##### This will DELETE your training data and the raw finetuned model from /finetune/tmp-trn/. + """ + ) + with gr.Row(): + delete_voicesamples_btn = gr.Button(value="Delete original voice samples") + gr.Markdown( + f""" + ##### This will DELETE your original voice samples from /finetune/put-voice-samples-in-here/. + """ + ) + with gr.Row(): + compact_legacy_btn = gr.Button(value="Compact a legacy finetuned model") + gr.Markdown( + f""" + ##### This will compact your old finetuned models from 5GB to 1.9GB. Place your 5GB base_model.pth file in /finetune/ (rename your file to base_model.pth if necessary). This will generate you a model.pth file. + """ + ) prompt_compute_btn.click( fn=preprocess_dataset, @@ -1125,6 +1319,10 @@ if __name__ == "__main__": fn=compact_model, outputs=[final_progress_data], ) + compact_lastfinetuned_btn.click( + fn=compact_lastfinetuned_model, + outputs=[final_progress_data], + ) delete_training_btn.click( fn=delete_training_data, outputs=[final_progress_data], @@ -1133,6 +1331,11 @@ if __name__ == "__main__": fn=delete_voice_sample_contents, outputs=[final_progress_data], ) + compact_legacy_btn.click( + fn=compact_legacy_model, + outputs=[final_progress_data], + ) + model_to_train.change(basemodel_or_finetunedmodel_choice, model_to_train, None) demo.queue().launch( show_api=False,