Image generation suite.
Project description
Image Jenerator
A Flexible and Configurable Image Generation Suite
Image Jenerator is an extensible Python framework designed to run various image generation models (like Stable Diffusion) through a unified, standardized pipeline.
It takes care of the setup such as device management (CUDA/CPU), mixed-precision handling, and random seed generation.
Requirements
- Python 3.10+
- GPU and CUDA drivers (or equivalent) are recommended. Image Jenerator supports CPU, but don't blame me if your system crashes or your images take half an hour to generate.
Installation
Install into your package with pip:
pip install imagejenerator
If you're not installing imagejenerator into another project and just want to make images:
python -m venv venv
(Linux/macOS) source venv/bin/activate
(Windows) .\venv\Scripts\activate
pip install imagejenerator
Quick Start
See the example files:
src/imagejenerator/examples/quick_start.pysrc/imagejenerator/examples/config.py
Create an image generator object by passing your config to registry.get_model_class(config). Your config must contain the name of the model that you want to use (as listed in the registry). This creates your image generator and moves your config into it. Note that the model is not loaded into RAM at this stage.
from imagejenerator.models import registry
from imagejenerator.examples.config import config
image_generator = registry.get_model_class(config)
Call image_generator.generate_image() to create your image:
image_generator.generate_image()
Splitting up the workflow
image_generator.generate_image() is the main workflow method which:
- Creates the pipeline.
- Runs the pipeline implementation.
- Saves the resulting images to disk.
You can do these separately with:
image_generator.create_pipeline()
image_generator.run_pipeline()
image_generator.save_image()
For example, once the model is loaded into memory, you won't need to run image_generator.create_pipeline() again.
Config
Create a config dictionary with the following keys (default parameters are located at: src/imagejenerator/config.py):
| Setting | Type | Description |
|---|---|---|
model |
str |
The registered model name to use (e.g., "stable-diffusion-v1-5"). |
model_path |
str |
Local path or Hugging Face repository ID for the model weights. |
device |
str |
Compute device ("detect", "cuda", or "cpu"). |
dtype |
str |
Tensor precision ("detect", "bfloat16", "float16", or "float32"). |
scheduler |
str |
The name of the scheduler/sampler to use (must be a key in sd_schedulers.py). |
enable_attention_slicing |
bool |
If True, enables attention slicing to reduce VRAM usage. |
height |
int |
The height of the generated image in pixels. |
width |
int |
The width of the generated image in pixels. |
num_inference_steps |
int |
The number of diffusion steps to run. |
guidance_scale |
float |
Classifier-free guidance scale (CFG). Higher values increase adherence to the prompt. |
prompts |
list[str] |
The list of prompts to generate - more than one prompt will be batched so watch your VRAM! |
images_to_generate |
int |
The number of images to generate per prompt. The batch size will be number of prompts * images_to_generate |
seeds |
list[int] |
List of random seeds. Leave empty ([]) for automatic random generation. |
image_save_folder |
str |
Output directory for image files. |
Utils
See the jenerationutils package for additional packages you can use to save generation metadata and benchmarking times.
Architecture and Extensibility
The core of Image Jenerator is built around a base ImageGenerator class and a model registry, making it easy to add new models (like SDXL, Stable Cascade, or custom pipelines) without modifying the core logic.
1. Abstract Base Class (ImageGenerator)
All model pipelines inherit from ImageGenerator, which defines the standard workflow methods and parameters common to all models.
2. Model Registration
Each model (or group of models that require the same diffusers class) use their own model class, with the @register_model decorator applied to it. This automatically adds model classes to the registry, so that they can be specified in the config.
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file imagejenerator-2.0.0.tar.gz.
File metadata
- Download URL: imagejenerator-2.0.0.tar.gz
- Upload date:
- Size: 7.5 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: poetry/2.2.1 CPython/3.12.3 Linux/6.14.0-37-generic
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
6ddeb219b2784e6f2fbcb527ff4d4855cf0d11f7fe4bcee452610f0aec70a6d9
|
|
| MD5 |
f2a9ff1f69f257964e7c33e407a899c9
|
|
| BLAKE2b-256 |
da6f034d937a8c667522404cfe65ec84bccf22f0aee98d27dedd44fa9d82d3fb
|
File details
Details for the file imagejenerator-2.0.0-py3-none-any.whl.
File metadata
- Download URL: imagejenerator-2.0.0-py3-none-any.whl
- Upload date:
- Size: 11.0 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: poetry/2.2.1 CPython/3.12.3 Linux/6.14.0-37-generic
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
72979d0460121e4b9dd6d6482eaad9a928ec3ba40d5a092e5fbfd0d67212ac96
|
|
| MD5 |
17c4cfdda8bff1f981b2e1f1fa6e2e0b
|
|
| BLAKE2b-256 |
c27db3777c082879a0ef8c3abc51b68638e4ceae4c4a9fee9986865b34eea159
|