Add install guide

This commit is contained in:
geewiz94 2022-05-07 13:51:01 +02:00
parent faef5a683e
commit a0d38c2d68
2 changed files with 38 additions and 17 deletions

View File

@ -20,6 +20,7 @@
- [Running faceswap](#running-faceswap)
- [Create a desktop shortcut](#create-a-desktop-shortcut)
- [Updating faceswap](#updating-faceswap)
- [macOS (Apple Silicon) Install Guide](#macos-apple-silicon-install-guide)
- [General Install Guide](#general-install-guide)
- [Installing dependencies](#installing-dependencies)
- [Git](#git-1)
@ -54,7 +55,7 @@ The type of computations that the process does are well suited for graphics card
- **Linux**
Most Ubuntu/Debian or CentOS based Linux distributions will work.
- **macOS**
GPU support on macOS is limited due to lack of drivers/libraries from Nvidia.
WIP port for GPU-accelerated, native Apple Silicon processing.
- All operating systems must be 64-bit for Tensorflow to run.
Alternatively, there is a docker image that is based on Debian.
@ -145,6 +146,42 @@ It's good to keep faceswap up to date as new features are added and bugs are fix
- 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`
# macOS (Apple Silicon) Install Guide
## Prerequisites
### OS
macOS 12.0+
### XCode Tools
`xcode-select --install`
### XQuartz
Download and install from: https://www.xquartz.org/
### Conda
Download and install the latest Conda env from: https://github.com/conda-forge/miniforge/releases/latest/download/Miniforge3-MacOSX-arm64.sh
```sh
$ chmod +x ~/Downloads/Miniforge3-MacOSX-arm64.sh
$ sh ~/Downloads/Miniforge3-MacOSX-arm64.sh
$ source ~/miniforge3/bin/activate
```
## Setup
### faceswap
- Get the faceswap repo by typing: `git clone --depth 1 https://github.com/deepfakes/faceswap.git`
- Enter the faceswap folder: `cd faceswap`
#### Easy install
```sh
$ conda deactivate
$ conda env create -f conda-environment-apple-silicon.yml
$ conda activate faceswap
```
- Enter the command `python faceswap.py gui` and follow the prompts:
- Choose '4' for Apple Silicon
- If you have issues/errors follow the Manual install steps below.
# General Install Guide
## Installing dependencies
### Git

View File

@ -17,25 +17,9 @@
[![Build Status](https://travis-ci.org/deepfakes/faceswap.svg?branch=master)](https://travis-ci.org/deepfakes/faceswap) [![Documentation Status](https://readthedocs.org/projects/faceswap/badge/?version=latest)](https://faceswap.readthedocs.io/en/latest/?badge=latest)
============================
# Apple Silicon port
## WIP port for GPU-accelerated, native Apple Silicon processing.
```sh
$ conda env create -f conda-environment-apple-silicon.yml
```
Ensure that the backend is set to "apple" and **not** to "cpu".
You may have to modify the config file in `./config/.faceswap`.
============================
Make sure you check out [INSTALL.md](INSTALL.md) before getting started.
- [deepfakes_faceswap](#deepfakes_faceswap)
- [Apple Silicon port](#apple-silicon-port)
- [WIP port for GPU-accelerated, native Apple Silicon processing.](#wip-port-for-gpu-accelerated-native-apple-silicon-processing)
- [Manifesto](#manifesto)
- [FaceSwap has ethical uses.](#faceswap-has-ethical-uses)
- [How To setup and run the project](#how-to-setup-and-run-the-project)