Skip to content

Commit

Permalink
Update INSTALL.md
Browse files Browse the repository at this point in the history
  • Loading branch information
torzdf committed Jun 27, 2019
1 parent 8ec96b4 commit ebde8c3
Showing 1 changed file with 39 additions and 20 deletions.
59 changes: 39 additions & 20 deletions INSTALL.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# Installing Faceswap
- [Installing Faceswap](#Installing-Faceswap)
# Installing faceswap
- [Installing faceswap](#Installing-faceswap)
- [Prerequisites](#Prerequisites)
- [Hardware Requirements](#Hardware-Requirements)
- [Supported operating systems](#Supported-operating-systems)
Expand All @@ -14,14 +14,17 @@
- [Anaconda](#Anaconda-1)
- [Set up a virtual environment](#Set-up-a-virtual-environment)
- [Entering your virtual environment](#Entering-your-virtual-environment)
- [Faceswap](#Faceswap)
- [faceswap](#faceswap)
- [Easy install](#Easy-install)
- [Manual install](#Manual-install)
- [Running Faceswap](#Running-Faceswap)
- [Running faceswap](#Running-faceswap)
- [Create a desktop shortcut](#Create-a-desktop-shortcut)
- [Updating faceswap](#Updating-faceswap)
- [General Install Guide](#General-Install-Guide)
- [Installing dependencies](#Installing-dependencies)
- [Git](#Git-1)
- [Python](#Python)
- [Virtual Environment](#Virtual-Environment)
- [Getting the faceswap code](#Getting-the-faceswap-code)
- [Setup](#Setup-1)
- [About some of the options](#About-some-of-the-options)
Expand Down Expand Up @@ -66,11 +69,11 @@ The developers are also not responsible for any damage you might cause to your o
## Installer
Windows now has an installer which installs everything for you and creates a desktop shortcut to launch straight into the GUI. You can download the installer from https://github.com/deepfakes/faceswap/releases.

If you have issues with the installer then read on for the more manual way to install Faceswap on Windows.
If you have issues with the installer then read on for the more manual way to install faceswap on Windows.

## Manual Install

Setting up Faceswap can seem a little intimidating to new users, but it isn't that complicated, although a little time consuming. It is recommended to use Linux where possible as Windows will hog about 20% of your GPU Memory, making Faceswap run a little slower, however using Windows is perfectly fine and 100% supported.
Setting up faceswap can seem a little intimidating to new users, but it isn't that complicated, although a little time consuming. It is recommended to use Linux where possible as Windows will hog about 20% of your GPU Memory, making faceswap run a little slower, however using Windows is perfectly fine and 100% supported.

## Prerequisites

Expand Down Expand Up @@ -101,9 +104,9 @@ To enter the virtual environment:
- Hit the ">" arrow next to your faceswap environment and select "Open Terminal"
![Anaconda enter virtual env](https://i.imgur.com/rKSq2Pd.png)

### Faceswap
### faceswap
- If you are not already in your virtual environment follow [these steps](#entering-your-virtual-environment)
- Get the Faceswap repo by typing: `git clone --depth 1 https://github.com/deepfakes/faceswap.git`
- Get the faceswap repo by typing: `git clone --depth 1 https://github.com/deepfakes/faceswap.git`
- Enter the faceswap folder: `cd faceswap`

#### Easy install
Expand All @@ -118,7 +121,7 @@ Do not follow these steps if the Easy Install above completed succesfully.
- GPU Version: `conda install tensorflow-gpu`
- Non GPU Version: `conda install tensorflow`

## Running Faceswap
## Running faceswap
- If you are not already in your virtual environment follow [these steps](#entering-your-virtual-environment)
- Enter the faceswap folder: `cd faceswap`
- Enter the following to see the list of commands: `python faceswap.py -h` or enter `python faceswap.py gui` to launch the GUI
Expand All @@ -135,29 +138,45 @@ A desktop shortcut can be added to easily launch straight into the faceswap GUI:

## Updating faceswap
It's good to keep faceswap up to date as new features are added and bugs are fixed. To do so:
- If using the GUI you can go to the Tools Menu and select "Check for Updates...". This will update Faceswap to the latest code and update your dependencies.
- If using the GUI you can go to the Tools Menu and select "Check for Updates...". This will update faceswap to the latest code and update your dependencies.
- If you are not already in your virtual environment follow [these steps](#entering-your-virtual-environment)
- Enter the faceswap folder: `cd faceswap`
- Enter the following `git pull --all`
- Once the latest version has downloaded, make sure your dependencies are up to date. There is a script to help with this: `python update_deps.py`

# General Install Guide
## Installing dependencies
- Python >= 3.2-3.7 64-bit
- apt/yum install python3 (Linux)
- [Installer](https://www.python.org/downloads/release/python-368/) (Windows)
- [brew](https://brew.sh/) install python3 (macOS)
### Git
Git is required for obtaining the code and keeping your codebase up to date.
Obtain git for your distribution from the [git website](https://git-scm.com/downloads).

### Python
The recommended install method is to use a Conda3 Environment as this will handle the installation of Nvidia's CUDA and cuDNN straight into your Conda Environment.
- [MiniConda3](https://docs.conda.io/en/latest/miniconda.html)

Alternatively you can install Python (>= 3.2-3.7 64-bit) for your distribution (links below.) If you go down this route and are using an Nvidia GPU you should install CUDA (https://developer.nvidia.com/cuda-zone) and cuDNN (https://developer.nvidia.com/cudnn). for your system. If you do not plan to build Tensorflow yourself, make sure you install no higher than version 10.0 of CUDA and 7.5.x of CUDNN.
- Python distributions:
- apt/yum install python3 (Linux)
- [Installer](https://www.python.org/downloads/release/python-368/) (Windows)
- [brew](https://brew.sh/) install python3 (macOS)

### Virtual Environment
It is highly recommended that you setup faceswap inside a virtual environment. In fact we will not generally support installations that are not within a virtual environment as troubleshooting package conflicts can be next to impossible.

If using Conda3 then setting up virtual environments is relatively straight forward. More information can be found at [Conda Docs](https://docs.conda.io/projects/conda/en/latest/user-guide/tasks/manage-environments.html)

If using a default Python distribution then [virtualenv](https://github.com/pypa/virtualenv) and [virtualenvwrapper](https://virtualenvwrapper.readthedocs.io) may help when you are not using docker.

- [virtualenv](https://github.com/pypa/virtualenv) and [virtualenvwrapper](https://virtualenvwrapper.readthedocs.io) may help when you are not using docker.
- If you are using an Nvidia graphics card You should install CUDA (https://developer.nvidia.com/cuda-zone) and CUDNN (https://developer.nvidia.com/cudnn). If you do not plan to build Tensorflow yourself, make sure you install no higher than version 10.0 of CUDA and 7.4.x of CUDNN

## Getting the faceswap code
Simply download the code from http://github.com/deepfakes/faceswap - For development, it is recommended to use git instead of downloading the code and extracting it.
It is recommended to clone the repo with git instead of downloading the code from http://github.com/deepfakes/faceswap and extracting it as this will make it far easier to get the latest code (which can be done from the GUI). To clone a repo you can either use the Git GUI for your distribution or open up a command prompt, enter the folder where you want to store faceswap and enter:
```bash
git clone https://github.com/deepfakes/faceswap.git
```

For now, extract the code to a directory where you're comfortable working with it. Navigate to it with the command line. For our example, we will use `~/faceswap/` as our project directory.

## Setup
Enter the folder that faceswap has been downloaded to and run:
Enter your virtual environment and then enter the folder that faceswap has been downloaded to and run:
```bash
python setup.py
```
Expand Down Expand Up @@ -185,7 +204,7 @@ INFO 1. Install Docker
1. Install Nvidia-Docker & Restart Docker Service
https://github.com/NVIDIA/nvidia-docker
1. Build Docker Image For Faceswap
1. Build Docker Image For faceswap
docker build -t deepfakes-gpu -f Dockerfile.gpu .
1. Mount faceswap volume and Run it
Expand Down

0 comments on commit ebde8c3

Please sign in to comment.