ADD: Features section; Troubleshooting urls

Gourieff · Sep 1, 2023 · 7a3f16d · 7a3f16d
1 parent 9a86140
commit 7a3f16d
Show file tree

Hide file tree

Showing 2 changed files with 60 additions and 20 deletions.
diff --git a/README.md b/README.md
@@ -23,7 +23,7 @@
 ---
 <div align="center">
   <b>
-    <a href="#installation">Installation</a> | <a href="#usage">Usage</a> | <a href="#api">API</a> | <a href="#troubleshooting">Troubleshooting</a> | <a href="#updating">Updating</a> | <a href="#comfyui">ComfyUI</a> | <a href="#disclaimer">Disclaimer</a>
+    <a href="#installation">Installation</a> | <a href="#features">Features</a> | <a href="#usage">Usage</a> | <a href="#api">API</a> | <a href="#troubleshooting">Troubleshooting</a> | <a href="#updating">Updating</a> | <a href="#comfyui">ComfyUI</a> | <a href="#disclaimer">Disclaimer</a>
   </b>
 </div>
 
@@ -87,6 +87,23 @@
 3. When you see the message "--- PLEASE, RESTART the Server! ---" (in your Colab Notebook Start UI section "Start Cagliostro Colab UI") - just go to the "Installed" tab and click "Apply and restart UI" (*if you have any other Roop-based extension enabled - disable it before restart, otherwise this extension won't work*)
 4. Enjoy!
 
+## Features
+
+- Very fast and accurate **face replacement (face swap)** in images
+- **Multiple faces support**
+- **Gender detection**
+- Ability to **save original images** (made before swapping)
+- **Face restoration** of a swapped face
+- **Upscaling** of a resulting image
+- Ability to set the **Postprocessing order**
+- **100% compatibility** with different **SD WebUIs**: Automatic1111, SD.Next, Cagliostro Colab UI
+- **Fast performance** even with CPU, ReActor for SD WebUI is absolutely not picky about how powerful your GPU is
+- **[API](/API.md) support**: both SD WebUI built-in and external (via POST/GET requests)
+- **ComfyUI [support](https://github.com/Gourieff/comfyui-reactor-node)**
+- **Mac M1/M2 [support](https://github.com/Gourieff/sd-webui-reactor/issues/42)**
+- Console **log level control**
+- **NSFW filter free** (this extension is aimed at highly developed intellectual people, not at perverts; our society must be oriented on its way towards the highest standards, not the lowest - this is the essence of development and evolution; so, my position is - that mature-minded people are clever enough to understand for themselves what is good and what is bad and take full responsibility for personal actions; for others - no "filters" will help until they do understand how Universe works)
+
 ## Usage
 
 > Using this software you are agree with [disclaimer](#disclaimer)
@@ -128,11 +145,11 @@ Please follow **[this](/API.md)** page for the detailed instruction.
 
 ## Troubleshooting
 
-**I. "You should at least have one model in models directory"**
+### **I. "You should at least have one model in models directory"**
 
 Please, check the path where "inswapper_128.onnx" model is stored. It must be inside the folder `stable-diffusion-webui\models\insightface`. Move the model there if it's stored in a different directory.
 
-**II. Any problems with installing Insightface or other dependencies**
+### **II. Any problems with installing Insightface or other dependencies**
 
 (for Mac M1/M2 users) If you get errors when trying to install Insightface - please read https://github.com/Gourieff/sd-webui-reactor/issues/42
 
@@ -154,7 +171,7 @@ Please, check the path where "inswapper_128.onnx" model is stored. It must be in
    - `pip install tqdm`
 8. Type `deactivate`, you can close your Terminal or Console and start your SD WebUI, ReActor should start OK - if not, welcome to the Issues section.
 
-**III. "TypeError: UpscaleOptions.init() got an unexpected keyword argument 'do_restore_first'"**
+### **III. "TypeError: UpscaleOptions.init() got an unexpected keyword argument 'do_restore_first'"**
 
 First of all - you need to disable any other Roop-based extensions:
 - Go to 'Extensions -> Installed' tab and uncheck any Roop-based extensions except this one
@@ -165,18 +182,18 @@ Alternative solutions:
 - https://github.com/Gourieff/sd-webui-reactor/issues/3#issuecomment-1615919243
 - https://github.com/Gourieff/sd-webui-reactor/issues/39#issuecomment-1666559134 (can be actual, if you use Vladmandic SD.Next)
 
-**IV. "AttributeError: 'FaceSwapScript' object has no attribute 'enable'"**
+### **IV. "AttributeError: 'FaceSwapScript' object has no attribute 'enable'"**
 
 You need to disable the "SD-CN-Animation" extension (or perhaps some another that causes the conflict)
 
-**V. "INVALID_PROTOBUF : Load model from <...>\models\insightface\inswapper_128.onnx failed:Protobuf parsing failed"**
+### **V. "INVALID_PROTOBUF : Load model from <...>\models\insightface\inswapper_128.onnx failed:Protobuf parsing failed"**
 
 This error may occur if there's smth wrong with the model file `inswapper_128.onnx`
 
 Try to download it manually from [here](https://github.com/facefusion/facefusion-assets/releases/download/models/inswapper_128.onnx)
 and put it to the `stable-diffusion-webui\models\insightface` replacing existing one
 
-**VI. "ValueError: This ORT build has ['TensorrtExecutionProvider', 'CUDAExecutionProvider', 'CPUExecutionProvider'] enabled"**
+### **VI. "ValueError: This ORT build has ['TensorrtExecutionProvider', 'CUDAExecutionProvider', 'CPUExecutionProvider'] enabled"**
 
 1. Close (stop) your SD WebUI Server if it's running
 2. Go to the (Windows)`venv\Lib\site-packages` or (MacOS/Linux)`venv/lib/python3.10/site-packages` and see if there are any folders with names start from "~" (for example "~rotobuf"), delete them
@@ -188,7 +205,7 @@ and put it to the `stable-diffusion-webui\models\insightface` replacing existing
 
 If it didn't help - it seems that you have another extension reinstalling `onnxruntime` when SD WebUI checks requirements. Please see your extensions list. If you find there "WD14 tagger" - try to disable it and then follow the steps above once again. This extension causes reinstalling of `onnxruntime` to `onnxruntime-gpu` every time SD WebUI runs.
 
-**VII. "ImportError: cannot import name 'builder' from 'google.protobuf.internal'"**
+### **VII. "ImportError: cannot import name 'builder' from 'google.protobuf.internal'"**
 
 1. Close (stop) your SD WebUI Server if it's running
 2. Go to the (Windows)`venv\Lib\site-packages` or (MacOS/Linux)`venv/lib/python3.10/site-packages` and see if there are any folders with names start from "~" (for example "~rotobuf"), delete them
@@ -201,7 +218,9 @@ If it didn't help - it seems that you have another extension reinstalling `onnxr
 
 If this method doesn't help - there is some other extension that has a higher version of protobuf dependence and SD WebUI installs it on a startup requirements check
 
-<a name="insightfacebuild">**VIII. (For Windows users) If you still cannot build Insightface for some reasons or just don't want to install Visual Studio or VS C++ Build Tools - do the following:**
+<a name="insightfacebuild">
+
+### **VIII. (For Windows users) If you still cannot build Insightface for some reasons or just don't want to install Visual Studio or VS C++ Build Tools - do the following:**
 
 1. Close (stop) your SD WebUI Server if it's running
 2. Download and put [prebuilt Insightface package](https://github.com/Gourieff/sd-webui-reactor/raw/main/example/insightface-0.7.3-cp310-cp310-win_amd64.whl) into the stable-diffusion-webui (or SD.Next) root folder (where you have "webui-user.bat" file)
@@ -210,7 +229,7 @@ If this method doesn't help - there is some other extension that has a higher ve
 5. Then install Insightface: `pip install insightface-0.7.3-cp310-cp310-win_amd64.whl`
 6. Enjoy!
 
-**IX. 07-August Update problem**
+### **IX. 07-August-23 Update problem**
 
 If after `git pull` you see the message: `Merge made by the 'recursive' strategy` and then when you check `git status` you see `Your branch is ahead of 'origin/main' by`
 

diff --git a/README_RU.md b/README_RU.md
@@ -19,7 +19,7 @@
 ---
 <div align="center">
   <b>
-    <a href="#installation">Установка</a> | <a href="#usage">Использование</a> | <a href="#api">API</a> | <a href="#troubleshooting">Устранение проблем</a> | <a href="#updating">Обновление</a> | <a href="#comfyui">ComfyUI</a> | <a href="#disclaimer">Ответственность</a>
+    <a href="#installation">Установка</a> | <a href="#features">Возможности</a> | <a href="#usage">Использование</a> | <a href="#api">API</a> | <a href="#troubleshooting">Устранение проблем</a> | <a href="#updating">Обновление</a> | <a href="#comfyui">ComfyUI</a> | <a href="#disclaimer">Ответственность</a>
   </b>
 </div>
 
@@ -85,6 +85,25 @@
 3. Когда вы увидите сообщение "--- PLEASE, RESTART the Server! ---" (в секции "Start UI" вашего ноутбука "Start Cagliostro Colab UI") - перейдите во вкладку "Installed" и нажмите "Apply and restart UI" (*если у вас имееются какие-либо другие расширение, основанные на Roop или клонах ReActor - отключите их, иначе данное расширение может не работать*)
 4. Готово!
 
+<a name="features">
+
+## Возможности
+
+- Быстрая и точна **замена лиц (faceswap)** на изображении
+- **Поддержка нескольких лиц**
+- **Определение пола**
+- Функция **сохранения оригинального изображения** (сгенерированного до замены лица)
+- **Восстановление лица** после замены
+- **Увеличение размера** полученного изображения
+- Возможность задать **порядок постобработки**
+- **100% совместимость** с разными **SD WebUI**: Automatic1111, SD.Next, Cagliostro Colab UI
+- **Отличная производительность** даже с использованием ЦПУ, ReActor для SD WebUI абсолютно не требователен к мощности вашей видеокарты
+- **Поддержка [API](/API.md)**: как встроенного в SD WebUI, так и внешнего (через POST/GET запросы)
+- **[Поддержка](https://github.com/Gourieff/comfyui-reactor-node) ComfyUI**
+- **[Поддержка](https://github.com/Gourieff/sd-webui-reactor/issues/42) компьютеров Mac M1/M2**
+- **Регулировка уровня логов** консоли
+- **Без NSFW фильтров** (данное расширение адресовано высокоразвитым интеллектуальным людям, а не извращенцам; наше общество должно быть ориентировано на своём пути на высшие стандарты, а не на низшие - в этом состоит суть развития и эволюции человеческого общества; поэтому, моя позиция такова - что зрелые умом люди достаточно разумны, чтобы понимать, что есть хорошо, а что плохо и нести полную ответственность за собственные действия; для прочих - никакие "фильтры" не помогут, пока эти люди сами не поймут, как работает Вселенная)
+
 <a name="usage">
 
 ## Использование
@@ -130,11 +149,11 @@ Inpainting также работает, но замена лица происх
 
 ## Устранение проблем
 
-**I. "You should at least have one model in models directory"**
+### **I. "You should at least have one model in models directory"**
 
 Проверьте путь, где хранится модель "inswapper_128.onnx". Файл должен находиться в папке `stable-diffusion-webui\models\insightface`. Переместите модель туда, если она находится в какой-то иной директории.
 
-**II. Any problems with installing Insightface or other dependencies**
+### **II. Какие-либо проблемы с установкой Insightface или прочих пакетов**
 
 (Для пользователей Mac M1/M2) Если вы получаете ошибки в ходе установки Insightface - читайте https://github.com/Gourieff/sd-webui-reactor/issues/42
 
@@ -156,7 +175,7 @@ Inpainting также работает, но замена лица происх
    - `pip install tqdm`
 8. Выполните `deactivate`, закройте Терминал или Консоль и запустите SD WebUI, ReActor должен запуститься без к-л проблем - если же нет, добро пожаловать в раздел "Issues".
 
-**III. "TypeError: UpscaleOptions.init() got an unexpected keyword argument 'do_restore_first'"**
+### **III. "TypeError: UpscaleOptions.init() got an unexpected keyword argument 'do_restore_first'"**
 
 Для начала отключите любые другие Roop-подобные расширения:
 - Перейдите в 'Extensions -> Installed' и снимите флажок с ненужных:
@@ -167,18 +186,18 @@ Inpainting также работает, но замена лица происх
 - https://github.com/Gourieff/sd-webui-reactor/issues/3#issuecomment-1615919243
 - https://github.com/Gourieff/sd-webui-reactor/issues/39#issuecomment-1666559134 (актуально для Vladmandic SD.Next)
 
-**IV. "AttributeError: 'FaceSwapScript' object has no attribute 'enable'"**
+### **IV. "AttributeError: 'FaceSwapScript' object has no attribute 'enable'"**
 
 Отключите расширение "SD-CN-Animation" (или какое-либо другое, вызывающее конфликт)
 
-**V. "INVALID_PROTOBUF : Load model from <...>\models\insightface\inswapper_128.onnx failed:Protobuf parsing failed"**
+### **V. "INVALID_PROTOBUF : Load model from <...>\models\insightface\inswapper_128.onnx failed:Protobuf parsing failed"**
 
 Эта ошибка появляется, если что-то не так с файлом модели `inswapper_128.onnx`.
 
 Скачайте вручную по ссылке [here](https://github.com/facefusion/facefusion-assets/releases/download/models/inswapper_128.onnx)
 и сохраните в директорию `stable-diffusion-webui\models\insightface`, заменив имеющийся файл.
 
-**VI. "ValueError: This ORT build has ['TensorrtExecutionProvider', 'CUDAExecutionProvider', 'CPUExecutionProvider'] enabled"**
+### **VI. "ValueError: This ORT build has ['TensorrtExecutionProvider', 'CUDAExecutionProvider', 'CPUExecutionProvider'] enabled"**
 
 1. Закройте (остановите) SD WebUI Сервер, если он запущен
 2. Перейдите в (Windows)`venv\Lib\site-packages` или (MacOS/Linux)`venv/lib/python3.10/site-packages` и посмотрите, если там папки с именам, начинающимися на "~" (например, "~rotobuf"), удалите их
@@ -190,7 +209,7 @@ Inpainting также работает, но замена лица происх
 
 Если это не помогло - значит какое-то другое расширение переустанавливает `onnxruntime` всякий раз, когда SD WebUI проверяет требования пакетов. Внимательно посмотрите список активных расширений. Если видите там "WD14 tagger" - попробуйте отключить его и ещё раз выполнить шаги выше. Это расширение вызывает переустановку `onnxruntime` на `onnxruntime-gpu` при каждом запуске SD WebUI.
 
-**VII. "ImportError: cannot import name 'builder' from 'google.protobuf.internal'"**
+### **VII. "ImportError: cannot import name 'builder' from 'google.protobuf.internal'"**
 
 1. Закройте (остановите) SD WebUI Сервер, если он запущен
 2. Перейдите в (Windows)`venv\Lib\site-packages` или (MacOS/Linux)`venv/lib/python3.10/site-packages` и посмотрите, если там папки с именам, начинающимися на "~" (например, "~rotobuf"), удалите их
@@ -203,7 +222,9 @@ Inpainting также работает, но замена лица происх
 
 Если это не помгло - значит, есть к-л другое расширение, которое использует более новую версию пакета protobuf, и SD WebUI устанавливает эту версию при каждом запуске.
 
-<a name="insightfacebuild">**VIII. (For Windows users) If you still cannot build Insightface for some reasons or just don't want to install Visual Studio or VS C++ Build Tools - do the following:**
+<a name="insightfacebuild">
+
+### **VIII. (Для пользователей Windows) Если вы до сих пор не можете установить пакет Insightface по каким-то причинам или же просто не желаете устанавливать Visual Studio или VS C++ Build Tools - сделайте следующее:**
 
 1. Закройте (остановите) SD WebUI Сервер, если он запущен
 2. Скачайте готовый [пакет Insightface](https://github.com/Gourieff/sd-webui-reactor/raw/main/example/insightface-0.7.3-cp310-cp310-win_amd64.whl) и сохраните его в корневую директорию stable-diffusion-webui (или SD.Next) - туда, где лежит файл "webui-user.bat"
@@ -212,7 +233,7 @@ Inpainting также работает, но замена лица происх
 5. Затем установите Insightface: `pip install insightface-0.7.3-cp310-cp310-win_amd64.whl`
 6. Готово!
 
-**IX. 07-August Update problem**
+### **IX. Ошибка обновления 07-Август-23**
 
 Если после очередного `git pull` вы получили сообщение: `Merge made by the 'recursive' strategy` и затем, когда проверяете статус репозитория через `git status`, вы видите `Your branch is ahead of 'origin/main' by`