Difference between revisions of "ESRGAN Installation Guide for Windows"

From Upscale Wiki
Jump to navigation Jump to search
(Update Pytorch and Torchvision)
(10 intermediate revisions by 2 users not shown)
Line 3: Line 3:
 
| Please make sure that you have the latest driver version if you use a Nvidia GPU. Both the '''Studio''' and '''[https://developer.nvidia.com/cuda-downloads CUDA]''' drivers are recommended. The [https://developer.nvidia.com/cuda-downloads CUDA] driver on only gets updated when [https://developer.nvidia.com/cuda-downloads CUDA] itself gets updated, but will be compatible with the [https://developer.nvidia.com/cuda-downloads CUDA] version.
 
| Please make sure that you have the latest driver version if you use a Nvidia GPU. Both the '''Studio''' and '''[https://developer.nvidia.com/cuda-downloads CUDA]''' drivers are recommended. The [https://developer.nvidia.com/cuda-downloads CUDA] driver on only gets updated when [https://developer.nvidia.com/cuda-downloads CUDA] itself gets updated, but will be compatible with the [https://developer.nvidia.com/cuda-downloads CUDA] version.
 
|-
 
|-
| Also make sure that you have no existing Python installation(s) if you want to follow this guide (especially older Python versions)
+
| Also make sure that you have no existing older Python installation(s) if you want to follow this guide
 
|-
 
|-
| Only Python 3.7.x is currently supported. Also only the Python installation as instructed below is supported.
+
| Only Python 3.9.x is currently supported.
|-
 
| No knowledge of Python or coding is necessary to follow this guide.
 
 
|-
 
|-
 
| [https://discord.gg/cpAUpDK Support is here if you have problems.] Make sure that you followed the instructions to the letter.
 
| [https://discord.gg/cpAUpDK Support is here if you have problems.] Make sure that you followed the instructions to the letter.
Line 16: Line 14:
 
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.
  
== Installing ESRGAN ==
+
== Installing ESRGAN's Dependencies ==
  
 
=== Text / Picture Guide ===
 
=== Text / Picture Guide ===
  
==== Installing Python 3.7====
+
==== Installing Python 3.9====
  
# Get the latest stable 64-bit Python 3.7.x release here: [https://www.python.org/downloads/windows/ Python Download]. At the time of writing this is Python 3.7.7. '''Python 3.8 works for some people, others have reported failure, so we still recommend going with Python 3.7.x.'''
+
# Get the latest stable 64-bit Python 3.9.x release here: [https://www.python.org/downloads/windows/ Python Download]. At the time of writing this is Python 3.9.2.
 
#: [[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.]]
 
#: [[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.  
Line 30: Line 28:
 
# 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|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.]]
 
#: [[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.]]
 
==== Installing git (+ Bash) ====
 
 
# Get the latest stable 64-bit Git release here: [https://git-scm.com/download/win Git Download].
 
# Run the installer and select the options as you want, the defaults are fine. I recommend to check the Launch Git Bash Explorer Integration. Also set your default editor to whatever editor is used (Unless you use the git command to commit, this setting is irrelevant for you).
 
  
 
==== Installing Python Modules required by ESRGAN ====
 
==== Installing Python Modules required by ESRGAN ====
  
# Launch a Git Bash Shell as an administrator (right-click it in the start menu to get that option).
+
# Launch your favourite Terminal (CMD, PowerShell, Bash, …) as an administrator (right-click it in the start menu to get that option).
#* If you have a '''Nvidia''' graphic card copy the following command and paste it in Git Bash and press enter:  
+
#* If you have '''a Nvidia GPU'' copy the following command and paste it in Git Bash and press enter:  
#*: <code>pip install torch===1.5.1 torchvision===0.6.1 -f https://download.pytorch.org/whl/torch_stable.html</code>
+
#*: <code>pip install torch==1.8.1+cu111 torchvision==0.9.1+cu111 torchaudio===0.8.1 -f https://download.pytorch.org/whl/torch_stable.html</code>
#* If you have an '''AMD / Intel''' graphic card copy the following command and paste it in Git Bash and press enter:  
+
#* If you have '''no Nvidia GPU''' copy the following command and paste it in Git Bash and press enter:  
#*: <code>pip install torch==1.5.1+cpu torchvision==0.6.1+cpu -f https://download.pytorch.org/whl/torch_stable.html</code>  
+
#*: <code>pip install torch==1.8.1+cpu torchvision==0.9.1+cpu torchaudio===0.8.1 -f https://download.pytorch.org/whl/torch_stable.html</code>  
 
#* If the command won’t work for you, please report it. In the meantime, you can get an up to date version on 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.
 
#* If the command won’t work for you, please report it. In the meantime, you can get an up to date version on 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.
 
# Now we install the other requirements for running and training ESRGAN and SFTGAN. Paste and press enter:
 
# Now we install the other requirements for running and training ESRGAN and SFTGAN. Paste and press enter:
 
#: <code>pip install opencv-python</code>
 
#: <code>pip install opencv-python</code>
  
==== Cloning ESRGAN into a folder of your choice ====
+
==== Installing git (+ Bash) ====
  
# 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:\nn\esrgan\</code></p>
+
Not strictly required, but I reccomend it regardless.
## Create a folder called <code>nn</code> (Try to avoid spaces and always use short paths especially on Windows on other operating systems the path length at least is irrelevant)
+
 
## In the <code>nn</code> folder right click and select <code>Git Bash Here</code>.
+
# Get the latest stable 64-bit Git release here: [https://git-scm.com/download/win Git Download].
# Clone ESRGAN by pasting the following command
+
# Run the installer and select the options as you want, the defaults are fine. I recommend to check the Launch Git Bash Explorer Integration. Also set your default editor to whatever editor is used (Unless you use the git command to commit, this setting is irrelevant for you).
#: <code>git clone https://github.com/BlueAmulet/ESRGAN.git</code>
 
  
 
=== Video Guide ===
 
=== Video Guide ===
Line 60: Line 52:
 
[https://www.youtube.com/watch?v=w4Hb7tyDsWE You will find the video on YouTube here by clicking on this link].
 
[https://www.youtube.com/watch?v=w4Hb7tyDsWE You will find the video on YouTube here by clicking on this link].
  
==Usage==
+
==What now?==
How to actually [[Using ESRGAN, Links, And Other Information|use ESRGAN (IEU for example), other useful information and important links are here]].
+
We have a page dedicated to comparing the top options for ESRGAN programs / interfaces. It doesn't matter if you want a GUI that is easy to use or a Terminal interface for all your automation needs, just look here and chose what fits you best.
 +
[[Using ESRGAN, Links, And Other Information|ESRGAN Interface Comparison]].

Revision as of 21:17, 17 September 2021

Please make sure that you have the latest driver version if you use a Nvidia GPU. Both the Studio and CUDA drivers are recommended. The CUDA driver on only gets updated when CUDA itself gets updated, but will be compatible with the CUDA version.
Also make sure that you have no existing older Python installation(s) if you want to follow this guide
Only Python 3.9.x is currently supported.
Support is here if you have problems. Make sure that you followed the instructions to the letter.

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

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.

Installing ESRGAN's Dependencies

Text / Picture Guide

Installing Python 3.9

  1. Get the latest stable 64-bit Python 3.9.x release here: Python Download. At the time of writing this is Python 3.9.2.
    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.

Installing Python Modules required by ESRGAN

  1. Launch your favourite Terminal (CMD, PowerShell, Bash, …) as an administrator (right-click it in the start menu to get that option).
    • If you have 'a Nvidia GPU copy the following command and paste it in Git Bash and press enter:
      pip install torch==1.8.1+cu111 torchvision==0.9.1+cu111 torchaudio===0.8.1 -f https://download.pytorch.org/whl/torch_stable.html
    • If you have no Nvidia GPU copy the following command and paste it in Git Bash and press enter:
      pip install torch==1.8.1+cpu torchvision==0.9.1+cpu torchaudio===0.8.1 -f https://download.pytorch.org/whl/torch_stable.html
    • If the command won’t work for you, please report it. In the meantime, you can get an up to date version on the Pytorch Website. Select Stable, Windows, Pip, your Python version and your CUDA version (should be the newest) or None for AMD / Intel users.
  2. Now we install the other requirements for running and training ESRGAN and SFTGAN. Paste and press enter:
    pip install opencv-python

Installing git (+ Bash)

Not strictly required, but I reccomend it regardless.

  1. Get the latest stable 64-bit Git release here: Git Download.
  2. Run the installer and select the options as you want, the defaults are fine. I recommend to check the Launch Git Bash Explorer Integration. Also set your default editor to whatever editor is used (Unless you use the git command to commit, this setting is irrelevant for you).

Video Guide

Princess Potato recorded the process of installing ESRGAN and IEU in a video for all of you to enjoy. Seeing someone do it and talk about the process might help a lot of people to install not just ESRGAN, but also IEU You will find the video on YouTube here by clicking on this link.

What now?

We have a page dedicated to comparing the top options for ESRGAN programs / interfaces. It doesn't matter if you want a GUI that is easy to use or a Terminal interface for all your automation needs, just look here and chose what fits you best. ESRGAN Interface Comparison.