Info-icon.png We have moved to https://openmodeldb.info/. This new site has a tag and search system, which will make finding the right models for you much easier! If you have any questions, ask here: https://discord.gg/cpAUpDK

Difference between revisions of "ESRGAN Installation Guide for Windows"

From Upscale Wiki
Jump to navigation Jump to search
(25 intermediate revisions by 2 users not shown)
Line 1: Line 1:
 
{| class="wikitable"
 
{| class="wikitable"
 
|-
 
|-
−
| Please make sure that you have the latest driver if you use an Nvidia GPU
+
| 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 installations if you want to follow this guide (especially older Python versions)
+
| Also make sure that you have no existing Python installation(s) if you want to follow this guide (especially older Python versions)
 +
|-
 +
| Only Python 3.8.x is currently supported. Also only the Python installation as instructed below is 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.
 
|}
 
|}
  
 
This guide will help you to install ESRGAN on Windows, by showing you step by step with images how to do it.
 
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.
+
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.
  
−
If you have any problems during or after the installation, feel free to ask any questions on our [https://discord.gg/SxvYsgE Discord server] and we will try to help you out.
+
== Installing ESRGAN ==
  
−
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.
+
=== Text / Picture Guide ===
  
−
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 Python 3.8====
  
−
== Installing ESRGAN ==
+
# Get the latest stable 64-bit Python 3.8.x release here: [https://www.python.org/downloads/windows/ Python Download]. At the time of writing this is Python 3.8.6.
−
# Get the latest stable 64-bit Python 3 release here: [https://www.python.org/downloads/windows/ Python Download]  
 
 
#: [[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 25: Line 30:
 
# 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.]]
−
# 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>
+
==== Installing git (+ Bash) ====
−
#: [[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:
+
# Get the latest stable 64-bit Git release here: [https://git-scm.com/download/win Git Download].
−
#* If you have a '''Nvidia''' graphic card enter the following command in the cmd and press enter:  
+
# 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>pip install torch==1.2.0 torchvision==0.4.0 -f https://download.pytorch.org/whl/torch_stable.html</code>
+
 
−
#*: [[File:GuideEsrganWin_7-Nvidia.jpg|frameless|A Windows command prompt open with the command entered but not executed.]]
+
==== Installing Python Modules required by ESRGAN ====
−
#* If you have an '''AMD / Intel''' graphic card enter the following command in the cmd and press enter:
+
 
−
#*: <code>pip install torch==1.2.0+cpu torchvision==0.4.0+cpu -f https://download.pytorch.org/whl/torch_stable.html</code>  
+
# Launch a Git Bash Shell as an administrator (right-click it in the start menu to get that option).
−
#*: [[File:GuideEsrganWin_7-CPU.jpg|frameless|A Windows command prompt open with the command entered but not executed.]]
+
#* If you have a '''Nvidia''' graphic card copy the following command and paste it in Git Bash and press enter:  
−
#* 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.
+
#*: <code>pip install torch===1.7.1+cu110 torchvision===0.8.2+cu110 torchaudio===0.7.2 -f https://download.pytorch.org/whl/torch_stable.html</code>
−
# Now we install the other requirements for running and training ESRGAN and SFTGAN. Enter:
+
#* If you have an '''AMD / Intel''' graphic card copy the following command and paste it in Git Bash and press enter:  
 +
#*: <code>pip install torch==1.7.1+cpu torchvision==0.8.2+cpu torchaudio===0.7.2 -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.
 +
# 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>
−
#: [[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>
+
Currently there is an issue with newer versions of Windows 10 and the current version of NumPy, until there is a fix (expected in January 2021), downgrade NumPy like this:
−
## Create a folder called <code>ctp</code> (That will come in handy if you want to install Deorders scripts later)
+
 
−
## In the <code>ctp</code> folder create a folder called <code>esrgan</code>
+
<code>
−
## Open the <code>esrgan</code> folder.
+
pip install numpy==1.19.3
−
# Now it is time to download ESRGAN:
+
</code>
−
## Go to [https://github.com/xinntao/ESRGAN/tree/aceb85730832001ec1fa3a77bd6856b75e1d0e87 the ESRGAN GitHub Repo (old model structure)]
+
 
−
## Click on <code>Clone or Download</code>
+
==== Cloning ESRGAN into a folder of your choice ====
−
## Click on <code>Download ZIP</code>
+
 
−
##: [[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]]
+
# 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>
−
# 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:
+
## 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)
−
#: [[File:GuideEsrganWin_11-explorer.jpg|frameless|An image of C:/ctp/esrgan/ open in Windows Explorer with the address bar underlined]]
+
## In the <code>nn</code> folder right click and select <code>Git Bash Here</code>.
−
# Now it is time to download and install the default ESRGAN models:
+
# Clone ESRGAN by pasting the following command
−
## Go to the [https://drive.google.com/drive/folders/17VYV_SoZZesU6mbxz2dMAIccSSlqLecY ESRGAN Pretrained Models Google Drive]
+
#: <code>git clone https://github.com/JoeyBallentine/ESRGAN.git</code>
−
## Download the two <code>_old_arch.pth</code> files.
+
 
−
## Put the two <code>.pth</code> files that you have just downloaded into your <code>models</code> folder in your <code>esrgan</code> folder
+
=== Video Guide ===
−
### For example in:
+
 
−
###: <code>C:\ctp\esrgan\models\</code>
+
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
−
# If you have a Nvidia Graphic Card, then you have successfully installed ESRGAN, congratulations!
+
[https://www.youtube.com/watch?v=w4Hb7tyDsWE You will find the video on YouTube here by clicking on this link].
−
# However, if you have an AMD / Intel Graphic Card, then you need to open <code>test.py</code> in your ESRGAN folder with a text editor.
+
 
−
## Change:
+
==Usage==
−
##: <code>device = torch.device('cuda') # if you want to run on CPU, change 'cuda' -> cpu</code>
+
How to actually [[Using ESRGAN, Links, And Other Information|use ESRGAN (IEU for example), other useful information and important links are here]].
−
##: into:
 
−
##: <code>device = torch.device('cpu') # if you want to run on CPU, change 'cuda' -> cpu</code>
 

Revision as of 23:09, 19 December 2020

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 Python installation(s) if you want to follow this guide (especially older Python versions)
Only Python 3.8.x is currently supported. Also only the Python installation as instructed below is supported.
No knowledge of Python or coding is necessary to follow this guide.
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

Text / Picture Guide

Installing Python 3.8

  1. Get the latest stable 64-bit Python 3.8.x release here: Python Download. At the time of writing this is Python 3.8.6.
    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 git (+ Bash)

  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).

Installing Python Modules required by ESRGAN

  1. Launch a Git Bash Shell 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:
      pip install torch===1.7.1+cu110 torchvision===0.8.2+cu110 torchaudio===0.7.2 -f https://download.pytorch.org/whl/torch_stable.html
    • If you have an AMD / Intel graphic card copy the following command and paste it in Git Bash and press enter:
      pip install torch==1.7.1+cpu torchvision==0.8.2+cpu torchaudio===0.7.2 -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

Currently there is an issue with newer versions of Windows 10 and the current version of NumPy, until there is a fix (expected in January 2021), downgrade NumPy like this:

pip install numpy==1.19.3

Cloning ESRGAN into a folder of your choice

  1. 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:\nn\esrgan\

    1. Create a folder called nn (Try to avoid spaces and always use short paths especially on Windows on other operating systems the path length at least is irrelevant)
    2. In the nn folder right click and select Git Bash Here.
  2. Clone ESRGAN by pasting the following command
    git clone https://github.com/JoeyBallentine/ESRGAN.git

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.

Usage

How to actually use ESRGAN (IEU for example), other useful information and important links are here.

Retrieved from "https://upscale.wiki/w/index.php?title=ESRGAN_Installation_Guide_for_Windows&oldid=1132"