ComfyUI Node: Image Save with Prompt (WLSH)

Image Save with Prompt (WLSH):

The Image Save with Prompt (WLSH) node is designed to streamline the process of saving generated images along with their associated metadata, such as prompts, model names, and seeds. This node is particularly useful for AI artists who want to keep a detailed record of the parameters used to create each image, ensuring reproducibility and easy reference. By automatically generating filenames and comments based on the provided metadata, this node helps maintain an organized workflow and saves time. Additionally, it can create necessary directories if they do not exist, making the saving process seamless and error-free.

Image Save with Prompt (WLSH) Input Parameters:

images

This parameter accepts the images you want to save. It is a required input and should be a list of image objects generated by your AI model.

positive

This parameter is used to input the positive prompt associated with the image. It helps in documenting the creative input that led to the image generation. The default value is "unknown".

negative

This parameter is used to input the negative prompt associated with the image. It helps in documenting any constraints or exclusions applied during the image generation. The default value is "unknown".

seed

This parameter is used to input the seed value used during the image generation. It is crucial for reproducibility, allowing you to recreate the exact same image. The default value is -1.

modelname

This parameter is used to input the name of the model used to generate the image. It helps in keeping track of which model produced which image, especially useful when working with multiple models. The default value is "unknown".

counter

This parameter is used to input a counter value that can be part of the filename. It helps in differentiating between multiple images saved in a sequence. The default value is 0.

filename

This parameter is used to input a custom filename for the saved image. If left empty, the filename will be automatically generated based on other parameters like seed, modelname, and counter.

path

This parameter is used to input the directory path where the image will be saved. If the specified path does not exist, it will be created automatically. The default value is an empty string, which means the image will be saved in the default output directory.

time_format

This parameter is used to input the format for the timestamp that can be included in the filename. It follows the Python datetime format codes. The default value is "%Y-%m-%d-%H%M%S".

extension

This parameter is used to input the file extension for the saved image. Common options include 'png' and 'jpg'. The default value is 'png'.

quality

This parameter is used to input the quality of the saved image, applicable if the extension is 'jpg'. It ranges from 1 to 100, with 100 being the highest quality. The default value is 100.

prompt

This parameter is used to input any additional prompt information you want to include in the image metadata. It is optional and can be left empty.

extra_pnginfo

This parameter is used to input any extra PNG information you want to include in the image metadata. It is optional and can be left empty.

Image Save with Prompt (WLSH) Output Parameters:

ui

This output parameter returns a dictionary containing the paths of the saved images. It helps in verifying that the images have been saved correctly and provides easy access to their locations.

Image Save with Prompt (WLSH) Usage Tips:

• Ensure that the path parameter is correctly set to avoid saving images in unintended directories.
• Use the seed parameter to keep track of the exact settings used for image generation, which is crucial for reproducibility.
• Utilize the time_format parameter to include timestamps in filenames, making it easier to organize and sort images chronologically.
• Adjust the quality parameter when saving images in 'jpg' format to balance between file size and image quality.

Image Save with Prompt (WLSH) Common Errors and Solutions:

The path <specified_path> specified doesn't exist! Creating directory.

• Explanation: This message indicates that the specified directory path does not exist.
• Solution: The node will automatically create the missing directory, so no action is needed. However, ensure that the path parameter is correctly set to avoid confusion.

Error: Invalid file extension

• Explanation: This error occurs if the extension parameter is set to an unsupported file format.
• Solution: Ensure that the extension parameter is set to a supported format like 'png' or 'jpg'.

Error: Failed to save image

• Explanation: This error occurs if there is an issue with saving the image, possibly due to incorrect file paths or permissions.
• Solution: Verify that the path parameter is correct and that you have the necessary permissions to write to the specified directory.