diff --git a/README.md b/README.md index d6bab88..9f42aeb 100644 --- a/README.md +++ b/README.md @@ -34,13 +34,14 @@ pip install torch==1.6.0+cu101 torchvision==0.7.0+cu101 -f https://download.pyto FFmpeg must be installed and configured in order for the application to be able to process any track that isn't a *.wav* file. Instructions for installing FFmpeg can be found on YouTube, WikiHow, Reddit, GitHub, and many other sources around the web. -- **Note:** If you are experiencing any errors when attempting to process any media audio files that are not the *.wav* format, please ensure FFmpeg is installed & configured correctly. +- **Note:** If you are experiencing any errors when attempting to process any media files that are not in the *.wav* format, please ensure FFmpeg is installed & configured correctly. ### Running the Vocal Remover GUI & Models - Open the file labeled *'VocalRemover.py'*. - It's recommended that you create a shortcut for the file labeled *'VocalRemover.py'* to your desktop for easy access. - **Note:** If you are unable to open the *'VocalRemover.py'* file, please go to the [**troubleshooting**](https://github.com/Anjok07/ultimatevocalremovergui/tree/beta#troubleshooting) section below. + - All output audio files will be the *'.wav'* format. ## Option Guide @@ -77,14 +78,19 @@ The v2 & v4 AI engines use different sets of models. When selected, the models a - **Note:** This option is ***not*** compatible with the *v2* AI engine. - **Output Image** - Selecting this option will include the spectrograms in *.jpg* format for the instrumental & vocal audio outputs. - **Stack Passes** - This option activates the stacked model conversion process and allows the user to set the number of times a track runs through a stacked model. + - **Note:** Unless you have the *'Save All Stacked Outputs'* option selected, the following outputs will be saved - + - Instrumental generated after the last stack pass & + - The vocal track generated by the main model - **Note:** The best range is 3-7 passes. 8 or more passes can result in degraded sound quality for the track. - **Stack Conversion Only** - Selecting this option allows the user to bypass the main model and run a track through a stacked model only. -- **Save All Stacked Outputs** - Having this option selected will auto-generate a new directory with the track name to your *'Save to'* path. The new directory will contain all of the outputs generated by each stack pass. The amount of audio outputs will depend on the number of stack passes chosen. - - **Note:** Each output filename will be appended with the number of passes it has had. +- **Save All Stacked Outputs** - Having this option selected will auto-generate a new folder named after the track being processed to your *'Save to'* path. The new folder will contain all of the outputs that were generated after each stack pass. The amount of audio outputs will depend on the number of stack passes chosen. + - **Note:** Each output audio file will be appended with the number of passes it has had. - **Example:** If 5 stack passes are chosen, the application will provide you with all 5 pairs of audio outputs generated after each pass, if this option is enabled. - This option can be very useful in determining the optimal number of passes needed to clean a track. -- **Model Test Mode** - This option makes it easier for users to test the results of different models, and model combinations, by eliminating the hassel of having to manually create new folders and/or change the filenames when processing the same track through multiple models. This option structures the model testing process. - - When selected, the application will auto-generate a new folder in the *'Save to'* path you have chosen. + - The *'stacked vocal'* tracks will contain the audio of the vocal artifacts that were removed from the instrumental. + - These files can be used to verify artifact removal. +- **Model Test Mode** - This option makes it easier for users to test the results of different models, and model combinations, by eliminating the hassel of having to manually change the filenames and/or create new folders when processing the same track through multiple models. This option structures the model testing process. + - When *'Model Test Mode'* is selected, the application will auto-generate a new folder in the *'Save to'* path you have chosen. - The new auto-generated folder will be named after the model(s) selected. - The output audio files will be saved to the auto-generated directory. - The filenames for the instrumental & vocal outputs will have the selected model(s) name(s) appended to them.