Merge pull request #3359 from lllyasviel/develop

Release v2.5.1

.github/ISSUE_TEMPLATE/bug_report.yaml

@@ -1,77 +0,0 @@
-name: Bug Report
-description: Describe a problem
-title: "[Bug]: "
-labels: ["bug", "triage"]
-body:
-  - type: markdown
-    attributes:
-      value: |
-        Thank you for taking the time to fill out this bug report form!
-  - type: checkboxes
-    id: prerequisites
-    attributes:
-      label: Prerequisites
-      description: Please make sure to troubleshoot yourself before continuing.
-      options:
-        - label: I have read the [Troubleshooting Guide](https://github.com/lllyasviel/Fooocus/blob/main/troubleshoot.md)
-          required: true
-        - label: I have checked that this is not a duplicate of an already existing [issue](https://github.com/lllyasviel/Fooocus/issues)
-          required: true
-  - type: textarea
-    id: description
-    attributes:
-      label: Describe the problem
-      description: Also tell us, what did you expect to happen?
-      placeholder: "A clear and concise description of what the bug is."
-    validations:
-      required: true
-  - type: textarea
-    id: logs
-    attributes:
-      label: Full console log output
-      description: Please copy and paste the **full** console log here. You will make our job easier if you give a **full** log. This will be automatically formatted into code, so no need for backticks.
-      render: shell
-    validations:
-      required: true
-  - type: textarea
-    id: version
-    attributes:
-      label: Version
-      description: What version of Fooocus are you using? (see browser tab title or console log)
-      placeholder: "Example: Fooocus 2.1.855"
-    validations:
-      required: true
-  - type: dropdown
-    id: hosting
-    attributes:
-      label: Where are you running Fooocus?
-      multiple: false
-      options:
-        - Locally
-        - Locally with virtualisation (e.g. Docker)
-        - Cloud (Gradio)
-        - Cloud (other)
-    validations:
-      required: true
-  - type: input
-    id: operating-system
-    attributes:
-      label: Operating System
-      description: What operating system are you using?
-      placeholder: "Example: Windows 10"
-  - type: dropdown
-    id: browsers
-    attributes:
-      label: What browsers are you seeing the problem on?
-      multiple: true
-      options:
-        - Chrome
-        - Firefox
-        - Microsoft Edge
-        - Safari
-        - other
-    validations:
-      required: true
-  - type: markdown
-    attributes:
-      value: "Thank you for completing our form!"

.github/ISSUE_TEMPLATE/feature_request.yaml

@@ -1,34 +0,0 @@
-name: Feature request
-description: Suggest an idea for this project
-title: "[Feature]: "
-labels: ["enhancement"]
-body:
-  - type: markdown
-    attributes:
-      value: |
-        Thank you for taking the time to fill out this feature request form!
-  - type: checkboxes
-    id: prerequisites
-    attributes:
-      label: Prerequisites
-      options:
-        - label: I have checked that this is not a duplicate of an already existing [feature request](https://github.com/lllyasviel/Fooocus/issues)
-          required: true
-  - type: textarea
-    id: relation-to-problem
-    attributes:
-      label: Is your feature request related to a problem? Please describe.
-      placeholder: "A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
-."
-    validations:
-      required: true
-  - type: textarea
-    id: description
-    attributes:
-      label: Describe the idea you'd like
-      placeholder: "A clear and concise description of what you want to happen."
-    validations:
-      required: true
-  - type: markdown
-    attributes:
-      value: "Thank you for completing our form!"

args_manager.py

@@ -17,7 +17,7 @@ args_parser.parser.add_argument("--disable-offload-from-vram", action="store_tru
 
 args_parser.parser.add_argument("--theme", type=str, help="launches the UI with light or dark theme", default=None)
 args_parser.parser.add_argument("--disable-image-log", action='store_true',
-                                help="Prevent writing images and logs to hard drive.")
+                                help="Prevent writing images and logs to the outputs folder.")
 
 args_parser.parser.add_argument("--disable-analytics", action='store_true',
                                 help="Disables analytics for Gradio.")
@@ -28,6 +28,9 @@ args_parser.parser.add_argument("--disable-metadata", action='store_true',
 args_parser.parser.add_argument("--disable-preset-download", action='store_true',
                                 help="Disables downloading models for presets", default=False)
 
+args_parser.parser.add_argument("--disable-enhance-output-sorting", action='store_true',
+                                help="Disables enhance output sorting for final image gallery.")
+
 args_parser.parser.add_argument("--enable-auto-describe-image", action='store_true',
                                 help="Enables automatic description of uov and enhance image when prompt is empty", default=False)
 

fooocus_colab.ipynb

@@ -8,7 +8,7 @@
    },
    "outputs": [],
    "source": [
-    "!pip install pygit2==1.12.2\n",
+    "!pip install pygit2==1.15.1\n",
     "%cd /content\n",
     "!git clone https://github.com/lllyasviel/Fooocus.git\n",
     "%cd /content/Fooocus\n",

fooocus_version.py

@@ -1 +1 @@
-version = '2.5.0-rc1'
+version = '2.5.1'

language/en.json

@@ -68,6 +68,9 @@
     "Read wildcards in order": "Read wildcards in order",
     "Black Out NSFW": "Black Out NSFW",
     "Use black image if NSFW is detected.": "Use black image if NSFW is detected.",
+    "Save only final enhanced image": "Save only final enhanced image",
+    "Save Metadata to Images": "Save Metadata to Images",
+    "Adds parameters to generated images allowing manual regeneration.": "Adds parameters to generated images allowing manual regeneration.",
     "\ud83d\udcda History Log": "\uD83D\uDCDA History Log",
     "Image Style": "Image Style",
     "Fooocus V2": "Fooocus V2",

launch.py

@@ -21,7 +21,6 @@ import fooocus_version
 from build_launcher import build_launcher
 from modules.launch_util import is_installed, run, python, run_pip, requirements_met, delete_folder_content
 from modules.model_loader import load_file_from_url
-from modules import config
 
 REINSTALL_ALL = False
 TRY_INSTALL_XFORMERS = False
@@ -86,6 +85,7 @@ if args.hf_mirror is not None :
     print("Set hf_mirror to:", args.hf_mirror)
 
 from modules import config
+from modules.hash_cache import init_cache
 os.environ["U2NET_HOME"] = config.path_inpaint
 
 os.environ['GRADIO_TEMP_DIR'] = config.temp_path
@@ -141,4 +141,7 @@ config.default_base_model_name, config.checkpoint_downloads = download_models(
     config.default_base_model_name, config.previous_default_models, config.checkpoint_downloads,
     config.embeddings_downloads, config.lora_downloads, config.vae_downloads)
 
+config.update_files()
+init_cache(config.model_filenames, config.paths_checkpoints, config.lora_filenames, config.paths_loras)
+
 from webui import *

modules/async_worker.py

@@ -9,7 +9,7 @@ patch_all()
 
 class AsyncTask:
     def __init__(self, args):
-        from modules.flags import Performance, MetadataScheme, ip_list, controlnet_image_count
+        from modules.flags import Performance, MetadataScheme, ip_list, controlnet_image_count, disabled
         from modules.util import get_enabled_loras
         from modules.config import default_max_lora_number
         import args_manager
@@ -95,6 +95,7 @@ class AsyncTask:
         self.inpaint_advanced_masking_checkbox = args.pop()
         self.invert_mask_checkbox = args.pop()
         self.inpaint_erode_or_dilate = args.pop()
+        self.save_final_enhanced_image_only = args.pop() if not args_manager.args.disable_image_log else False
         self.save_metadata_to_images = args.pop() if not args_manager.args.disable_metadata else False
         self.metadata_scheme = MetadataScheme(
             args.pop()) if not args_manager.args.disable_metadata else MetadataScheme.FOOOCUS
@@ -153,12 +154,14 @@ class AsyncTask:
                     enhance_inpaint_erode_or_dilate,
                     enhance_mask_invert
                 ])
-
+        self.should_enhance = self.enhance_checkbox and (self.enhance_uov_method != disabled.casefold() or len(self.enhance_ctrls) > 0)
+        self.images_to_enhance_count = 0
+        self.enhance_stats = {}
 
 async_tasks = []
 
 
-class EarlyReturnException:
+class EarlyReturnException(BaseException):
     pass
 
 
@@ -197,7 +200,6 @@ def worker():
     from modules.upscaler import perform_upscale
     from modules.flags import Performance
     from modules.meta_parser import get_metadata_parser
-    from modules.translator import translate2en
 
     pid = os.getpid()
     print(f'Started worker with PID {pid}')
@@ -278,7 +280,7 @@ def worker():
     def process_task(all_steps, async_task, callback, controlnet_canny_path, controlnet_cpds_path, current_task_id,
                      denoising_strength, final_scheduler_name, goals, initial_latent, steps, switch, positive_cond,
                      negative_cond, task, loras, tiled, use_expansion, width, height, base_progress, preparation_steps,
-                     total_count, show_intermediate_results):
+                     total_count, show_intermediate_results, persist_image=True):
         if async_task.last_stop is not False:
             ldm_patched.modules.model_management.interrupt_current_processing()
         if 'cn' in goals:
@@ -315,9 +317,8 @@ def worker():
         if modules.config.default_black_out_nsfw or async_task.black_out_nsfw:
             progressbar(async_task, current_progress, 'Checking for NSFW content ...')
             imgs = default_censor(imgs)
-        progressbar(async_task, current_progress,
-                    f'Saving image {current_task_id + 1}/{total_count} to system ...')
-        img_paths = save_and_log(async_task, height, imgs, task, use_expansion, width, loras)
+        progressbar(async_task, current_progress, f'Saving image {current_task_id + 1}/{total_count} to system ...')
+        img_paths = save_and_log(async_task, height, imgs, task, use_expansion, width, loras, persist_image)
         yield_result(async_task, img_paths, current_progress, async_task.black_out_nsfw, False,
                      do_not_show_finished_images=not show_intermediate_results or async_task.disable_intermediate_results)
 
@@ -333,7 +334,7 @@ def worker():
             async_task.adaptive_cfg
         )
 
-    def save_and_log(async_task, height, imgs, task, use_expansion, width, loras) -> list:
+    def save_and_log(async_task, height, imgs, task, use_expansion, width, loras, persist_image=True) -> list:
         img_paths = []
         for x in imgs:
             d = [('Prompt', 'prompt', task['log_positive_prompt']),
@@ -388,7 +389,7 @@ def worker():
             d.append(('Metadata Scheme', 'metadata_scheme',
                       async_task.metadata_scheme.value if async_task.save_metadata_to_images else async_task.save_metadata_to_images))
             d.append(('Version', 'version', 'Fooocus v' + fooocus_version.version))
-            img_paths.append(log(x, d, metadata_parser, async_task.output_format, task))
+            img_paths.append(log(x, d, metadata_parser, async_task.output_format, task, persist_image))
 
         return img_paths
 
@@ -959,7 +960,7 @@ def worker():
                         inpaint_engine, inpaint_respective_field, inpaint_strength,
                         prompt, negative_prompt, final_scheduler_name, goals, height, img, mask,
                         preparation_steps, steps, switch, tiled, total_count, use_expansion, use_style,
-                        use_synthetic_refiner, width, show_intermediate_results=True):
+                        use_synthetic_refiner, width, show_intermediate_results=True, persist_image=True):
         base_model_additional_loras = []
         inpaint_head_model_path = None
         inpaint_parameterized = inpaint_engine != 'None'  # inpaint_engine = None, improve detail
@@ -980,7 +981,7 @@ def worker():
                     progressbar(async_task, current_progress, 'Checking for NSFW content ...')
                     img = default_censor(img)
                 progressbar(async_task, current_progress, f'Saving image {current_task_id + 1}/{total_count} to system ...')
-                uov_image_path = log(img, d, output_format=async_task.output_format)
+                uov_image_path = log(img, d, output_format=async_task.output_format, persist_image=persist_image)
                 yield_result(async_task, uov_image_path, current_progress, async_task.black_out_nsfw, False,
                              do_not_show_finished_images=not show_intermediate_results or async_task.disable_intermediate_results)
                 return current_progress, img, prompt, negative_prompt
@@ -1014,7 +1015,8 @@ def worker():
                                                          final_scheduler_name, goals, initial_latent, steps, switch,
                                                          task_enhance['c'], task_enhance['uc'], task_enhance, loras,
                                                          tiled, use_expansion, width, height, current_progress,
-                                                         preparation_steps, total_count, show_intermediate_results)
+                                                         preparation_steps, total_count, show_intermediate_results,
+                                                         persist_image)
 
         del task_enhance['c'], task_enhance['uc']  # Save memory
         return current_progress, imgs[0], prompt, negative_prompt
@@ -1022,7 +1024,7 @@ def worker():
     def enhance_upscale(all_steps, async_task, base_progress, callback, controlnet_canny_path, controlnet_cpds_path,
                         current_task_id, denoising_strength, done_steps_inpainting, done_steps_upscaling, enhance_steps,
                         prompt, negative_prompt, final_scheduler_name, height, img, preparation_steps, switch, tiled,
-                        total_count, use_expansion, use_style, use_synthetic_refiner, width):
+                        total_count, use_expansion, use_style, use_synthetic_refiner, width, persist_image=True):
         # reset inpaint worker to prevent tensor size issues and not mix upscale and inpainting
         inpaint_worker.current_task = None
 
@@ -1040,7 +1042,7 @@ def worker():
                     controlnet_cpds_path, current_progress, current_task_id, denoising_strength, False,
                     'None', 0.0, 0.0, prompt, negative_prompt, final_scheduler_name,
                     goals_enhance, height, img, None, preparation_steps, steps, switch, tiled, total_count,
-                    use_expansion, use_style, use_synthetic_refiner, width)
+                    use_expansion, use_style, use_synthetic_refiner, width, persist_image=persist_image)
 
             except ldm_patched.modules.model_management.InterruptProcessingException:
                 if async_task.last_stop == 'skip':
@@ -1157,6 +1159,8 @@ def worker():
             current_progress += 1
             progressbar(async_task, current_progress, 'Image processing ...')
 
+        should_enhance = async_task.enhance_checkbox and (async_task.enhance_uov_method != flags.disabled.casefold() or len(async_task.enhance_ctrls) > 0)
+
         if 'vary' in goals:
             async_task.uov_input_image, denoising_strength, initial_latent, width, height, current_progress = apply_vary(
                 async_task, async_task.uov_method, denoising_strength, async_task.uov_input_image, switch,
@@ -1262,8 +1266,8 @@ def worker():
                 int(current_progress + async_task.callback_steps),
                 f'Sampling step {step + 1}/{total_steps}, image {current_task_id + 1}/{total_count} ...', y)])
 
-        should_enhance = async_task.enhance_checkbox and (async_task.enhance_uov_method != flags.disabled.casefold() or len(async_task.enhance_ctrls) > 0)
-        show_intermediate_results = len(tasks) > 1 or should_enhance
+        show_intermediate_results = len(tasks) > 1 or async_task.should_enhance
+        persist_image = not async_task.should_enhance or not async_task.save_final_enhanced_image_only
 
         for current_task_id, task in enumerate(tasks):
             progressbar(async_task, current_progress, f'Preparing task {current_task_id + 1}/{async_task.image_number} ...')
@@ -1276,7 +1280,8 @@ def worker():
                                                                  initial_latent, async_task.steps, switch, task['c'],
                                                                  task['uc'], task, loras, tiled, use_expansion, width,
                                                                  height, current_progress, preparation_steps,
-                                                                 async_task.image_number, show_intermediate_results)
+                                                                 async_task.image_number, show_intermediate_results,
+                                                                 persist_image)
 
                 current_progress = int(preparation_steps + (100 - preparation_steps) / float(all_steps) * async_task.steps * (current_task_id + 1))
                 images_to_enhance += imgs
@@ -1294,7 +1299,7 @@ def worker():
             execution_time = time.perf_counter() - execution_start_time
             print(f'Generating and saving time: {execution_time:.2f} seconds')
 
-        if not should_enhance:
+        if not async_task.should_enhance:
             print(f'[Enhance] Skipping, preconditions aren\'t met')
             stop_processing(async_task, processing_start_time)
             return
@@ -1303,9 +1308,14 @@ def worker():
 
         active_enhance_tabs = len(async_task.enhance_ctrls)
         should_process_enhance_uov = async_task.enhance_uov_method != flags.disabled.casefold()
+        enhance_uov_before = False
+        enhance_uov_after = False
         if should_process_enhance_uov:
             active_enhance_tabs += 1
+            enhance_uov_before = async_task.enhance_uov_processing_order == flags.enhancement_uov_before
+            enhance_uov_after = async_task.enhance_uov_processing_order == flags.enhancement_uov_after
         total_count = len(images_to_enhance) * active_enhance_tabs
+        async_task.images_to_enhance_count = len(images_to_enhance)
 
         base_progress = current_progress
         current_task_id = -1
@@ -1313,19 +1323,23 @@ def worker():
         done_steps_inpainting = 0
         enhance_steps, _, _, _ = apply_overrides(async_task, async_task.original_steps, height, width)
         exception_result = None
-        for img in images_to_enhance:
+        for index, img in enumerate(images_to_enhance):
+            async_task.enhance_stats[index] = 0
             enhancement_image_start_time = time.perf_counter()
 
             last_enhance_prompt = async_task.prompt
             last_enhance_negative_prompt = async_task.negative_prompt
 
-            if should_process_enhance_uov and async_task.enhance_uov_processing_order == flags.enhancement_uov_before:
+            if enhance_uov_before:
                 current_task_id += 1
+                persist_image = not async_task.save_final_enhanced_image_only or active_enhance_tabs == 0
                 current_task_id, done_steps_inpainting, done_steps_upscaling, img, exception_result = enhance_upscale(
                     all_steps, async_task, base_progress, callback, controlnet_canny_path, controlnet_cpds_path,
                     current_task_id, denoising_strength, done_steps_inpainting, done_steps_upscaling, enhance_steps,
                     async_task.prompt, async_task.negative_prompt, final_scheduler_name, height, img, preparation_steps,
-                    switch, tiled, total_count, use_expansion, use_style, use_synthetic_refiner, width)
+                    switch, tiled, total_count, use_expansion, use_style, use_synthetic_refiner, width, persist_image)
+                async_task.enhance_stats[index] += 1
+
                 if exception_result == 'continue':
                     continue
                 elif exception_result == 'break':
@@ -1337,6 +1351,8 @@ def worker():
                 current_progress = int(base_progress + (100 - preparation_steps) / float(all_steps) * (done_steps_upscaling + done_steps_inpainting))
                 progressbar(async_task, current_progress, f'Preparing enhancement {current_task_id + 1}/{total_count} ...')
                 enhancement_task_start_time = time.perf_counter()
+                is_last_enhance_for_image = (current_task_id + 1) % active_enhance_tabs == 0 and not enhance_uov_after
+                persist_image = not async_task.save_final_enhanced_image_only or is_last_enhance_for_image
 
                 extras = {}
                 if enhance_mask_model == 'sam':
@@ -1367,13 +1383,13 @@ def worker():
                     async_task.yields.append(['preview', (current_progress, 'Loading ...', mask)])
                     yield_result(async_task, mask, current_progress, async_task.black_out_nsfw, False,
                                  async_task.disable_intermediate_results)
+                    async_task.enhance_stats[index] += 1
 
                 print(f'[Enhance] {dino_detection_count} boxes detected')
                 print(f'[Enhance] {sam_detection_count} segments detected in boxes')
                 print(f'[Enhance] {sam_detection_on_mask_count} segments applied to mask')
 
-                if enhance_mask_model == 'sam' and (
-                        dino_detection_count == 0 or not async_task.debugging_dino and sam_detection_on_mask_count == 0):
+                if enhance_mask_model == 'sam' and (dino_detection_count == 0 or not async_task.debugging_dino and sam_detection_on_mask_count == 0):
                     print(f'[Enhance] No "{enhance_mask_dino_prompt_text}" detected, skipping')
                     continue
 
@@ -1386,7 +1402,8 @@ def worker():
                         enhance_inpaint_engine, enhance_inpaint_respective_field, enhance_inpaint_strength,
                         enhance_prompt, enhance_negative_prompt, final_scheduler_name, goals_enhance, height, img, mask,
                         preparation_steps, enhance_steps, switch, tiled, total_count, use_expansion, use_style,
-                        use_synthetic_refiner, width)
+                        use_synthetic_refiner, width, persist_image=persist_image)
+                    async_task.enhance_stats[index] += 1
 
                     if (should_process_enhance_uov and async_task.enhance_uov_processing_order == flags.enhancement_uov_after
                             and async_task.enhance_uov_prompt_type == flags.enhancement_uov_prompt_type_last_filled):
@@ -1413,14 +1430,18 @@ def worker():
             if exception_result == 'break':
                 break
 
-            if should_process_enhance_uov and async_task.enhance_uov_processing_order == flags.enhancement_uov_after:
+            if enhance_uov_after:
                 current_task_id += 1
+                # last step in enhance, always save
+                persist_image = True
                 current_task_id, done_steps_inpainting, done_steps_upscaling, img, exception_result = enhance_upscale(
                     all_steps, async_task, base_progress, callback, controlnet_canny_path, controlnet_cpds_path,
                     current_task_id, denoising_strength, done_steps_inpainting, done_steps_upscaling, enhance_steps,
                     last_enhance_prompt, last_enhance_negative_prompt, final_scheduler_name, height, img,
                     preparation_steps, switch, tiled, total_count, use_expansion, use_style, use_synthetic_refiner,
-                    width)
+                    width, persist_image)
+                async_task.enhance_stats[index] += 1
+                
                 if exception_result == 'continue':
                     continue
                 elif exception_result == 'break':

modules/config.py

@@ -7,7 +7,6 @@ import args_manager
 import tempfile
 import modules.flags
 import modules.sdxl_styles
-from modules.hash_cache import init_cache
 
 from modules.model_loader import load_file_from_url
 from modules.extra_utils import makedirs_with_log, get_files_from_folder, try_eval_env_var
@@ -563,6 +562,12 @@ default_black_out_nsfw = get_config_item_or_set_default(
     validator=lambda x: isinstance(x, bool),
     expected_type=bool
 )
+default_save_only_final_enhanced_image = get_config_item_or_set_default(
+    key='default_save_only_final_enhanced_image',
+    default_value=False,
+    validator=lambda x: isinstance(x, bool),
+    expected_type=bool
+)
 default_save_metadata_to_images = get_config_item_or_set_default(
     key='default_save_metadata_to_images',
     default_value=False,
@@ -889,7 +894,3 @@ def downloading_sam_vit_h():
         file_name='sam_vit_h_4b8939.pth'
     )
     return os.path.join(path_sam, 'sam_vit_h_4b8939.pth')
-
-
-update_files()
-init_cache(model_filenames, paths_checkpoints, lora_filenames, paths_loras)

modules/hash_cache.py

@@ -4,8 +4,7 @@ from concurrent.futures import ThreadPoolExecutor
 from multiprocessing import cpu_count
 
 import args_manager
-from modules.util import get_file_from_folder_list
-from modules.util import sha256, HASH_SHA256_LENGTH
+from modules.util import sha256, HASH_SHA256_LENGTH, get_file_from_folder_list
 
 hash_cache_filename = 'hash_cache.txt'
 hash_cache = {}

modules/meta_parser.py

@@ -9,7 +9,6 @@ from PIL import Image
 import fooocus_version
 import modules.config
 import modules.sdxl_styles
-from modules import hash_cache
 from modules.flags import MetadataScheme, Performance, Steps
 from modules.flags import SAMPLERS, CIVITAI_NO_KARRAS
 from modules.hash_cache import sha256_from_cache
@@ -605,9 +604,8 @@ def get_metadata_parser(metadata_scheme: MetadataScheme) -> MetadataParser:
             raise NotImplementedError
 
 
-def read_info_from_image(filepath) -> tuple[str | None, MetadataScheme | None]:
-    with Image.open(filepath) as image:
-        items = (image.info or {}).copy()
+def read_info_from_image(file) -> tuple[str | None, MetadataScheme | None]:
+    items = (file.info or {}).copy()
 
     parameters = items.pop('parameters', None)
     metadata_scheme = items.pop('fooocus_scheme', None)
@@ -616,7 +614,7 @@ def read_info_from_image(filepath) -> tuple[str | None, MetadataScheme | None]:
     if parameters is not None and is_json(parameters):
         parameters = json.loads(parameters)
     elif exif is not None:
-        exif = image.getexif()
+        exif = file.getexif()
         # 0x9286 = UserComment
         parameters = exif.get(0x9286, None)
         # 0x927C = MakerNote

modules/private_logger.py

@@ -21,8 +21,8 @@ def get_current_html_path(output_format=None):
     return html_name
 
 
-def log(img, metadata, metadata_parser: MetadataParser | None = None, output_format=None, task=None) -> str:
-    path_outputs = modules.config.temp_path if args_manager.args.disable_image_log else modules.config.path_outputs
+def log(img, metadata, metadata_parser: MetadataParser | None = None, output_format=None, task=None, persist_image=True) -> str:
+    path_outputs = modules.config.temp_path if args_manager.args.disable_image_log or not persist_image else modules.config.path_outputs
     output_format = output_format if output_format else modules.config.default_output_format
     date_string, local_temp_filename, only_name = generate_temp_filename(folder=path_outputs, extension=output_format)
     os.makedirs(os.path.dirname(local_temp_filename), exist_ok=True)

modules/style_sorter.py

@@ -37,7 +37,6 @@ def sort_styles(selected):
     global all_styles
     unselected = [y for y in all_styles if y not in selected]
     sorted_styles = selected + unselected
-    """
     try:
         with open('sorted_styles.json', 'wt', encoding='utf-8') as fp:
             json.dump(sorted_styles, fp, indent=4)
@@ -45,7 +44,6 @@ def sort_styles(selected):
         print('Write style sorting failed.')
         print(e)
     all_styles = sorted_styles
-    """
     return gr.CheckboxGroup.update(choices=sorted_styles)
 
 

modules/translator.py

@@ -1,15 +0,0 @@
-import translators
-from functools import lru_cache
-
-@lru_cache(maxsize=32, typed=False)
-def translate2en(text, element):
-    if not text:
-        return text
-
-    try:
-        result = translators.translate_text(text,to_language='en')
-        print(f'[Parameters] Translated {element}: {result}')
-        return result
-    except Exception as e:
-        print(f'[Parameters] Error during translation of {element}: {e}')
-        return text

readme.md

@@ -71,7 +71,7 @@ Fooocus also developed many "fooocus-only" features for advanced users to get pe
 
 You can directly download Fooocus with:
 
-**[>>> Click here to download <<<](https://github.com/lllyasviel/Fooocus/releases/download/release/Fooocus_win64_2-1-831.7z)**
+**[>>> Click here to download <<<](https://github.com/lllyasviel/Fooocus/releases/download/v2.5.0/Fooocus_win64_2-5-0.7z)**
 
 After you download the file, please uncompress it and then run the "run.bat".
 
@@ -371,15 +371,14 @@ entry_with_update.py  [-h] [--listen [IP]] [--port PORT]
                       [--hf-mirror HF_MIRROR]
                       [--external-working-path PATH [PATH ...]]
                       [--output-path OUTPUT_PATH]
-                      [--temp-path TEMP_PATH]
-                      [--cache-path CACHE_PATH] [--in-browser]
-                      [--disable-in-browser]
+                      [--temp-path TEMP_PATH] [--cache-path CACHE_PATH]
+                      [--in-browser] [--disable-in-browser]
                       [--gpu-device-id DEVICE_ID]
                       [--async-cuda-allocation | --disable-async-cuda-allocation]
                       [--disable-attention-upcast]
                       [--all-in-fp32 | --all-in-fp16]
                       [--unet-in-bf16 | --unet-in-fp16 | --unet-in-fp8-e4m3fn | --unet-in-fp8-e5m2]
-                      [--vae-in-fp16 | --vae-in-fp32 | --vae-in-bf16]   
+                      [--vae-in-fp16 | --vae-in-fp32 | --vae-in-bf16]
                       [--vae-in-cpu]
                       [--clip-in-fp8-e4m3fn | --clip-in-fp8-e5m2 | --clip-in-fp16 | --clip-in-fp32]
                       [--directml [DIRECTML_DEVICE]]
@@ -387,30 +386,65 @@ entry_with_update.py  [-h] [--listen [IP]] [--port PORT]
                       [--preview-option [none,auto,fast,taesd]]
                       [--attention-split | --attention-quad | --attention-pytorch]
                       [--disable-xformers]
-                      [--always-gpu | --always-high-vram | --always-normal-vram |
-                      --always-low-vram | --always-no-vram | --always-cpu [CPU_NUM_THREADS]]
+                      [--always-gpu | --always-high-vram | --always-normal-vram | --always-low-vram | --always-no-vram | --always-cpu [CPU_NUM_THREADS]]
                       [--always-offload-from-vram]
-                      [--pytorch-deterministic] [--disable-server-log]  
-                      [--debug-mode] [--is-windows-embedded-python]     
-                      [--disable-server-info] [--multi-user] [--share]  
-                      [--preset PRESET] [--disable-preset-selection]    
+                      [--pytorch-deterministic] [--disable-server-log]
+                      [--debug-mode] [--is-windows-embedded-python]
+                      [--disable-server-info] [--multi-user] [--share]
+                      [--preset PRESET] [--disable-preset-selection]
                       [--language LANGUAGE]
-                      [--disable-offload-from-vram] [--theme THEME]     
-                      [--disable-image-log] [--disable-analytics]       
-                      [--disable-metadata] [--disable-preset-download]  
-                      [--enable-describe-uov-image]
+                      [--disable-offload-from-vram] [--theme THEME]
+                      [--disable-image-log] [--disable-analytics]
+                      [--disable-metadata] [--disable-preset-download]
+                      [--disable-enhance-output-sorting]
+                      [--enable-auto-describe-image]
                       [--always-download-new-model]
+                      [--rebuild-hash-cache [CPU_NUM_THREADS]]
 ```
 
+## Inline Prompt Features
+
+### Wildcards
+Example prompt: `__color__ flower`
+
+Processed for positive and negative prompt.
+
+Selects a random wildcard from a predefined list of options, in this case the `wildcards/color.txt` file. 
+The wildcard will be replaced with a random color (randomness based on seed). 
+You can also disable randomness and process a wildcard file from top to bottom by enabling the checkbox `Read wildcards in order` in Developer Debug Mode.
+
+Wildcards can be nested and combined, and multiple wildcards can be used in the same prompt (example see `wildcards/color_flower.txt`).
+
+### Array Processing
+Example prompt: `[[red, green, blue]] flower`
+
+Processed only for positive prompt.
+
+Processes the array from left to right, generating a separate image for each element in the array. In this case 3 images would be generated, one for each color.
+Increase the image number to 3 to generate all 3 variants.
+
+Arrays can not be nested, but multiple arrays can be used in the same prompt.
+Does support inline LoRAs as array elements!
+
+### Inline LoRAs
+
+Example prompt: `flower <lora:sunflowers:1.2>`
+
+Processed only for positive prompt.
+
+Applies a LoRA to the prompt. The LoRA file must be located in the `models/loras` directory.
+
+
 ## Advanced Features
 
 [Click here to browse the advanced features.](https://github.com/lllyasviel/Fooocus/discussions/117)
 
+## Forks
 Fooocus also has many community forks, just like SD-WebUI's [vladmandic/automatic](https://github.com/vladmandic/automatic) and [anapnoe/stable-diffusion-webui-ux](https://github.com/anapnoe/stable-diffusion-webui-ux), for enthusiastic users who want to try!
 
 | Fooocus' forks |
 | - |
-| [fenneishi/Fooocus-Control](https://github.com/fenneishi/Fooocus-Control) </br>[runew0lf/RuinedFooocus](https://github.com/runew0lf/RuinedFooocus) </br> [MoonRide303/Fooocus-MRE](https://github.com/MoonRide303/Fooocus-MRE) </br> [metercai/SimpleSDXL](https://github.com/metercai/SimpleSDXL) </br> and so on ... |
+| [fenneishi/Fooocus-Control](https://github.com/fenneishi/Fooocus-Control) </br>[runew0lf/RuinedFooocus](https://github.com/runew0lf/RuinedFooocus) </br> [MoonRide303/Fooocus-MRE](https://github.com/MoonRide303/Fooocus-MRE) </br> [metercai/SimpleSDXL](https://github.com/metercai/SimpleSDXL) </br> [mashb1t/Fooocus](https://github.com/mashb1t/Fooocus) </br> and so on ... |
 
 See also [About Forking and Promotion of Forks](https://github.com/lllyasviel/Fooocus/discussions/699).
 

requirements_versions.txt

@@ -1,22 +1,24 @@
-torchsde==0.2.5
-einops==0.4.1
-transformers==4.30.2
-safetensors==0.3.1
-accelerate==0.21.0
-pyyaml==6.0
-Pillow==9.2.0
-scipy==1.9.3
-tqdm==4.65.0
-psutil==5.9.5
-pytorch_lightning==1.9.4
-omegaconf==2.2.3
+torchsde==0.2.6
+einops==0.8.0
+transformers==4.42.4
+safetensors==0.4.3
+accelerate==0.32.1
+pyyaml==6.0.1
+pillow==10.4.0
+scipy==1.14.0
+tqdm==4.66.4
+psutil==6.0.0
+pytorch_lightning==2.3.3
+omegaconf==2.3.0
 gradio==3.41.2
-pygit2==1.12.2
-opencv-contrib-python==4.8.0.74
-httpx==0.24.1
-onnxruntime==1.16.3
-timm==0.9.2
-translators==5.9.2
+pygit2==1.15.1
+opencv-contrib-python-headless==4.10.0.84
+httpx==0.27.0
+onnxruntime==1.18.1
+timm==1.0.7
+numpy==1.26.4
+tokenizers==0.19.1
+packaging==24.1
 rembg==2.0.57
 groundingdino-py==0.4.0
 segment_anything==1.0

update_log.md

@@ -1,10 +1,28 @@
-# [2.5.0-rc1](https://github.com/lllyasviel/Fooocus/releases/tag/v2.5.0-rc1)
+# [2.5.1](https://github.com/lllyasviel/Fooocus/releases/tag/v2.5.1)
 
+* Update download URL in readme
+* Increase speed of metadata loading
+* Fix reading of metadata from jpeg, jpg and webp (exif)
+* Fix debug preprocessor
+* Update attributes and add inline prompt features section to readme
+* Add checkbox, config and handling for saving only the final enhanced image. Use config `default_save_only_final_enhanced_image`, default False.
+* Add sorting of final images when enhanced is enabled. Use argument `--disable-enhance-output-sorting` to disable.
+
+# [2.5.0](https://github.com/lllyasviel/Fooocus/releases/tag/v2.5.0)
+
+This version includes various package updates. If the auto-update doesn't work you can do one of the following:
+1. Open a terminal in the Fooocus folder (location of config.txt) and run `git pull`
+2. Update packages
+   - Windows (installation through zip file): open a terminal in the Fooocus folder (location of config.txt) `..\python_embeded\python.exe -m pip install -r .\requirements_versions.txt` (Windows using embedded python, installation method zip file) or download Fooocus again (zip file attached to this release)
+   - other: manually update the packages using `python.exe -m pip install -r requirements_versions.txt` or use the docker image
+
+---
+
+* Update python dependencies, add segment_anything
 * Add enhance feature, which offers easy image refinement steps (similar to adetailer, but based on dynamic image detection instead of specific mask detection models). See [documentation](https://github.com/lllyasviel/Fooocus/discussions/3281).
 * Rewrite async worker code, make code much more reusable to allow iterations and improve reusability
 * Improve GroundingDINO and SAM image masking
 * Fix inference tensor version counter tracking issue for GroundingDINO after using Enhance (see [discussion](https://github.com/lllyasviel/Fooocus/discussions/3213))
-* Update python dependencies, add segment_anything
 * Move checkboxes Enable Mask Upload and Invert Mask When Generating from Developer Debug Mode to Inpaint Or Outpaint
 * Add persistent model cache for metadata. Use `--rebuild-hash-cache X` (X = int, number of CPU cores, default all) to manually rebuild the cache for all non-cached hashes
 * Rename `--enable-describe-uov-image` to `--enable-auto-describe-image`, now also works for enhance image upload

webui.py

@@ -73,6 +73,9 @@ def generate_clicked(task: worker.AsyncTask):
                     gr.update(visible=True, value=product), \
                     gr.update(visible=False)
             if flag == 'finish':
+                if not args_manager.args.disable_enhance_output_sorting:
+                    product = sort_enhance_images(product, task)
+
                 yield gr.update(visible=False), \
                     gr.update(visible=False), \
                     gr.update(visible=False), \
@@ -90,6 +93,25 @@ def generate_clicked(task: worker.AsyncTask):
     return
 
 
+def sort_enhance_images(images, task):
+    if not task.should_enhance or len(images) <= task.images_to_enhance_count:
+        return images
+
+    sorted_images = []
+    walk_index = task.images_to_enhance_count
+
+    for index, enhanced_img in enumerate(images[:task.images_to_enhance_count]):
+        sorted_images.append(enhanced_img)
+        if index not in task.enhance_stats:
+            continue
+        target_index = walk_index + task.enhance_stats[index]
+        if walk_index < len(images) and target_index <= len(images):
+            sorted_images += images[walk_index:target_index]
+        walk_index += task.enhance_stats[index]
+
+    return sorted_images
+
+
 def inpaint_mode_change(mode, inpaint_engine_version):
     assert mode in modules.flags.inpaint_options
 
@@ -339,12 +361,12 @@ with shared.gradio_root:
 
                     with gr.TabItem(label='Metadata') as metadata_tab:
                         with gr.Column():
-                            metadata_input_image = grh.Image(label='For images created by Fooocus', source='upload', type='filepath')
+                            metadata_input_image = grh.Image(label='For images created by Fooocus', source='upload', type='pil')
                             metadata_json = gr.JSON(label='Metadata')
                             metadata_import_button = gr.Button(value='Apply Metadata')
 
-                        def trigger_metadata_preview(filepath):
-                            parameters, metadata_scheme = modules.meta_parser.read_info_from_image(filepath)
+                        def trigger_metadata_preview(file):
+                            parameters, metadata_scheme = modules.meta_parser.read_info_from_image(file)
 
                             results = {}
                             if parameters is not None:
@@ -748,6 +770,10 @@ with shared.gradio_root:
                                               inputs=black_out_nsfw, outputs=disable_preview, queue=False,
                                               show_progress=False)
 
+                        if not args_manager.args.disable_image_log:
+                            save_final_enhanced_image_only = gr.Checkbox(label='Save only final enhanced image',
+                                                                         value=modules.config.default_save_only_final_enhanced_image)
+
                         if not args_manager.args.disable_metadata:
                             save_metadata_to_images = gr.Checkbox(label='Save Metadata to Images', value=modules.config.default_save_metadata_to_images,
                                                                   info='Adds parameters to generated images allowing manual regeneration.')
@@ -860,24 +886,6 @@ with shared.gradio_root:
                 refresh_files.click(refresh_files_clicked, [], refresh_files_output + lora_ctrls,
                                     queue=False, show_progress=False)
 
-            with gr.Tab(label='Audio'):
-                play_notification = gr.Checkbox(label='Play notification after rendering', value=False)
-                notification_file = 'notification.mp3'
-                if os.path.exists(notification_file):
-                    notification = gr.State(value=notification_file)
-                    notification_input = gr.Audio(label='Notification', interactive=True, elem_id='audio_notification', visible=False, show_edit_button=False)
-
-                    def play_notification_checked(r, notification):
-                        return gr.update(visible=r, value=notification if r else None)
-
-                    def notification_input_changed(notification_input, notification):
-                        if notification_input:
-                            notification = notification_input
-                        return notification
-
-                    play_notification.change(fn=play_notification_checked, inputs=[play_notification, notification], outputs=[notification_input], queue=False)
-                    notification_input.change(fn=notification_input_changed, inputs=[notification_input, notification], outputs=[notification], queue=False)
-
         state_is_generating = gr.State(False)
 
         load_data_outputs = [advanced_checkbox, image_number, prompt, negative_prompt, style_selections,
@@ -987,6 +995,9 @@ with shared.gradio_root:
         ctrls += freeu_ctrls
         ctrls += inpaint_ctrls
 
+        if not args_manager.args.disable_image_log:
+            ctrls += [save_final_enhanced_image_only]
+
         if not args_manager.args.disable_metadata:
             ctrls += [save_metadata_to_images, metadata_scheme]
 
@@ -1013,8 +1024,8 @@ with shared.gradio_root:
 
         load_parameter_button.click(modules.meta_parser.load_parameter_button_click, inputs=[prompt, state_is_generating, inpaint_mode], outputs=load_data_outputs, queue=False, show_progress=False)
 
-        def trigger_metadata_import(filepath, state_is_generating):
-            parameters, metadata_scheme = modules.meta_parser.read_info_from_image(filepath)
+        def trigger_metadata_import(file, state_is_generating):
+            parameters, metadata_scheme = modules.meta_parser.read_info_from_image(file)
             if parameters is None:
                 print('Could not find metadata in the image!')
                 parsed_parameters = {}
@@ -1045,6 +1056,11 @@ with shared.gradio_root:
                                     progress_html, progress_window, progress_gallery, gallery],
                            queue=False)
 
+        for notification_file in ['notification.ogg', 'notification.mp3']:
+            if os.path.exists(notification_file):
+                gr.Audio(interactive=False, value=notification_file, elem_id='audio_notification', visible=False)
+                break
+
         def trigger_describe(mode, img):
             if mode == flags.desc_type_photo:
                 from extras.interrogate import default_interrogator as default_interrogator_photo