HighRes-Fix Script Node Documentation

Overview

The HighRes-Fix Script Node in the Efficiency Nodes collection for ComfyUI is designed to upscale images generated by other nodes within a workflow. The node provides users with several upscaling methods, including both latent and pixel-based approaches, to enhance the resolution and detail of the generated images. It supports various configurations to suit different use cases and preferences.

Features

• Multiple Upscaling Types: Offers latent, pixel, and combined upscaling methods to improve image resolution.
• Integration with Existing Models: Out-of-the-box support for popular neural network latent upscalers.
• ControlNet Support: Enables ControlNet-guided latent upscaling when paired with the necessary plugin.
• Offline and Online Model Usage: Supports pulling required files from the Hugging Face Hub by default while allowing offline usage by locally storing models.

Inputs

• Upscale Type: Select between "latent," "pixel," or "both," depending on the desired upscaling method.
• Hires Checkpoint Name: Specify whether to use the same model checkpoint or a different one for upscaling.
• Latent Upscaler: Choose from available latent upscaling methods.
• Pixel Upscaler: Select a model for pixel-based upscaling.
• Upscale By: A factor to multiply the original image size by during upscaling.
• Use Same Seed: Choose whether to use the same random seed for consistency.
• Seed: An integer seed for randomness, affecting reproducibility.
• Hires Steps: The number of steps for the high-resolution pass.
• Denoise: A factor controlling the amount of denoising applied.
• Iterations: The number of upscaling iterations to apply.
• Use ControlNet: Boolean option to enable ControlNet guidance.
• ControlNet Name: Specify the ControlNet model to use.
• Strength: Set the strength of ControlNet's effect.
• Preprocessor: An optional preprocessor for preparing images for ControlNet.
• Include Preprocessor Images: Boolean to include images produced by the preprocessor.

Outputs

• Script: A modified script that can be connected to other nodes in ComfyUI to upscale images based on the defined parameters.

Usage in Workflows

In ComfyUI workflows, the HighRes-Fix Script Node is typically used in conjunction with a sampling node like the KSampler to generate an initial image, which is then processed to enhance its quality and resolution. This node can be particularly useful in pipelines where a higher resolution is desired without sacrificing detail and without rerunning the entire sampling process at a higher resolution.

By integrating ControlNet, users can further guide the upscaling process to adhere to certain visual constraints or styles, making it a powerful tool for custom and quality-sensitive rendering processes.

Special Features and Considerations

• Neural Network Latent Upscalers: The node integrates well with models such as Ttl's ComfyUi_NNLatentUpscale and City96's SD-Latent-Upscaler, providing robust upscaling methodologies.
• ControlNet Integration: For workflows utilizing ControlNet, ensure the required plugins are installed for seamless functionality.
• Local Model Storage: Users with unreliable internet connections can opt to download models offline for consistent access and performance.