Final rename for everything

hyperswap/README.md

@@ -0,0 +1,160 @@
+HyperSwap
+=========
+
+> Hyper accurate face swapping for everyone.
+
+![License](https://img.shields.io/badge/license-ResearchRAIL--MS-red)
+
+
+Preview
+-------
+
+![Preview](https://raw.githubusercontent.com/facefusion/facefusion-labs/master/.github/previews/face_swapper.png?sanitize=true)
+
+
+Installation
+------------
+
+```
+pip install -r requirements.txt
+```
+
+
+Setup
+-----
+
+This `config.ini` utilizes the VGGFace2 dataset to train the HyperSwap model.
+
+```
+[training.dataset]
+file_pattern = .datasets/vggface2/**/*.jpg
+warp_template = vggfacehq_256_to_arcface_128_v2
+transform_size = 256
+batch_mode = equal
+batch_ratio = 0.2
+```
+
+```
+[training.loader]
+batch_size = 8
+num_workers = 8
+split_ratio = 0.9995
+```
+
+```
+[training.model]
+generator_embedder_path = .models/blendface.pt
+loss_embedder_path = .models/arcface.pt
+gazer_path = .models/gazer.pt
+face_masker_path = .models/face_masker.pt
+```
+
+```
+[training.model.generator]
+source_channels = 512
+output_channels = 4096
+output_size = 256
+num_blocks = 2
+```
+
+```
+[training.model.discriminator]
+input_channels = 3
+num_filters = 64
+num_layers = 5
+num_discriminators = 3
+kernel_size = 4
+```
+
+```
+[training.model.masker]
+input_channels = 67
+output_channels = 1
+num_filters = 16
+```
+
+```
+[training.losses]
+adversarial_weight = 1.0
+cycle_weight = 1.0
+feature_weight = 10.0
+reconstruction_weight = 10.0
+identity_weight = 20.0
+gaze_weight = 0.05
+mask_weight = 5.0
+```
+
+```
+[training.trainer]
+accumulate_size = 4
+learning_rate = 0.0004
+max_epochs = 50
+strategy = auto
+precision = 16-mixed
+logger_path = .logs
+logger_name = hyperswap
+preview_frequency = 100
+```
+
+```
+[training.output]
+directory_path = .outputs
+file_pattern = hyperswap_{epoch}_{step}
+resume_path = .outputs/last.ckpt
+```
+
+```
+[exporting]
+directory_path = .exports
+source_path = .outputs/last.ckpt
+target_path = .exports/face_swapper.onnx
+target_size = 256
+ir_version = 10
+opset_version = 15
+precision = full
+```
+
+```
+[inferencing]
+generator_path = .outputs/last.ckpt
+embedder_path = .models/arcface.pt
+source_path = .assets/source.jpg
+target_path = .assets/target.jpg
+output_path = .outputs/output.jpg
+```
+
+
+Training
+--------
+
+Train the model.
+
+```
+python train.py
+```
+
+Launch the TensorBoard to monitor the training.
+
+```
+tensorboard --logdir=.logs
+```
+
+
+Exporting
+---------
+
+Export the model to ONNX.
+
+```
+python export.py
+```
+
+
+Inferencing
+-----------
+
+Inference the model.
+
+```
+python infer.py
+```