Joey's ESRGAN Tutorial

From Upscale Wiki
This is the latest revision of this page; it has no approved revision.
Jump to navigation Jump to search

How to use it

  1. Put the pictures or textures you want to upscale into the input folder
  2. Open a terminal window and navigate to the esrgan folder (the folder you cloned the fork into in the install guide)
    • For Windows Shift right click in your esrgan folder and select Git Bash Here.
    • For Linux / MacOS users the process is similar. File managers like Nautilus for example allow you to open a terminal in a folder. If that isn't an option for you can can also navigate using commands. cd allows you to navigate and pwd shows you the current folder. cd .. goes one directory down (for example from /home/combi/code/git/ctp to /home/combi/code/git). Use cd /path/to/whatever to navigate to absolute (full) paths or cd some-folder-in-the-current-folder to navigate to a folder in the current open folder. (pwd = print working directory; cd = change directory) If you want to find out more about a command you can just type man the command-you-want-to-know-about or use the internet
  3. Enter:
    1. For Nvidia GPUs
      python upscale.py models/${theModelYouWantToUse}
    2. For other GPUs / integrated Graphic
      python upscale.py --cpu models/${theModelYouWantToUse}
  4. Don't enter ${theModelYouWantToUse} Instead replace that with the name of a model of course As an example, for the default model it would be: python test.py models/RRDB_ESRGAN_x4.pth
  5. That was it, the results will be in the results folder

Other useful Command line switches are:

  • --input ./input - Your Input folder
  • --seamless - For seamless textures (Textures that repeat without seams)
  • --output ./output - Your Output folder
  • --skip_existing - Skipps already upscaled images that are in your output and input folder
  • --tile_size 512 - The tile size, if you run out of VRAM, decrease that value
  • --binary_alpha - If the alpha / transparency channel should be only black or white
  • --alpha_threshold 0.5 Sets tha point at which alpha will be white instead of black if using binary alpha
  • --alpha_mode 1 Different implementation for how Alpha works, if you use binary alpha, it must be 1 otherwise you can try 2.