docs/gui.md

## GUI for MSST code 

GUI was prepared by **Bas Curtiz** and is based on [wxpython](https://en.wikipedia.org/wiki/WxPython) module.

![Window example](https://github.com/ZFTurbo/Music-Source-Separation-Training/blob/main/gui/wx_msst_screen.png)

### How to

How to use GUI with ZFTurbo's Music Source Separation Universal Training Code:

1. Install Python: https://www.python.org/ftp/python/3.11.6/python-3.11.6-amd64.exe
2. Install Microsoft Visual C++ 2015-2022 (x64): https://aka.ms/vs/17/release/vc_redist.x64.exe
3. Install Microsoft C++ Build Tools: https://visualstudio.microsoft.com/visual-cpp-build-tools/
Select Desktop development with C++
4. Install PyTorch: https://pytorch.org/get-started/locally/
5. Download and unzip Music Source Separation Universal Training Code:
https://github.com/ZFTurbo/Music-Source-Separation-Training
6. Open up CMD inside the folder and enter: `pip install -r requirements.txt`
7. Enter: `python gui-wx.py`
8. Download models - assign the config (.yaml) and checkpoint (.bin, .ckpt, or .th)

Video guide on [Youtube](https://youtu.be/M8JKFeN7HfU) (~6.5 minutes).

[![Tutorial screenshot](https://github.com/ZFTurbo/Music-Source-Separation-Training/blob/main/gui/tutorial_screenshot.jpg)](https://youtu.be/M8JKFeN7HfU)

Also you can use GUI as EXE-file on Windows: [Link](https://mega.nz/file/xAAzTCzR#2IapG3RJ9Vew3oC8l9H2zrw1vwUtZSqsUdJAjmARmPs). Put it inside the root folder. This way you can make a shortcut to the exe on your desktop to run it with a double-click. 

### Other links

* You can try [non-official GUI to MSST](https://github.com/SUC-DriverOld/MSST-WebUI).
* The one more version [by SiftedSand](https://github.com/SiftedSand/MusicSepGUI)