Merge branch 'main' of https://github.com/0xbitches/ComfyUI-LCM

README.md

@@ -1,9 +1,34 @@
 # Latent Consistency Model for ComfyUI
 
-This is a comfyui early testing node for LCM, adapted from https://github.com/0xbitches/sd-webui-lcm
-
-It uses the diffusers backend unfortunately and not comfy's model loading mechanism. But the intention here is just to be able to execute lcm inside comfy.
-
-_You need to use a special lcm model for this - the only available checkpoint currently is [LCM_Dreamshaper_v7](https://huggingface.co/SimianLuo/LCM_Dreamshaper_v7)._
-
 ![Context Node](./preview.png)
+
+This extension aims to integrate [Latent Consistency Model (LCM)](https://latent-consistency-models.github.io/) into [ComfyUI](https://github.com/comfyanonymous/ComfyUI).
+
+Note that LCMs are a completely different class of models than Stable Diffusion, and the only available checkpoint currently is [LCM_Dreamshaper_v7](https://huggingface.co/SimianLuo/LCM_Dreamshaper_v7). Due to this, this implementation uses the [diffusers](https://huggingface.co/docs/diffusers/index) library, and not Comfy's own model loading mechanism. 
+
+## Installation:
+Simply clone this repo to your `custom_nodes/` directory:
+
+```
+git clone https://github.com/0xbitches/ComfyUI-LCM
+```
+
+Then restart ComfyUI.
+
+## Known Issues
+
+#### `ValueError: Non-consecutive added token '<|startoftext|>' found. Should have index 49408 but has index 49406 in saved vocabulary.`
+
+To resolve this, locate your huggingface hub cache directory. 
+
+It will be something like `~/.cache/huggingface/hub/path_to_lcm_dreamshaper_v7/tokenizer/`. On Windows, it will roughly be `C:\Users\YourUserName\.cache\huggingface\hub\models--SimianLuo--LCM_Dreamshaper_v7\snapshots\c7f9b672c65a664af57d1de926819fd79cb26eb8\tokenizer\`.
+
+Find the file `added_tokens.json` and change the contents to:
+
+```
+{
+  "<|endoftext|>": 49409,
+  "<|startoftext|>": 49408
+}
+```
+