Refactor/remove face restoration #4637
Open
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Remove all vendored face restoration code that is no longer maintained: - modules/postprocess/codeformer_model.py, codeformer_arch.py, vqgan_arch.py - modules/postprocess/gfpgan_model.py, restorer.py - modules/face_restoration.py (base class and dispatcher) - scripts/postprocessing_codeformer.py, postprocessing_gfpgan.py - modules/facelib/ (vendored face detection/parsing library) These were the only two backends registered in shared.face_restorers, making the entire face restoration infrastructure dead code.
- Remove CodeFormer/GFPGAN import and setup from webui.py initialize() - Remove face_restorers list, codeformer/gfpgan model path settings, and face restore UI settings section from shared.py - Remove restore_faces parameter from StableDiffusionProcessing - Remove face_restoration import and restore_faces processing block from processing.py
- Remove /sdapi/v1/face-restorers route from api.py - Remove get_restorers() function from endpoints.py - Remove gfpgan_visibility, codeformer_visibility, codeformer_weight fields from ReqProcess model - Remove GFPGAN and CodeFormer entries from run_extras() signature and create_args_for_run dict in postprocessing.py
- Remove codeformer, restoreformer, GFPGANv1.4, and GPEN-BFR ONNX model URLs from the predefined list - Remove the .fp16 ONNX restorer code path that bypassed detailer processing to run face restoration directly
- Remove gfpgan/codeformer face template lines from cli/generate.py - Remove gfpgan_visibility, codeformer_visibility, codeformer_weight from cli/generate.json upscale config - Simplify cli/process.py upscale_restore_image() to remove the restore path and codeformer parameters - Remove codeformer/gfpgan special cases from xyz_grid_shared.py apply_detailer(), keep generic boolean parsing - Remove p.restore_faces assignment from xyz_grid_on.py
- Remove GFPGAN pip install from installer.py optional requirements - Remove 'gfpgan' from modules_to_remove cleanup list in launch.py - Remove --codeformer-models-path and --gfpgan-models-path CLI args - Remove GFPGAN model directory migration from modelloader.py
- Remove GFPGAN and CodeFormer sections from Modern UI extras template - Remove CodeFormer S-Lab license block from licenses.html - Update Postprocessing hint in locale_en.json - Remove completed TODO items for CodeFormer/GFPGAN removal
- Change AxisOption type from str to bool with [False, True] choices - Simplify apply_detailer() to accept bool directly - Fix log message from "face-restore" to "detailer"
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Remove CodeFormer and GFPGAN face restoration backends, which were the only two backends registered in shared.face_restorers. Their removal makes the entire face restoration infrastructure dead code, so this also cleans up all associated plumbing: the base class/dispatcher, vendored facelib library, ONNX face restorer helper, processing pipeline integration, API endpoints, CLI tools, settings, and UI references.
The YOLO-based detailer system is unaffected.
Notes
Environment and Testing