Skip to main content

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.py
  • src/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:

  1. Creates the pipeline.
  2. Runs the pipeline implementation.
  3. 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.

Metadata

Release files for imagejenerator 2.1.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for imagejenerator 2.1.0
File Size Uploaded Provenance
imagejenerator-2.1.0.tar.gz 7.6 kB Without provenance Details

Built distribution (wheel)

Table of built distributions (wheels) for imagejenerator 2.1.0
File Interpreter ABI Platform
imagejenerator-2.1.0-py3-none-any.whl Python 3 none any Details

Total release size: 19.0 kB

Release files / imagejenerator-2.1.0.tar.gz

Download URL imagejenerator-2.1.0.tar.gz
Size 7.6 kB
Tags Source
SHA-256 checksum
How to use checksums
759064f3c346318c3c8dd422403837d3957e0af5781f32bc9960e7a31fd47aaf
BLAKE2b-256 checksum
How to use checksums
b12765d089fcbf7c9e383928b201925d3418c8fd549548ecb21b73bc2db551ee
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via poetry/2.2.1 CPython/3.12.3 Linux/6.14.0-37-generic

Release files / imagejenerator-2.1.0-py3-none-any.whl

Download URL imagejenerator-2.1.0-py3-none-any.whl
Size 11.4 kB
Tags Python 3
SHA-256 checksum
How to use checksums
617266f7c7c4680bf4f6acefa50b74780e90f8603fc6aa4c6dbda6c4d2fa4852
BLAKE2b-256 checksum
How to use checksums
e481fcaa08f3fbc0cc6a412c5f5ce7ad51b61be3cb3d996ddb5c61d968e43393
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via poetry/2.2.1 CPython/3.12.3 Linux/6.14.0-37-generic

Security for imagejenerator 2.1.0

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page