Update README

This commit is contained in:
nkchocoai
2024-02-18 01:08:18 +09:00
parent 2ffe28c21d
commit 1eeff55150
3 changed files with 88 additions and 2 deletions
+44 -1
View File
@@ -1,9 +1,52 @@
# ComfyUI-SaveImageWithMetaData
![SaveImageWithMetaData Preview](img/save_image_with_metadata.png)
- [ComfyUI](https://github.com/comfyanonymous/ComfyUI)用のカスタムノードです。
- 各ノードの入力値から取得したメタデータ(PNGInfo)つきの画像を保存するノードを追加します。
- 動的に値を取得するため、色々な拡張機能のノードで出力された値をメタデータに追加することができます。
## インストール手順
```
cd <ComfyUIがあるディレクトリ>/custom_nodes
git clone https://github.com/nkchocoai/ComfyUI-SaveImageWithMetaData.git
```
```
## 追加されるノード
### Save Image With Metadata
- 入力として受け取った `images` をメタデータ(PNGInfo)つきの画像として保存します。
- メタデータは `sampler_selection_method` で見つけたKSamplerノードの入力と以前に実行されたノードの入力から取得します。
#### sampler_selection_method
- このノードよりも前に実行されたKSamplerノードを選ぶ方法を指定します。
##### Farthest
- このノードに最も遠いKSamplerノードを選びます。
- 例: [everywhere_prompt_utilities.png](examples/everywhere_prompt_utilities.png) において、上段のKSamplerノード(seed=12345)を選びます。
##### Nearest
- このノードに最も近いKSamplerノードを選びます。
- 例: [everywhere_prompt_utilities.png](examples/everywhere_prompt_utilities.png) において、下段のKSamplerノード(seed=67890)を選びます。
##### By node ID
- ノードIDが `sampler_selection_node_id` であるKSamplerノードを選びます。
## 付与されるメタデータ
- Positive prompt
- Negative prompt
- Steps
- Sampler
- CFG Scale
- Seed
- Clip skip
- Size
- Model
- Model hash
- batch size >= 2の場合 :
- Batch index
- Batch size
## 対応しているノード・拡張機能
- 対応しているノードは以下のファイルをご確認ください。
- [py/defs/captures.py](py/defs/captures.py)
- [py/defs/samplers.py](py/defs/samplers.py)
- 対応している拡張機能は以下のディレクトリをご確認ください。
- [py/defs/ext/](py/defs/ext/)
+44 -1
View File
@@ -1,11 +1,54 @@
# ComfyUI-SaveImageWithMetaData
![SaveImageWithMetaData Preview](img/save_image_with_metadata.png)
日本語版READMEは[こちら](README.jp.md)。
- Custom node for [ComfyUI](https://github.com/comfyanonymous/ComfyUI).
- Add a node to store images with metadata (PNGInfo) extracted from the input values of each node.
- Since the values are extracted dynamically, values output by various extension nodes can be added to metadata.
## Installation
```
cd <ComfyUI directory>/custom_nodes
git clone https://github.com/nkchocoai/ComfyUI-SaveImageWithMetaData.git
```
```
## Nodes
### Save Image With Metadata
- Saves the `images` received as input as an image with metadata (PNGInfo).
- Metadata is extracted from the input of the KSampler node found by `sampler_selection_method` and the input of the previously executed node.
#### sampler_selection_method
- Specifies how to select a KSampler node that has been executed before this node.
##### Farthest
- Selects the farthest KSampler node from this node.
- Example: In [everywhere_prompt_utilities.png](examples/everywhere_prompt_utilities.png), select the upper KSampler node (seed=12345).
##### Nearest
- Select the nearest KSampler node to this node.
- Example: In [everywhere_prompt_utilities.png](examples/everywhere_prompt_utilities.png), select the bottom KSampler node (seed=67890).
##### By node ID
- Select the KSampler node whose node ID is `sampler_selection_node_id`.
## Metadata to be given
- Positive prompt
- Negative prompt
- Steps
- Sampler
- CFG Scale
- Seed
- Clip skip
- Size
- Model
- Model hash
- If batch size >= 2 :
- Batch index
- Batch size
## Supported nodes and extensions
- Please check the following file for supported nodes.
- [py/defs/captures.py](py/defs/captures.py)
- [py/defs/samplers.py](py/defs/samplers.py)
- Please check the following directories for supported extensions.
- [py/defs/ext/](py/defs/ext/)
Binary file not shown.

After

Width:  |  Height:  |  Size: 28 KiB