Clean language up docs (#147)

* clean up docs

* doc fixes as requested

* revert updates to sort tool documentation
This commit is contained in:
TooMuchFun 2019-02-15 08:06:13 -08:00 committed by iperov
parent 72c7db4980
commit 22ccec7036
4 changed files with 48 additions and 32 deletions

View file

@ -1,15 +1,16 @@
### **CPU only mode** ## Build and Repository Info
CPU mode enabled by arg --cpu-only for all stages. Follow requirements-cpu.txt to install req packages. DeepFaceLab officially supports Windows-only. If you want to support Mac/Linux/Docker - create a fork, it will be referenced here.
Do not use DLIB extractor in CPU mode, it's too slow.
Only H64 or SAE (with low settings) models reasonable to train on home CPU.
### **Build info**
dlib==19.10.0 from pip compiled without CUDA. Therefore you have to compile DLIB manually, orelse use MT extractor only. #### **Installing dlib on Windows**
Command line example for windows: `python setup.py install -G "Visual Studio 14 2015" --yes DLIB_USE_CUDA` The version of `dlib` in pip is compiled without CUDA support. Therefore you have to compile it manually in order to use the `dlib` face extractor.
### Mac/linux/docker script support. Command line example for Windows: `python setup.py install -G "Visual Studio 14 2015" --yes DLIB_USE_CUDA`
If you want to support mac/linux/docker - create fork, it will be referenced here. #### **CPU mode**
It is possible to run from script for all stages using the `--cpu-only` flag. To run from script, install the separate dependencies for CPU mode using `pip -r requirements-cpu.txt`.
Please note that extraction and training will take much long without a GPU and performance will greatly suffer without one. In particular, do not use DLIB extractor in CPU mode, it's too slow to run without a GPU. Train only on 64px resolution models like H64 or SAE (with low settings) and the lightweight encoder.

View file

@ -1,27 +1,39 @@
### **Features**: ### **Features**:
- standalone zero dependencies ready to work prebuilt binary for all windows versions, see below - Windows binary containing pre-compiled dependencies, including CUDA libraries.
- new models - New models expanding upon the original faceswap model.
- new architecture, easy to experiment with models - Model architecture designed with experimentation in mind.
- face data embedded to JPG files - Face metadata embedded into extracted JPG files.
- cpu mode. 8th gen Intel core CPU able to train H64 model in 2 days. - CPU-only mode [`--cpu-mode`]. 8th gen Intel core CPU able to train H64 model in 2 days.
- new preview window - Preview window
- extractor in parallel - Extractor and Converter run in parallel.
- converter in parallel - Debug mode option for all stages: [`--debug`]
- **--debug** option for all stages - Multiple extraction modes: MTCNN, dlib, or manual.
- **MTCNN extractor** which produce less jittered aligned face than DLIBCNN, but can produce more false faces. Comparison dlib (at left) vs mtcnn on hard case: #### Extractor Examples
##### MTCNN
Predicts faces more uniformly than dlib, resulting in a less jittered aligned output. However, MTCNN extraction will produce more false positives.
Comparison dlib (at left) vs mtcnn on hard case:
![](https://i.imgur.com/5qLiiOV.gif) ![](https://i.imgur.com/5qLiiOV.gif)
MTCNN produces less jitter.
- **Manual extractor**. You can fix missed faces manually or do full manual extract: - **Manual Extractor**
A manual extractor is available. This extractor uses the preview GUI to allow the user to properly align detected faces.
![](manual_extractor_0.jpg) ![](manual_extractor_0.jpg)
This mode can also be used to fix incorrectly extracted faces. Manual extraction can be used to greatly improve training on face sets that are heavily obstructed.
![Result](https://user-images.githubusercontent.com/8076202/38454756-0fa7a86c-3a7e-11e8-9065-182b4a8a7a43.gif) ![Result](https://user-images.githubusercontent.com/8076202/38454756-0fa7a86c-3a7e-11e8-9065-182b4a8a7a43.gif)

View file

@ -1,15 +1,16 @@
### Prebuilt windows app: ### **Prebuilt Windows Releases**
Windows 7,8,8.1,10 zero dependency (just install/update your GeForce Drivers) prebuilt DeepFaceLab (include GPU and CPU versions) can be downloaded from Windows builds with all dependencies included are released regularly. Only the NVIDIA GeForce display driver needs to be installed. Prebuilt DeepFaceLab, including GPU and CPU versions, can be downloaded from [Mega](https://mega.nz/#F!b9MzCK4B!zEAG9txu7uaRUjXz9PtBqg) or [BitTorrent](https://rutracker.org/forum/viewtopic.php?p=75318742) (magnet link inside).
1) torrent https://rutracker.org/forum/viewtopic.php?p=75318742 (magnet link inside).
2) https://mega.nz/#F!b9MzCK4B!zEAG9txu7uaRUjXz9PtBqg
### Video tutorials for prebuilt windows app:
Basic workflow: https://www.youtube.com/watch?v=K98nTNjXkq8
Basic workflow (derpfakes): https://www.youtube.com/watch?v=cVcyghhmQSA
How To Make DeepFakes With DeepFaceLab - An Amatuer's Guide: https://www.youtube.com/watch?v=wBax7_UWXvc #### Video tutorials using prebuilt windows app
Manual re-extract bad dst aligned frames: https://www.youtube.com/watch?v=7z1ykVVCHhM * [Basic workflow](https://www.youtube.com/watch?v=K98nTNjXkq8)
* [Basic workflow (thanks @derpfakes)](https://www.youtube.com/watch?v=cVcyghhmQSA)
* [How To Make DeepFakes With DeepFaceLab - An Amatuer's Guide](https://www.youtube.com/watch?v=wBax7_UWXvc)
* [Manual re-extract poorly aligned frames](https://www.youtube.com/watch?v=7z1ykVVCHhM)

View file

@ -1,4 +1,6 @@
### **Ready to work facesets**: ### **Example Face Sets**:
Faces sets for the following have been pre-extracted,
- Nicolas Cage - Nicolas Cage
- Steve Jobs - Steve Jobs
@ -6,4 +8,4 @@
- Elon Musk - Elon Musk
- Harrison Ford - Harrison Ford
download from https://mega.nz/#F!y1ERHDaL!PPwg01PQZk0FhWLVo5_MaQ [Download from Mega](https://mega.nz/#F!y1ERHDaL!PPwg01PQZk0FhWLVo5_MaQ)