Compare commits

..
18 Commits
Author SHA1 Message Date
Rhys Yang 3ecceb0175 Update README.md 2023-11-01 04:53:36 +08:00
Rhys Yang 00aabca362 Bump version to 1.0.1 2023-11-01 04:42:21 +08:00
Rhys Yang aff17ccbf4 Update package_repo.yml 2023-11-01 04:32:42 +08:00
Rhys Yang 0a5bedf412 Fix %counter overwriting existing images #11 #14, and add a new file-naming mechanism to ensure naming uniqueness. 2023-11-01 04:22:07 +08:00
Rhys Yang b68ed7d7fa Fix the bug causing the Prompt Saver node fails to save images in jpg and webp formats #10 2023-11-01 02:38:15 +08:00
Rhys Yang 61c0487744 Merge pull request #12 from mcmonkey4eva/main
Use relative paths for js imports
2023-10-30 00:16:47 +08:00
Alex "mcmonkey" Goodwin b4df56f08a use relative paths for js imports 2023-10-29 09:07:29 -07:00
Rhys Yang c5a8fed1e6 Update README.md 2023-10-28 03:09:45 +08:00
receyuki d25727455b Merge remote-tracking branch 'origin/main' 2023-10-26 02:02:54 +08:00
receyuki 47551e38dd Bump version to 1.0.0 2023-10-26 02:02:09 +08:00
receyuki cb72f372aa Update core to 1.3.4 2023-10-26 02:01:24 +08:00
Rhys Yang b34c0d2c2e Fix Prompt Saver batch processing #5 2023-10-26 00:25:37 +08:00
receyuki 7f1e6dbfd7 Update core 2023-10-25 02:47:23 +08:00
receyuki b08ec0c5e9 Update README.md 2023-10-25 02:26:08 +08:00
receyuki 11058de872 Update README.md 2023-10-25 01:13:54 +08:00
receyuki 992536ca33 Swap FILE_NAME and SETTINGS of the Prompt Reader. 2023-10-24 23:01:05 +08:00
Rhys Yang bab9dba0d9 Remove model_name_str, sampler_name_str and scheduler_str 2023-10-19 05:23:36 +08:00
Rhys Yang 5886a538da Fix parameter_index 2023-10-18 23:33:34 +08:00
16 changed files with 793 additions and 1029 deletions
+4 -1
View File
@@ -36,7 +36,10 @@ jobs:
- name: Extract Section
id: extract_section
run: sed -n '/## Installation/,/## Usage/ {/## Usage/!p;}' README.md > installation.md
run: |
tag_name="${{ env.TAG_NAME }}"
sed -n "/## $tag_name/,/## /p" CHANGELOG.md | sed '$d' >> installation.md
sed -n '/## Installation/,/## Usage/ {/## Usage/!p;}' README.md >> installation.md
- name: Create GitHub Release
uses: softprops/action-gh-release@v1
+9
View File
@@ -0,0 +1,9 @@
# Change Log
## v1.0.1
- Add a new file-naming mechanism to ensure naming uniqueness
- Fix `%counter` overwriting existing images #11 #14
- Fix the bug causing the `Prompt Saver` node fails to save images in jpg and webp formats #10
- Use relative paths for js imports #12
## v1.0.0
- Initial release
+61 -28
View File
@@ -9,9 +9,7 @@
<a href="https://github.com/psf/black">
<img alt="Code style: black" src="https://img.shields.io/badge/code%20style-black-000000.svg"></a>
<br>
<blockquote>
This project is currently in beta status. If you encounter any issues or have any suggestions, please let me know.
</blockquote>
This is a subproject of the
<a href="https://github.com/receyuki/stable-diffusion-prompt-reader">SD Prompt Reader.</a>
It helps you extract metadata from images in any format supported by the
@@ -24,7 +22,7 @@ additional metadata to ensure compatibility with metadata detection on websites
<a href="#usage">Usage</a> •
<a href="#credits">Credits</a>
</p>
<img src="./images/screenshot_v100b2.png">
<img src="./images/screenshot_v100.png">
</div>
@@ -66,56 +64,91 @@ git pull --recurse-submodules
```
## Usage
>The following section may be outdated and could differ from the actual nodes.
### Prompt Reader Node
- The Prompt Reader Node works exactly the same as the
- The `Prompt Reader` Node works exactly the same as the
[standalone SD Prompt Reader](https://github.com/receyuki/stable-diffusion-prompt-reader).
It uses the Image Data Reader from the
[standalone SD Prompt Reader](https://github.com/receyuki/stable-diffusion-prompt-reader),
allowing it to support the same formats and receive updates along with the
[SD Prompt Reader](https://github.com/receyuki/stable-diffusion-prompt-reader).
***For images containing multiple sets of parameters, such as those processed through `hires-fix` or `refiner`,
you will need to modify the `data_index` to select the parameters you need***
***For images generated by SDXL and containing multiple sets of prompts,
the text_g will be combined with text_l into a single prompt***
[SD Prompt Reader](https://github.com/receyuki/stable-diffusion-prompt-reader).
- Due to custom nodes and complex workflows potentially causing issues with SD Prompt Reader's ability
to read image metadata correctly, it is recommended to embed the `Prompt Saver` Node within the workflow
to ensure maximum compatibility.
- For images containing multiple sets of parameters, such as those processed through `hires-fix` or `refiner`,
you will need to modify the `parameter_index` to select the parameters you need
- For images generated by SDXL and containing multiple sets of prompts,
the `text_g` will be combined with `text_l` into a single prompt
<div align="center">
<img src="./images/reader.png" width="25%" height="25%" alt="reader node">
</div>
### Prompt Saver Node & Parameter Generator Node
- The Prompt Saver Node and The Parameter Generator Node are designed to be used together.
- The Prompt Saver Node will write additional metadata in the A1111 format to the output images
### Prompt Saver Node
- The `Prompt Saver` Node and The `Parameter Generator` Node are designed to be used together.
- The `Prompt Saver` Node will write additional metadata in the A1111 format to the output images
to be compatible with any tools that support the A1111 format,
including SD Prompt Reader and Civitai.
Due to custom nodes and complex workflows potentially causing issues with SD Prompt Reader's ability
to read image metadata correctly, it is recommended to embed this node within the workflow
to ensure maximum compatibility.
- Since it's not possible to directly extract metadata from KSampler, it is necessary to
use the Parameter Generator Node to generate parameters and simultaneously output them to both
the Prompt Saver Node and KSampler.
- Since it's not possible to directly extract metadata from `KSampler`, it is necessary to
use the `Parameter Generator` Node to generate parameters and simultaneously output them to both
the `Prompt Saver` Node and `KSampler`.
- Please refer to the following table for placeholders supported by the `filename` and `path`.
| Placeholder |
|-------------|
| %date |
| %time |
| %counter |
| %seed |
| %steps |
| %cfg |
| %extension |
| %model |
| %sampler |
| %scheduler |
| %quality |
- `%counter` cannot be used for the `path`. This `%counter` is slightly different from the `%counter`
in the built-in Saver node, it will count all image files in the `path`.
- When the filename already exists, an index will be added at the end of the filename,
e.g. `file.png, file_1.png, file_2.png`.
- For the `date_format` and `time_format`, please refer to
[strftime.org](https://strftime.org/) or [www.strfti.me](https://www.strfti.me/).
<div align="center">
<img src="./images/generator_saver.png" width="50%" height="50%" alt="generator and saver node">
<img src="./images/saver.png" width="25%" height="25%" alt="generator and saver node">
</div>
## Parameter Generator Node
- Since it's not possible to directly extract metadata from `KSampler`, it is necessary to
use the `Parameter Generator` Node to generate parameters and simultaneously output them to both
the `Prompt Saver` Node and `KSampler`.
- The `Parameter Generator` Node can also be used as a control panel for complex ComfyUI workflows, just like the [AP workflow](https://perilli.com/ai/comfyui/).
- The `model_version` and `aspect_ratio` are used only for calculating the optimal resolution of the selected model version
under the chosen aspect ratio. The calculation method is based on the
[Stability AI development documentation](https://platform.stability.ai/docs/features/api-parameters#about-dimensions)
and the [StableSwarmUI source code](https://github.com/Stability-AI/StableSwarmUI) (developed by Stability AI).
- `refiner_start` refers to the proportion of steps completed when the refiner starts running,
i.e., the proportion of base steps to total steps. This is used to calculate the `start_at_step` (`REFINER_START_STEP`)
required by the refiner `KSampler` under the selected step ratio.
<div align="center">
<img src="./images/generator.png" width="25%" height="25%" alt="generator and saver node">
</div>
### Prompt Merger Node & Type Converter Node
- Since the A1111 format cannot store `text_g` and `text_l` separately, SDXL users need to use
the Prompt Merger Node to combine `text_g` and `text_l` into a single prompt.
- In some cases, inputs like `model_name`, `sampler_name`, and `scheduler` may conflict with other custom nodes.
You can use the SD Type Converter to convert them into `STRING` type and then
input them into `model_name_str`, `sampler_name_str`, and `scheduler_str`. Please note that inputs of type `STRING`
have higher priority, so do not connect `STRING` inputs unless necessary, as the Prompt Saver will prioritize reading
`STRING` inputs over regular ones.
the `Prompt Merger` Node to combine `text_g` and `text_l` into a single prompt.
- Since `model_name`, `sampler_name`, and `scheduler` are special types
that cannot be directly used by some other nodes,
You can use the `Type Converter` Node to convert them into `STRING` type.
<div align="center">
<img src="./images/merger_converter.png" width="25%" height="25%" alt="merger and converter node">
</div>
### [Example Workflow](./workflows/example_workflow.json)
>The example workflow is outdated and will be updated in the stable release.
<div align="center">
<img src="./images/example_workflow.png" width="100%" height="100%" alt="example workflow">
@@ -125,4 +158,4 @@ have higher priority, so do not connect `STRING` inputs unless necessary, as the
- The SD Prompt Reader node is based on [ComfyUI Load Image With Metadata](https://github.com/tkoenig89/ComfyUI_Load_Image_With_Metadata)
- The SD Prompt Saver node is based on [Comfy Image Saver](https://github.com/giriss/comfy-image-saver) & [Stable Diffusion Webui](https://github.com/AUTOMATIC1111/stable-diffusion-webui)
- The seed generator in the SD Parameter Generator is modified from [rgthree's Comfy Nodes](https://github.com/rgthree/rgthree-comfy#rgthrees-comfy-nodes)
- A special thanks to [@alessandroperilli](https://github.com/alessandroperilli) and his [AP Workflow](https://perilli.com/ai/comfyui/) for providing numerous suggestions
- A special thanks to [@alessandroperilli](https://github.com/alessandroperilli) and his [AP Workflow](https://perilli.com/ai/comfyui/) for providing numerous suggestions
+1 -1
View File
@@ -1 +1 @@
VERSION = "1.0.0b3"
VERSION = "1.0.1"
Binary file not shown.

Before

Width:  |  Height:  |  Size: 906 KiB

After

Width:  |  Height:  |  Size: 761 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 109 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 303 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 13 KiB

After

Width:  |  Height:  |  Size: 13 KiB

BIN
View File
Binary file not shown.

Before

Width:  |  Height:  |  Size: 385 KiB

After

Width:  |  Height:  |  Size: 363 KiB

BIN
View File
Binary file not shown.

After

Width:  |  Height:  |  Size: 167 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 769 KiB

+2 -2
View File
@@ -1,5 +1,5 @@
import {app} from "/scripts/app.js";
import {ComfyWidgets} from "/scripts/widgets.js";
import {app} from "../../scripts/app.js";
import {ComfyWidgets} from "../../scripts/widgets.js";
// Create a read-only string widget
function createWidget(app, node, widgetName, type) {
+2 -2
View File
@@ -1,5 +1,5 @@
import {app} from "/scripts/app.js";
import {ComfyWidgets} from "/scripts/widgets.js";
import {app} from "../../scripts/app.js";
import {ComfyWidgets} from "../../scripts/widgets.js";
// Create a read-only string widget with opacity set
function createWidget(app, node, widgetName) {
+63 -36
View File
@@ -8,6 +8,7 @@
import os
from datetime import datetime
from itertools import chain
import torch
import json
@@ -94,8 +95,8 @@ class SDPromptReader:
"CFG",
"WIDTH",
"HEIGHT",
"SETTINGS",
"FILE_NAME",
"SETTINGS",
)
FUNCTION = "load_image"
@@ -158,8 +159,8 @@ class SDPromptReader:
cfg,
width,
height,
image_data.setting,
file_path.stem,
image_data.setting,
),
}
@@ -169,14 +170,14 @@ class SDPromptReader:
return data_list[0] if len(data_list) == 1 else data_list[index]
@classmethod
def IS_CHANGED(s, image, data_index):
def IS_CHANGED(s, image, parameter_index):
image_path = folder_paths.get_annotated_filepath(image)
with open(Path(image_path), "rb") as f:
image_data = ImageDataReader(f)
return image_data.props
@classmethod
def VALIDATE_INPUTS(s, image, data_index):
def VALIDATE_INPUTS(s, image, parameter_index):
if not folder_paths.exists_annotated_filepath(image):
return "Invalid image file: {}".format(image)
return True
@@ -201,7 +202,7 @@ class SDPromptSaver:
),
"path": ("STRING", {"default": "%date/", "multiline": False}),
"model_name": (folder_paths.get_filename_list("checkpoints"),),
"model_name_str": ("STRING", {"default": ""}),
# "model_name_str": ("STRING", {"default": ""}),
"seed": (
"INT",
{
@@ -225,9 +226,9 @@ class SDPromptSaver:
},
),
"sampler_name": (comfy.samplers.KSampler.SAMPLERS,),
"sampler_name_str": ("STRING", {"default": ""}),
# "sampler_name_str": ("STRING", {"default": ""}),
"scheduler": (comfy.samplers.KSampler.SCHEDULERS,),
"scheduler_str": ("STRING", {"default": ""}),
# "scheduler_str": ("STRING", {"default": ""}),
"width": (
"INT",
{"default": 1, "min": 1, "max": MAX_RESOLUTION, "step": 8},
@@ -293,36 +294,45 @@ class SDPromptSaver:
(
full_output_folder,
filename_alt,
counter,
counter_alt,
subfolder_alt,
filename_prefix,
) = folder_paths.get_save_image_path(
self.prefix_append, self.output_dir, images[0].shape[1], images[0].shape[0]
self.prefix_append,
self.output_dir,
images[0].shape[1],
images[0].shape[0],
)
results = list()
model_name_real = model_name_str if model_name_str else model_name
sampler_name_real = sampler_name_str if sampler_name_str else sampler_name
scheduler_real = scheduler_str if scheduler_str else scheduler
extra_info_real = f", Extra info: {extra_info}" if extra_info else ""
variable_map = {
"%date": self.get_time(date_format),
"%time": self.get_time(time_format),
"%counter": f"{counter:05}",
"%seed": seed,
"%steps": steps,
"%cfg": cfg,
"%extension": extension,
"%model": model_name_real,
"%sampler": sampler_name_real,
"%scheduler": scheduler_real,
"%quality": jpg_webp_quality,
}
for image in images:
# model_name_str, sampler_name_str, scheduler_str = None, None, None
model_name_real = model_name_str if model_name_str else model_name
sampler_name_real = sampler_name_str if sampler_name_str else sampler_name
scheduler_real = scheduler_str if scheduler_str else scheduler
extra_info_real = f", Extra info: {extra_info}" if extra_info else ""
variable_map = {
"%date": self.get_time(date_format),
"%time": self.get_time(time_format),
"%seed": seed,
"%steps": steps,
"%cfg": cfg,
"%extension": extension,
"%model": model_name_real,
"%sampler": sampler_name_real,
"%scheduler": scheduler_real,
"%quality": jpg_webp_quality,
}
subfolder = self.get_path(path, variable_map)
output_folder = Path(full_output_folder) / subfolder
output_folder.mkdir(parents=True, exist_ok=True)
counter = self.get_counter(output_folder)
variable_map["%counter"] = f"{counter:05}"
i = 255.0 * image.cpu().numpy()
img = Image.fromarray(np.clip(i, 0, 255).astype(np.uint8))
metadata = None
@@ -344,10 +354,9 @@ class SDPromptSaver:
f"Version: ComfyUI"
f"{extra_info_real}"
)
subfolder = self.get_path(path, variable_map)
output_folder = Path(full_output_folder) / subfolder
output_folder.mkdir(parents=True, exist_ok=True)
file = self.get_path(filename, variable_map).with_suffix("." + extension)
stem = self.get_path(filename, variable_map)
file = self.get_unique_filename(stem, extension, output_folder)
if extension == "png":
if not args.disable_metadata:
@@ -379,11 +388,10 @@ class SDPromptSaver:
},
}
)
piexif.insert(metadata, str(file))
piexif.insert(metadata, str(output_folder / file))
results.append(
{"filename": file.name, "subfolder": str(subfolder), "type": self.type}
)
counter += 1
return {"ui": {"images": results}}
@@ -399,6 +407,13 @@ class SDPromptSaver:
return hash_sha256.hexdigest()[:10]
@staticmethod
def get_counter(directory: Path):
img_files = list(
chain(*(directory.rglob(f"*{suffix}") for suffix in SUPPORTED_FORMATS))
)
return len(img_files) + 1
@staticmethod
def get_path(name, variable_map):
for variable, value in variable_map.items():
@@ -414,6 +429,18 @@ class SDPromptSaver:
except:
return ""
@staticmethod
def get_unique_filename(stem: Path, extension: str, output_folder: Path):
file = stem.with_suffix(f".{extension}")
index = 0
while (output_folder / file).exists():
index += 1
new_stem = f"{stem}_{index}"
file = Path(new_stem).with_suffix(f".{extension}")
return file
class SDParameterGenerator:
ASPECT_RATIO_MAP = {
File diff suppressed because it is too large Load Diff