Difference between revisions of "ESRGAN Installation Guide for Windows"

From Upscale Wiki
Jump to navigation Jump to search
m
m
Line 7: Line 7:
 
Our goal is to open up A.I. upscaling to everyone, not just to those who can pay lots of money or are good at coding.
 
Our goal is to open up A.I. upscaling to everyone, not just to those who can pay lots of money or are good at coding.
  
Before you start, make sure that your '''display driver is up-to-date''' if you have an '''Nvidia GPU''', to make sure it supports the newest CUDA version. If you want to be on the safe side, use the [https://developer.nvidia.com/cuda-downloads CUDA driver].
+
Before you start, make sure that your '''display driver is up-to-date''' if you have an '''Nvidia GPU''', to make sure it supports the newest CUDA version; if you want to be on the safe side, use the latest [https://developer.nvidia.com/cuda-downloads CUDA driver].
  
 
== Installing ESRGAN ==
 
== Installing ESRGAN ==
  
 
# Get the latest stable 64-bit Python 3 release here: [https://www.python.org/downloads/windows/ Python Download]  
 
# Get the latest stable 64-bit Python 3 release here: [https://www.python.org/downloads/windows/ Python Download]  
#: [[File:GuideEsrganWin_1-python-link.jpg|center|A snapshot of the "Python Releases for Windows" section of the above linked webpage as of August 12, 2019. The "Download Windows x86-64 executable installer" link is highlighted.]]
+
#: [[File:GuideEsrganWin_1-python-link.jpg|frameless|A snapshot of the "Python Releases for Windows" section of the above linked webpage as of August 12, 2019. The "Download Windows x86-64 executable installer" link is highlighted.]]
 
# Run the installer and make sure that <code>Add Python 3.*x* to Path</code> and <code>Install launcher for all users (recommended)</code> is selected, then click on Customize installation.  
 
# Run the installer and make sure that <code>Add Python 3.*x* to Path</code> and <code>Install launcher for all users (recommended)</code> is selected, then click on Customize installation.  
#: [[File:GuideEsrganWin_2-installer-1.jpg|center|The "Install Python" screen from the python installer. All checkboxes are checked. The checkboxes and the "Customize installation" button are highlighted.]]
+
#: [[File:GuideEsrganWin_2-installer-1.jpg|frameless|The "Install Python" screen from the python installer. All checkboxes are checked. The checkboxes and the "Customize installation" button are highlighted.]]
 
# Make sure that every Option is selected and click on next.  
 
# Make sure that every Option is selected and click on next.  
#: [[File:GuideEsrganWin_3-installer-2.jpg|center|The Optional Features screen from the Python installer. All options are checked. The checked boxes are highlighted.]]
+
#: [[File:GuideEsrganWin_3-installer-2.jpg|frameless|The Optional Features screen from the Python installer. All options are checked. The checked boxes are highlighted.]]
 
# Mirror my selections and click on install (Make sure that the install location contains no spaces).  
 
# Mirror my selections and click on install (Make sure that the install location contains no spaces).  
#: [[File:GuideEsrganWin_4-installer-3.jpg|center|The Advanced Options screen from the Python installer. All options are checked except "Download debug binaries". Install location is set as "C:\Python37". The checked boxes and the install location are highlighted.]]
+
#: [[File:GuideEsrganWin_4-installer-3.jpg|frameless|The Advanced Options screen from the Python installer. All options are checked except "Download debug binaries". Install location is set as "C:\Python37". The checked boxes and the install location are highlighted.]]
 
# You have now successfully installed Python 3. Click on Close now.
 
# You have now successfully installed Python 3. Click on Close now.
 
# Press <Windows/Super key> + R. Enter <code>cmd</code> and click on <code>OK</code>  
 
# Press <Windows/Super key> + R. Enter <code>cmd</code> and click on <code>OK</code>  
#: [[File:GuideEsrganWin_6-run.jpg|center|A picture of the Windows Run prompt open with "cmd" in the "Open:" field. "cmd" and the OK button are highlighted.]]
+
#: [[File:GuideEsrganWin_6-run.jpg|frameless|A picture of the Windows Run prompt open with "cmd" in the "Open:" field. "cmd" and the OK button are highlighted.]]
 
# We will now install Pytorch:
 
# We will now install Pytorch:
 
## If you have a '''Nvidia''' graphic card enter the following command in the cmd:  
 
## If you have a '''Nvidia''' graphic card enter the following command in the cmd:  
Line 27: Line 27:
 
##: then:
 
##: then:
 
##: <code>bash  pip install https://download.pytorch.org/whl/cu100/torchvision-0.3.0-cp37-cp37m-win_amd64.whl</code>  
 
##: <code>bash  pip install https://download.pytorch.org/whl/cu100/torchvision-0.3.0-cp37-cp37m-win_amd64.whl</code>  
##: [[File:GuideEsrganWin_7-Nvidia.jpg|center|A Windows command prompt open with the first of the two above commands entered but not executed.]]
+
##: [[File:GuideEsrganWin_7-Nvidia.jpg|frameless|A Windows command prompt open with the first of the two above commands entered but not executed.]]
 
## If you have an '''AMD / Intel''' graphic card enter the following command in the cmd:
 
## If you have an '''AMD / Intel''' graphic card enter the following command in the cmd:
 
##: <code>pip install https://download.pytorch.org/whl/cpu/torch-1.1.0-cp37-cp37m-win_amd64.whl</code>
 
##: <code>pip install https://download.pytorch.org/whl/cpu/torch-1.1.0-cp37-cp37m-win_amd64.whl</code>
 
##: then:  
 
##: then:  
 
##: <code>bash  pip install https://download.pytorch.org/whl/cpu/torchvision-0.3.0-cp37-cp37m-win_amd64.whl</code>  
 
##: <code>bash  pip install https://download.pytorch.org/whl/cpu/torchvision-0.3.0-cp37-cp37m-win_amd64.whl</code>  
##: [[File:GuideEsrganWin_7-CPU.jpg|center|A Windows command prompt open with the first of the two above commands entered but not executed.]]
+
##: [[File:GuideEsrganWin_7-CPU.jpg|frameless|A Windows command prompt open with the first of the two above commands entered but not executed.]]
## If the command won’t work for you, please report it. In the meantime, you can get an up to date version here at the [https://pytorch.org/get-started/locally/ Pytorch Website]. Select Stable, Windows, Pip, your Python version and your CUDAversion (should be the newest) or None for AMD / Intel users.
+
## If the command won’t work for you, please report it. In the meantime, you can get an up to date version here at the [https://pytorch.org/get-started/locally/ Pytorch Website]. Select Stable, Windows, Pip, your Python version and your CUDA version (should be the newest) or None for AMD / Intel users.
 
# Press Enter.
 
# Press Enter.
 
# Now we install the other requirements for running and training ESRGAN and SFTGAN. Enter:
 
# Now we install the other requirements for running and training ESRGAN and SFTGAN. Enter:
 
#: <code>pip install opencv-python</code>
 
#: <code>pip install opencv-python</code>
#: [[File:GuideEsrganWin_8-pip.jpg|center|A Windows command prompt open with the above command entered but not executed.]]
+
#: [[File:GuideEsrganWin_8-pip.jpg|frameless|A Windows command prompt open with the above command entered but not executed.]]
 
# Choose a folder where you want to install ESRGAN. Because of the maximum path length limitation in windows, I recommend something as short as possible like: <code>C:\ctp\esrgan\</code></p>
 
# Choose a folder where you want to install ESRGAN. Because of the maximum path length limitation in windows, I recommend something as short as possible like: <code>C:\ctp\esrgan\</code></p>
 
## Create a folder called <code>ctp</code> (That will come in handy if you want to install Deorders scripts later)
 
## Create a folder called <code>ctp</code> (That will come in handy if you want to install Deorders scripts later)
Line 46: Line 46:
 
## Click on <code>Clone or Download</code>
 
## Click on <code>Clone or Download</code>
 
## Click on <code>Download ZIP</code>  
 
## Click on <code>Download ZIP</code>  
##: [[File:GuideEsrganWin_10-github.jpg|center|An image of the ESRGAN repo on Github, with the "Clone or download" dropdown button highlighted as well as the "Download ZIP" link]]
+
##: [[File:GuideEsrganWin_10-github.jpg|frameless|An image of the ESRGAN repo on Github, with the "Clone or download" dropdown button highlighted as well as the "Download ZIP" link]]
 
# Extract the contents of the folder into your <code>C:\ctp\esrgan</code> folder you created in step 10. It should already be open and look like the image below:  
 
# Extract the contents of the folder into your <code>C:\ctp\esrgan</code> folder you created in step 10. It should already be open and look like the image below:  
#: [[File:GuideEsrganWin_11-explorer.jpg|center|An image of C:/ctp/esrgan/ open in Windows Explorer with the address bar underlined]]
+
#: [[File:GuideEsrganWin_11-explorer.jpg|frameless|An image of C:/ctp/esrgan/ open in Windows Explorer with the address bar underlined]]
 
# Now it is time to download and install the default ESRGAN models:
 
# Now it is time to download and install the default ESRGAN models:
 
## Go to the [https://drive.google.com/drive/folders/17VYV_SoZZesU6mbxz2dMAIccSSlqLecY ESRGAN Pretrained Models Google Drive]
 
## Go to the [https://drive.google.com/drive/folders/17VYV_SoZZesU6mbxz2dMAIccSSlqLecY ESRGAN Pretrained Models Google Drive]

Revision as of 03:27, 13 August 2019

This guide will help you to install ESRGAN on Windows, by showing you step by step with images how to do it.

No knowledge of Python or coding is necessary to follow this guide.

If you have any problems during or after the installation, feel free to ask any questions on our Discord server and we will try to help you out.

Our goal is to open up A.I. upscaling to everyone, not just to those who can pay lots of money or are good at coding.

Before you start, make sure that your display driver is up-to-date if you have an Nvidia GPU, to make sure it supports the newest CUDA version; if you want to be on the safe side, use the latest CUDA driver.

Installing ESRGAN

  1. Get the latest stable 64-bit Python 3 release here: Python Download
    A snapshot of the "Python Releases for Windows" section of the above linked webpage as of August 12, 2019. The "Download Windows x86-64 executable installer" link is highlighted.
  2. Run the installer and make sure that Add Python 3.*x* to Path and Install launcher for all users (recommended) is selected, then click on Customize installation.
    The "Install Python" screen from the python installer. All checkboxes are checked. The checkboxes and the "Customize installation" button are highlighted.
  3. Make sure that every Option is selected and click on next.
    The Optional Features screen from the Python installer. All options are checked. The checked boxes are highlighted.
  4. Mirror my selections and click on install (Make sure that the install location contains no spaces).
    The Advanced Options screen from the Python installer. All options are checked except "Download debug binaries". Install location is set as "C:\Python37". The checked boxes and the install location are highlighted.
  5. You have now successfully installed Python 3. Click on Close now.
  6. Press <Windows/Super key> + R. Enter cmd and click on OK
    A picture of the Windows Run prompt open with "cmd" in the "Open:" field. "cmd" and the OK button are highlighted.
  7. We will now install Pytorch:
    1. If you have a Nvidia graphic card enter the following command in the cmd:
      pip install https://download.pytorch.org/whl/cu100/torch-1.1.0-cp37-cp37m-win_amd64.whl
      then:
      bash pip install https://download.pytorch.org/whl/cu100/torchvision-0.3.0-cp37-cp37m-win_amd64.whl
      A Windows command prompt open with the first of the two above commands entered but not executed.
    2. If you have an AMD / Intel graphic card enter the following command in the cmd:
      pip install https://download.pytorch.org/whl/cpu/torch-1.1.0-cp37-cp37m-win_amd64.whl
      then:
      bash pip install https://download.pytorch.org/whl/cpu/torchvision-0.3.0-cp37-cp37m-win_amd64.whl
      A Windows command prompt open with the first of the two above commands entered but not executed.
    3. If the command won’t work for you, please report it. In the meantime, you can get an up to date version here at the Pytorch Website. Select Stable, Windows, Pip, your Python version and your CUDA version (should be the newest) or None for AMD / Intel users.
  8. Press Enter.
  9. Now we install the other requirements for running and training ESRGAN and SFTGAN. Enter:
    pip install opencv-python
    A Windows command prompt open with the above command entered but not executed.
  10. Choose a folder where you want to install ESRGAN. Because of the maximum path length limitation in windows, I recommend something as short as possible like: C:\ctp\esrgan\

    1. Create a folder called ctp (That will come in handy if you want to install Deorders scripts later)
    2. In the ctp folder create a folder called esrgan
    3. Open the esrgan folder.
  11. Now it is time to download ESRGAN:
    1. Go to the ESRGAN GitHub Repo (old model structure)
    2. Click on Clone or Download
    3. Click on Download ZIP
      An image of the ESRGAN repo on Github, with the "Clone or download" dropdown button highlighted as well as the "Download ZIP" link
  12. Extract the contents of the folder into your C:\ctp\esrgan folder you created in step 10. It should already be open and look like the image below:
    An image of C:/ctp/esrgan/ open in Windows Explorer with the address bar underlined
  13. Now it is time to download and install the default ESRGAN models:
    1. Go to the ESRGAN Pretrained Models Google Drive
    2. Download the two _old_arch.pth files.
    3. Put the two .pth files that you have just downloaded into your models folder in your esrgan folder
      1. For example in:
        C:\ctp\esrgan\models\
  14. If you have a Nvidia Graphic Card, then you have successfully installed ESRGAN, congratulations!
  15. However, if you have an AMD / Intel Graphic Card, then you need to open test.py in your ESRGAN folder with a text editor.
    1. Change:
      device = torch.device('cuda') # if you want to run on CPU, change 'cuda' -> cpu
      into:
      device = torch.device('cpu') # if you want to run on CPU, change 'cuda' -> cpu