sd-parsers
sd-parsers copied to clipboard
d3x-at
A Python library to read metadata from images created by Stable Diffusion.
[!IMPORTANT]
Version 0.3 featuring a revisited API and extended ComfyUI & InvokeAI parsing logic is available.See release notes for changes.
Features
Supports reading metadata from images generated with:
- Automatic1111's Stable Diffusion web UI
- ComfyUI *
- InvokeAI
- NovelAI
Provides a list of prompts used in the generation of the image, as well as generator-specific metadata.
* Custom ComfyUI nodes might parse incorrectly / with incomplete data.
Installation
pip install sd-parsers
Usage
From command line: python3 -m sd_parsers <filenames>.
Basic usage:
For a simple query, import ParserManager from sd_parsers and use its parse() method to parse an image. (see examples)
Read prompt information from a given filename:
from sd_parsers import ParserManager
parser_manager = ParserManager()
def main():
prompt_info = parser_manager.parse("image.png")
if prompt_info:
for prompt in prompt_info.prompts:
print(f"Prompt: {prompt.value}")
Read prompt information from an already opened image:
from PIL import Image
from sd_parsers import ParserManager
parser_manager = ParserManager()
def main():
with Image.open('image.png') as image:
prompt_info = parser_manager.parse(image)
Each parser module can also be used directly, omitting the use of ParserManager:
from PIL import Image
from sd_parsers.exceptions import ParserError
from sd_parsers.parsers import AUTOMATIC1111Parser
parser = AUTOMATIC1111Parser()
def main():
with Image.open("image.png") as image:
try:
prompt_info = parser.read_parameters(image)
if prompt_info:
# the following can be omitted for an equivalent
# of ParserManager(lazy_read=True)
prompt_info.parse()
except ParserError:
...
Output
The output returned from ParserManager is a PromptInfo object (as can be seen when executing python3 -m sd_parsers <image.png>) or None if no metadata was found.
PromptInfo contains the following properties :
-
generator: Specifies the image generator that may have been used for creating the image. -
prompts: Prompts as found in the parsed metadata. -
negative_prompts: Negative prompts as found in the parsed metadata. -
samplers: Samplers used in the image generation process. -
models: Models used in the image generation process. -
metadata: Additional metadata which could not be attributed to one of the former described.Highly dependent on the provided data structure of the respective image generator.
-
parameters: A dictionary of unmodified metadata entries as found in the parsed image (if present).
Contributing
As i don't have the time and resources to keep up with all the available AI-based image generators out there, the scale and features of this library is depending greatly on your help.
If you find the sd-parsers library unable to read metadata from an image, feel free to open an issue.
See CONTRIBUTING.md, if you are willing to help with improving the library itself and/or to create/maintain an additional parser module.
Credits
Idea and motivation using AUTOMATIC1111's stable diffusion webui
- https://github.com/AUTOMATIC1111/stable-diffusion-webui
Example workflows for testing the ComfyUI parser
- https://github.com/comfyanonymous/ComfyUI_examples
d3x-at