1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71
| python run.py [options]
options: -h, --help show this help message and exit -s SOURCE_PATHS, --source SOURCE_PATHS choose single or multiple source images or audios -t TARGET_PATH, --target TARGET_PATH choose single target image or video -o OUTPUT_PATH, --output OUTPUT_PATH specify the output file or directory -v, --version show program's version number and exit
misc: --skip-download omit automate downloads and remote lookups --headless run the program without a user interface --log-level {error,warn,info,debug} adjust the message severity displayed in the terminal
execution: --execution-providers EXECUTION_PROVIDERS [EXECUTION_PROVIDERS ...] accelerate the model inference using different providers (choices: cpu, ...) --execution-thread-count [1-128] specify the amount of parallel threads while processing --execution-queue-count [1-32] specify the amount of frames each thread is processing
memory: --video-memory-strategy {strict,moderate,tolerant} balance fast frame processing and low vram usage --system-memory-limit [0-128] limit the available ram that can be used while processing
face analyser: --face-analyser-order {left-right,right-left,top-bottom,bottom-top,small-large,large-small,best-worst,worst-best} specify the order in which the face analyser detects faces. --face-analyser-age {child,teen,adult,senior} filter the detected faces based on their age --face-analyser-gender {female,male} filter the detected faces based on their gender --face-detector-model {retinaface,yoloface,yunet} choose the model responsible for detecting the face --face-detector-size FACE_DETECTOR_SIZE specify the size of the frame provided to the face detector --face-detector-score [0.0-1.0] filter the detected faces base on the confidence score
face selector: --face-selector-mode {reference,one,many} use reference based tracking with simple matching --reference-face-position REFERENCE_FACE_POSITION specify the position used to create the reference face --reference-face-distance [0.0-1.5] specify the desired similarity between the reference face and target face --reference-frame-number REFERENCE_FRAME_NUMBER specify the frame used to create the reference face
face mask: --face-mask-types FACE_MASK_TYPES [FACE_MASK_TYPES ...] mix and match different face mask types (choices: box, occlusion, region) --face-mask-blur [0.0-1.0] specify the degree of blur applied the box mask --face-mask-padding FACE_MASK_PADDING [FACE_MASK_PADDING ...] apply top, right, bottom and left padding to the box mask --face-mask-regions FACE_MASK_REGIONS [FACE_MASK_REGIONS ...] choose the facial features used for the region mask (choices: skin, left-eyebrow, right-eyebrow, left-eye, right-eye, eye-glasses, nose, mouth, upper-lip, lower-lip)
frame extraction: --trim-frame-start TRIM_FRAME_START specify the the start frame of the target video --trim-frame-end TRIM_FRAME_END specify the the end frame of the target video --temp-frame-format {bmp,jpg,png} specify the temporary resources format --temp-frame-quality [0-100] specify the temporary resources quality --keep-temp keep the temporary resources after processing
output creation: --output-image-quality [0-100] specify the image quality which translates to the compression factor --output-video-encoder {libx264,libx265,libvpx-vp9,h264_nvenc,hevc_nvenc} specify the encoder use for the video compression --output-video-preset {ultrafast,superfast,veryfast,faster,fast,medium,slow,slower,veryslow} balance fast video processing and video file size --output-video-quality [0-100] specify the video quality which translates to the compression factor --output-video-resolution OUTPUT_VIDEO_RESOLUTION specify the video output resolution based on the target video --output-video-fps OUTPUT_VIDEO_FPS specify the video output fps based on the target video --skip-audio omit the audio from the target video
frame processors: --frame-processors FRAME_PROCESSORS [FRAME_PROCESSORS ...] load a single or multiple frame processors. (choices: face_debugger, face_enhancer, face_swapper, frame_enhancer, lip_syncer, ...) --face-debugger-items FACE_DEBUGGER_ITEMS [FACE_DEBUGGER_ITEMS ...] load a single or multiple frame processors (choices: bounding-box, landmark-5, landmark-68, face-mask, score, age, gender) --face-enhancer-model {codeformer,gfpgan_1.2,gfpgan_1.3,gfpgan_1.4,gpen_bfr_256,gpen_bfr_512,restoreformer_plus_plus} choose the model responsible for enhancing the face --face-enhancer-blend [0-100] blend the enhanced into the previous face --face-swapper-model {blendswap_256,inswapper_128,inswapper_128_fp16,simswap_256,simswap_512_unofficial,uniface_256} choose the model responsible for swapping the face --frame-enhancer-model {real_esrgan_x2plus,real_esrgan_x4plus,real_esrnet_x4plus} choose the model responsible for enhancing the frame --frame-enhancer-blend [0-100] blend the enhanced into the previous frame --lip-syncer-model {wav2lip_gan} choose the model responsible for syncing the lips
uis: --ui-layouts UI_LAYOUTS [UI_LAYOUTS ...] launch a single or multiple UI layouts (choices: benchmark, default, webcam, ...)
|