ImaginAIry 🤖ğŸ§

Downloads image image Code style: black Python Checks

AI imagined images. Pythonic generation of stable diffusion images.

"just works" on Linux and macOS(M1) (and maybe windows?).


# on macOS, make sure rust is installed first
>> pip install imaginairy
>> imagine "a scenic landscape" "a photo of a dog" "photo of a fruit bowl" "portrait photo of a freckled woman"
# Stable Diffusion 2.0
>> imagine --model SD-2.0 "a forest"

Console Output

🤖🧠 received 4 prompt(s) and will repeat them 1 times to create 4 images.
Loading model onto mps backend...
Generating 🖼  : "a scenic landscape" 512x512px seed:557988237 prompt-strength:7.5 steps:40 sampler-type:PLMS
    PLMS Sampler: 100%|████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████| 40/40 [00:29<00:00,  1.36it/s]
    🖼  saved to: ./outputs/000001_557988237_PLMS40_PS7.5_a_scenic_landscape.jpg
Generating 🖼  : "a photo of a dog" 512x512px seed:277230171 prompt-strength:7.5 steps:40 sampler-type:PLMS
    PLMS Sampler: 100%|████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████| 40/40 [00:28<00:00,  1.41it/s]
    🖼  saved to: ./outputs/000002_277230171_PLMS40_PS7.5_a_photo_of_a_dog.jpg
Generating 🖼  : "photo of a fruit bowl" 512x512px seed:639753980 prompt-strength:7.5 steps:40 sampler-type:PLMS
    PLMS Sampler: 100%|████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████| 40/40 [00:28<00:00,  1.40it/s]
    🖼  saved to: ./outputs/000003_639753980_PLMS40_PS7.5_photo_of_a_fruit_bowl.jpg
Generating 🖼  : "portrait photo of a freckled woman" 512x512px seed:500686645 prompt-strength:7.5 steps:40 sampler-type:PLMS
    PLMS Sampler: 100%|████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████| 40/40 [00:29<00:00,  1.37it/s]
    🖼  saved to: ./outputs/000004_500686645_PLMS40_PS7.5_portrait_photo_of_a_freckled_woman.jpg

Prompt Based Editing by clipseg

Specify advanced text based masks using boolean logic and strength modifiers. Mask syntax: - mask descriptions must be lowercase - keywords (AND, OR, NOT) must be uppercase - parentheses are supported - mask modifiers may be appended to any mask or group of masks. Example: (dog OR cat){+5} means that we'll select any dog or cat and then expand the size of the mask area by 5 pixels. Valid mask modifiers: - {+n} - expand mask by n pixels - {-n} - shrink mask by n pixels - {*n} - multiply mask strength. will expand mask to areas that weakly matched the mask description - {/n} - divide mask strength. will reduce mask to areas that most strongly matched the mask description. probably not useful

When writing strength modifiers keep in mind that pixel values are between 0 and 1.

>> imagine \
    --init-image pearl_earring.jpg \ 
    --mask-prompt "face AND NOT (bandana OR hair OR blue fabric){*6}" \
    --mask-mode keep \
    --init-image-strength .2 \
    --fix-faces \
    "a modern female president" "a female robot" "a female doctor" "a female firefighter"


>> imagine \
    --init-image fruit-bowl.jpg \
    --mask-prompt "fruit OR fruit stem{*6}" \
    --mask-mode replace \
    --mask-modify-original \
    --init-image-strength .1 \
    "a bowl of kittens" "a bowl of gold coins" "a bowl of popcorn" "a bowl of spaghetti"


Face Enhancement by CodeFormer

>> imagine "a couple smiling" --steps 40 --seed 1 --fix-faces


Upscaling by RealESRGAN

>> imagine "colorful smoke" --steps 40 --upscale


Tiled Images

>> imagine  "gold coins" "a lush forest" "piles of old books" leaves --tile


>> imagine "portrait of a smiling lady. oil painting" --init-image girl_with_a_pearl_earring.jpg


Prompt Expansion

You can use {} to randomly pull values from lists. A list of values separated by | and enclosed in { } will be randomly drawn from in a non-repeating fashion. Values that are surrounded by _ _ will pull from a phrase list of the same name. Folders containing .txt phraselist files may be specified via --prompt_library_path. The option may be specified multiple times. Built-in categories:

  3d-term, adj-architecture, adj-beauty, adj-detailed, adj-emotion, adj-general, adj-horror, animal, art-movement, 
  art-site, artist, artist-botanical, artist-surreal, aspect-ratio, bird, body-of-water, body-pose, camera-brand,
  camera-model, color, cosmic-galaxy, cosmic-nebula, cosmic-star, cosmic-term, dinosaur, eyecolor, f-stop, 
  fantasy-creature, fantasy-setting, fish, flower, focal-length, food, fruit, games, gen-modifier, hair, hd,
  iso-stop, landscape-type, national-park, nationality, neg-weight, noun-beauty, noun-fantasy, noun-general, 
  noun-horror, occupation, photo-term, pop-culture, pop-location, punk-style, quantity, rpg-item, scenario-desc, 
  skin-color, spaceship, style, tree-species, trippy, world-heritage-site


imagine "a {lime|blue|silver|aqua} colored dog" -r 4 --seed 0 (note that it generates a dog of each color without repetition)

imagine "a {_color_} dog" -r 4 --seed 0 will generate four, different colored dogs. The colors will be pulled from an included phraselist of colors.

imagine "a {_spaceship_|_fruit_|hot air balloon}. low-poly" -r 4 --seed 0 will generate images of spaceships or fruits or a hot air balloon

Credit to noodle-soup-prompts where most, but not all, of the wordlists originate.

Generate image captions (via BLIP)

>> aimg describe assets/mask_examples/bowl001.jpg
a bowl full of gold bars sitting on a table


  • It makes images from text descriptions! ğŸ�‰
  • Generate images either in code or from command line.
  • It just works. Proper requirements are installed. model weights are automatically downloaded. No huggingface account needed. (if you have the right hardware... and aren't on windows)
  • No more distorted faces!
  • Noisy logs are gone (which was surprisingly hard to accomplish)
  • WeightedPrompts let you smash together separate prompts (cat-dog)
  • Tile Mode creates tileable images
  • Prompt metadata saved into image file metadata
  • Edit images by describing the part you want edited (see example above)
  • Have AI generate captions for images aimg describe <filename-or-url>
  • Interactive prompt: just run aimg

How To

For full command line instructions run aimg --help

from imaginairy import imagine, imagine_image_files, ImaginePrompt, WeightedPrompt, LazyLoadingImage

url = ""
prompts = [
    ImaginePrompt("a scenic landscape", seed=1, upscale=True),
    ImaginePrompt("a bowl of fruit"),
        WeightedPrompt("cat", weight=1),
        WeightedPrompt("dog", weight=1),
        "a spacious building", 
        "a bowl of strawberries", 
        mask_prompt="fruit OR stem{*2}",  # amplify the stem mask x2
    ImaginePrompt("strawberries", tile_mode=True),
for result in imagine(prompts):
    # do something"my_image.jpg")

# or

imagine_image_files(prompts, outdir="./my-art")


  • ~10 gb space for models to download
  • A decent computer with either a CUDA supported graphics card or M1 processor.
  • Python installed. Preferably Python 3.10. (not conda)
  • For macOS rust and setuptools-rust must be installed to compile the tokenizer library. They can be installed via: curl --proto '=https' --tlsv1.2 -sSf | sh and pip install setuptools-rust

Running in Docker

See example Dockerfile (works on machine where you can pass the gpu into the container)

docker build . -t imaginairy
# you really want to map the cache or you end up wasting a lot of time and space redownloading the model weights
docker run -it --gpus all -v $HOME/.cache/huggingface:/root/.cache/huggingface -v $HOME/.cache/torch:/root/.cache/torch -v `pwd`/outputs:/outputs imaginairy /bin/bash

Running on Google Colab

Example Colab


7.0.0 - feature: negative prompting. --negative-prompt or ImaginePrompt(..., negative_prompt="ugly, deformed, extra arms, etc") - feature: a default negative prompt is added to all generations. Images in SD-2.0 don't look bad anymore. Images in 1.5 look improved as well.

6.1.2 - fix: add back in memory-efficient algorithms

6.1.1 - feature: xformers will be used if available (for faster generation) - fix: version metadata was broken

6.1.0 - feature: use different default steps and image sizes depending on sampler and model selceted - fix: #110 use proper version in image metadata - refactor: samplers all have their own class that inherits from ImageSampler - feature: ��� Stable Diffusion 2.0 - --model SD-2.0 to use (it makes worse images than 1.5 though...) - Tested on macOS and Linux - All samplers working for new 512x512 model - New inpainting model working - 768x768 model working for all samplers except PLMS (--model SD-2.0-v)

5.1.0 - feature: add progress image callback

5.0.1 - fix: support larger images on M1. Fixes #8 - fix: support CPU generation by disabling autocast on CPU. Fixes #81

5.0.0 - feature: � inpainting support using new inpainting model from RunwayML. It works really well! By default, the inpainting model will automatically be used for any image-masking task - feature: � new default sampler makes image generation more than twice as fast - feature: added DPM++ 2S a and DPM++ 2M samplers. - feature: improve progress image logging - fix: fix bug with --show-work. fixes #84 - fix: add workaround for pytorch bug affecting macOS users using the new DPM++ 2S a and DPM++ 2M samplers. - fix: add workaround for pytorch mps bug affecting k_dpm_fast sampler. fixes #75 - fix: larger image sizes now work on macOS. fixes #8

4.1.0 - feature: allow dynamic switching between models/weights --model SD-1.5 or --model SD-1.4 or --model path/my-custom-weights.ckpt) - feature: log total progress when generating images (image X out of Y)

4.0.0 - feature: stable diffusion 1.5 (slightly improved image quality) - feature: dilation and erosion of masks Previously the + and - characters in a mask (example: face{+0.1}) added to the grayscale value of any masked areas. This wasn't very useful. The new behavior is that the mask will expand or contract by the number of pixel specified. The technical terms for this are dilation and erosion. This allows much greater control over the masked area. - feature: update k-diffusion samplers. add k_dpm_adaptive and k_dpm_fast - feature: img2img/inpainting supported on all samplers - refactor: consolidates img2img/txt2img code. consolidates schedules. consolidates masking - ci: minor logging improvements

3.0.1 - fix: k-samplers were broken

3.0.0 - feature: improved safety filter

2.4.0 - � feature: prompt expansion - feature: make (blip) photo captions more descriptive

2.3.1 - fix: face fidelity default was broken

2.3.0 - feature: model weights file can be specified via --model-weights-path argument at the command line - fix: set face fidelity default back to old value - fix: handle small images without throwing exception. credit to @NiclasEriksen - docs: add setuptools-rust as dependency for macos

2.2.1 - fix: init image is fully ignored if init-image-strength = 0

2.2.0 - feature: face enhancement fidelity is now configurable

2.1.0 - improved masking accuracy from clipseg

2.0.3 - fix memory leak in face enhancer - fix blurry inpainting - fix for pillow compatibility

2.0.0 - � fix: inpainted areas correlate with surrounding image, even at 100% generation strength. Previously if the generation strength was high enough the generated image would be uncorrelated to the rest of the surrounding image. It created terrible looking images.
- � feature: interactive prompt added. access by running aimg - � feature: Specify advanced text based masks using boolean logic and strength modifiers. Mask descriptions must be lowercase. Keywords uppercase. Valid symbols: AND, OR, NOT, (), and mask strength modifier {+0.1} where + can be any of + - * /. Single character boolean operators also work (|, &, !) - � feature: apply mask edits to original files with mask_modify_original (on by default) - feature: auto-rotate images if exif data specifies to do so - fix: mask boundaries are more accurate - fix: accept mask images in command line - fix: img2img algorithm was wrong and wouldn't at values close to 0 or 1

1.6.2 - fix: another bfloat16 fix

1.6.1 - fix: make sure image tensors come to the CPU as float32 so there aren't compatibility issues with non-bfloat16 cpus

1.6.0 - fix: maybe address #13 with expected scalar type BFloat16 but found Float - at minimum one can specify --precision full now and that will probably fix the issue
- feature: tile mode can now be specified per-prompt

1.5.3 - fix: missing config file for describe feature

1.5.1 - img2img now supported with PLMS (instead of just DDIM) - added image captioning feature aimg describe dog.jpg => a brown dog sitting on grass - added new commandline tool aimg for additional image manipulation functionality

1.4.0 - support multiple additive targets for masking with | symbol. Example: "fruit|stem|fruit stem"

1.3.0 - added prompt based image editing. Example: "fruit => gold coins" - test coverage improved

1.2.0 - allow urls as init-images

previous - img2img actually does # of steps you specify
- performance optimizations - numerous other changes

Not Supported

  • a GUI. this is a python library
  • training
  • exploratory features that don't work well


  • Performance Optimizations
  • ✅
  • ✅
  • ✅
  • xformers improvements
  • Development Environment
  • ✅ add tests
  • ✅ set up ci (test/lint/format)
  • ✅ unified pipeline (txt2img & img2img combined)
  • ✅ setup parallel testing
  • add docs
  • remove yaml config
  • delete more unused code
  • faster latent logging
  • Interface improvements
  • ✅ init-image at command line
  • ✅ prompt expansion
  • ✅ interactive cli
  • Image Generation Features
  • ✅ add k-diffusion sampling methods
  • ✅ tiling
  • generation videos/gifs
  • Compositional Visual Generation
  • negative prompting
    • some syntax to allow it in a text string
  • images as actual prompts instead of just init images. is this the same as textual inversion?
    • requires model fine-tuning since SD1.4 expects 77x768 text encoding input
  • Image Editing
  • outpainting
    • lama cleaner
  • ✅ inpainting
    • img2img but keeps img stable
  • ✅ text based image masking
    • ✅ ClipSeg -
  • Attention Control Methods
  • Image Enhancement
  • Photo Restoration -
  • Upscaling
    • ✅ realesrgan
    • ldm
    • gobig
    • stable super-res?
    • todo: try with 1-0-0-0 mask at full image resolution (rencoding entire image+predicted image at every step)
    • todo: use a gaussian pyramid and only include the "high-detail" level of the pyramid into the next step
  • ✅ face enhancers
    • ✅ gfpgan -
    • ✅ codeformer -
  • ✅ image describe feature -
    • ✅
    • 🚫 CLIP brute-force prompt reconstruction
    • The accuracy of this approach is too low for me to include it in imaginAIry
    • (blip + clip)
  • 🚫 CPU support. While the code does actually work on some CPUs, the generation takes so long that I don't think it's worth the effort to support this feature
  • ✅ img2img for plms
  • ✅ img2img for kdiff functions
  • Other
  • Enhancement pipelines
  • text-to-3d
  • make a video
  • animations
  • guided generation
  • image variations
  • textual inversion
  • fix saturation at high CFG
  • ✅ deploy to pypi
  • find similar images

Notable Stable Diffusion Implementations


Online Stable Diffusion Services


Further Reading

  • Prompt Engineering Handbook
  • Differences between samplers

Repo Not Found