feature: large refactor - breaking changes

.github/workflows/ci.yaml

@@ -15,7 +15,7 @@ jobs:
       - uses: actions/checkout@v3
       - uses: actions/[email protected]
         with:
-          python-version: 3.9
+          python-version: "3.10"
       - name: Cache dependencies
         uses: actions/[email protected]
         id: cache
@@ -35,7 +35,7 @@ jobs:
       - uses: actions/checkout@v3
       - uses: actions/[email protected]
         with:
-          python-version: 3.9
+          python-version: "3.10"
       - name: Cache dependencies
         uses: actions/[email protected]
         id: cache
@@ -73,3 +73,18 @@ jobs:
         CUDA_LAUNCH_BLOCKING: 1
       run: |
         pytest --durations=10 -v
+  type-check:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v3
+    - uses: actions/[email protected]
+      with:
+        python-version: "3.10"
+        cache: pip
+        cache-dependency-path: requirements-dev.txt
+    - name: Install dependencies
+      run: |
+        python -m pip install -r requirements-dev.txt . --upgrade
+    - name: Run mypy
+      run: |
+        make type-check

Makefile

@@ -40,6 +40,9 @@ lint:  ## Run the code linter.
 	@ruff check --config tests/ruff.toml .
 	@echo -e "No linting errors - well done! ✨ 🍰 ✨"
 
+type-check: ## Run the type checker.
+	@mypy --config-file tox.ini .
+
 deploy:  ## Deploy the package to pypi.org
 	pip install twine wheel
 	-git tag $$(python setup.py -V)

README.md

@@ -787,7 +787,7 @@ Use with `--model SD-2.1` or `--model SD-2.0-v`
 **6.1.0**
 - feature: use different default steps and image sizes depending on sampler and model selected
 - fix: #110 use proper version in image metadata
-- refactor: samplers all have their own class that inherits from ImageSampler
+- refactor: solvers all have their own class that inherits from ImageSolver
 - feature: 🎉🎉🎉 Stable Diffusion 2.0
   - `--model SD-2.0` to use (it makes worse images than 1.5 though...) 
   - Tested on macOS and Linux

docs/examples/generate_doc_examples.py

@@ -1,4 +1,5 @@
-from imaginairy import ImaginePrompt, LazyLoadingImage, imagine_image_files
+from imaginairy.api import imagine_image_files
+from imaginairy.schema import ImaginePrompt, LazyLoadingImage
 
 
 def main():

docs/examples/immortal_pearl_earring.py

@@ -4,8 +4,9 @@
 from PIL import ImageDraw, ImageFont
 from tqdm import tqdm
 
-from imaginairy import ImaginePrompt, LazyLoadingImage, WeightedPrompt, imagine
+from imaginairy.api import imagine
 from imaginairy.log_utils import configure_logging
+from imaginairy.schema import ImaginePrompt, LazyLoadingImage, WeightedPrompt
 
 
 def generate_image_morph_video():

docs/todo.md

@@ -3,19 +3,25 @@
 ### v14 todo
 
  - configurable composition cutoff
- - rename model parameter weights 
- - rename model_config parameter to architecture and make it case insensitive
- - add --size parameter that accepts strings (e.g. 256x256, 4k, uhd, 8k, etc)
- - detect if cuda torch missing and give better error message
- - add method to install correct torch version
+ - ✅ rename model parameter weights 
+ - ✅ rename model_config parameter to architecture and make it case insensitive
+ - ✅ add --size parameter that accepts strings (e.g. 256x256, 4k, uhd, 8k, etc)
+ - ✅ detect if cuda torch missing and give better error message
+ - ✅ add method to install correct torch version
+ - ✅ make cli run faster again
+ - ✅ add tests for cli commands
+ - add type checker
+ - only output the main image unless some flag is set
  - allow selection of output video format
  - chain multiple operations together imggen => videogen
+   - https://github.com/pallets/click/tree/main/examples/imagepipe 
+
+ - add interface for loading diffusers weights
+ - https://huggingface.co/playgroundai/playground-v2-1024px-aesthetic
  - make sure terminal output on windows doesn't suck
- - add karras schedule to refiners
  - add method to show cache size
  - add method to clear model cache
  - add method to clear cached items not recently used (does diffusers have one?)
-
 ### Old Todo
 
  - Inference Performance Optimizations

imaginairy/__init__.py

@@ -4,22 +4,3 @@
 os.putenv("PYTORCH_ENABLE_MPS_FALLBACK", "1")
 # use more memory than we should
 os.putenv("PYTORCH_MPS_HIGH_WATERMARK_RATIO", "0.0")
-
-import sys  # noqa
-
-from .api import imagine, imagine_image_files  # noqa
-from .schema import (  # noqa
-    ImaginePrompt,
-    ImagineResult,
-    LazyLoadingImage,
-    WeightedPrompt,
-)
-
-# if python version is 3.11 or higher, throw an exception
-if sys.version_info >= (3, 11):
-    msg = (
-        "Imaginairy is not compatible with Python 3.11 or higher. Please use Python 3.8 - 3.10.\n"
-        "This is due to torch 1.13 not supporting Python 3.11 and this library not having yet switched "
-        "to torch 2.0"
-    )
-    raise RuntimeError(msg)