Updated README for 2.1 InvokeAI

README.md

@@ -1,3 +1,13 @@
+# Table of contents
+- [nix-stable-diffusion](#nix-stable-diffusion)
+  - [What's done](#whats-done)
+- [How to use it?](#how-to-use-it)
+  - [InvokeAI](#invokeai)
+  - [stable-diffusion-webui aka 111AUTOMATIC111 fork](#stable-diffusion-webui-aka-111automatic111-fork)
+- [What's needed to be done](#whats-needed-to-be-done)
+- [Updates and versioning](#updates-and-versioning)
+- [Acknowledgements](#acknowledgements)
+
 # nix-stable-diffusion
 Flake for running SD on NixOS
 
@@ -14,10 +24,11 @@ Flake for running SD on NixOS
     1. `.#invokeai.default` builds shell which overrides bare minimum required for SD to run
     1. `.#invokeai.amd` builds shell which overrides torch packages with ROCM-enabled bin versions
     1. `.#invokeai.nvidia` builds shell with overlay explicitly setting `cudaSupport = true` for torch
-1. Inside InvokeAI's directory, run `python scripts/preload_models.py` to preload models (doesn't include SD weights)
-1. Obtain and place SD weights into `models/ldm/stable-diffusion-v1/model.ckpt`
+1. Weights download 
+    1. **Built-in way.** Inside InvokeAI's directory, run `python scripts/preload_models.py` to preload main SD weighs and support models. (Downloading Stable Diffusion Weighs will require HugginFace token)
+    2. **Manual way.** If you obtained SD weights from somewhere else, you can skip their download with `preload_models.py`. However, you'll have to manually create/edit `InvokeAI/configs/models.yaml` so that your models get loaded. Some example configs for SD 1.4, 1.5, 1.5-inpainting present in `models.example.yaml` .
 1. Run CLI with `python scripts/invoke.py` or GUI with `python scripts/invoke.py --web`
-1. For more detailed instructions consult https://invoke-ai.github.io/InvokeAI/installation/INSTALL_LINUX/
+1. For more detailed instructions consult https://invoke-ai.github.io/InvokeAI/installation/INSTALLING_MODELS/#community-contributed-models
 
 ## stable-diffusion-webui aka 111AUTOMATIC111 fork
 1. Clone repo
@@ -29,7 +40,7 @@ Flake for running SD on NixOS
 1. Obtain and place SD weights into `stable-diffusion-webui/models/Stable-diffusion/model.ckpt`
 1. Inside `stable-diffusion-webui/` directory, run `python launch.py` to start web server. It should preload required models from the start. Additional models, such as CLIP, will be loaded before the first actual usage of them.
 
-## What's needed to be done
+# What's needed to be done
 
 - [x] devShell with CUDA support (should be trivial, but requires volunteer with NVidia GPU) 
 - [ ] Missing packages definitions should be submitted to Nixpkgs
@@ -40,15 +51,15 @@ Flake for running SD on NixOS
 - [ ] May be this devShell should be itself turned into a package?
 - [x] Add additional flavors of SD ?
 
-## Updates and versioning
+# Updates and versioning
 
 Current versions:
-- InvokeAI 2.0.2
+- InvokeAI 2.1.3p1
 - stable-diffusion-webui 27.10.2022
 
-I have no intention to keep up with development pace of these apps, especially the automatic's fork :) . However, I will ocasionally update at least InvokeAI flake. Considering versioning, I will try to follow semver with respect to submodules as well, which means major version bump for submodule = major version bump for this flake. 
+I have no intention to keep up with development pace of these apps, especially the Automatic's fork :) . However, I will ocasionally update at least InvokeAI's flake. Considering versioning, I will try to follow semver with respect to submodules as well, which means major version bump for submodule = major version bump for this flake. 
 
-## Acknowledgements
+# Acknowledgements
 
 Many many thanks to https://github.com/cript0nauta/pynixify which generated all the boilerplate for missing python packages.  
 Also thanks to https://github.com/colemickens/stable-diffusion-flake and https://github.com/skogsbrus/stable-diffusion-nix-flake for inspiration and some useful code snippets.