more work on readme; gif creator

README.md

@@ -1,21 +1,14 @@
 # FaceEnhance
 Enhancing faces in AI generated images.
 
-<div style="display: flex; justify-content: space-around;">
-  <div>
-    <h4>Before</h4>
-    <img src="examples/chatgpt_elon.png" alt="Elon Before" width="300"/>
-  </div>
-  <div>
-    <h4>After</h4>
-    <img src="examples/enhanced_elon.png" alt="Elon After" width="300"/>
-  </div>
+<div style="text-align: center;">
+  <img src="examples/elon_compare.gif" alt="Elon Comparison" width="600"/>
 </div>
 
 ## Installation
 
 ### Prerequisites
-- Python 3.8 or higher
+- Python 3.11 or higher
 - 1 GPU with 48GB VRAM
 - At least 50GB of free disk space
 
@@ -23,12 +16,13 @@ Enhancing faces in AI generated images.
 
 1. Set up your Hugging Face token:
    - Create a token at [Hugging Face](https://huggingface.co/settings/tokens)
-   - Set the token as an environment variable. HuggingFace requires login for downloading Flux:
+   - Set the following environment variables:
      ```
      export HUGGINGFACE_TOKEN=your_token_here
      export HF_HOME=/path/to/your/huggingface_cache
      ```
    - Models will be downloaded to `$HF_HOME` and then symlinked to `./ComfyUI/models/`
+   - Hugging Face requires login for downloading Flux
 
 2. Create the virtual environment:
    ```
@@ -46,12 +40,18 @@ This will
 - Install ComfyUI, custom nodes, and required dependencies to your venv
 - Download all required models (Flux.1-dev, ControlNet, text encoders, PuLID, and more)
 
+## Running on ComfyUI
+
+Using the ComfyUI workflows is the fastest way to get started. Run `python run_comfy.py`
+- `./workflows/FaceEnhancementProd.json` for face enhancement
+- `./workflows/FaceEmbedDist.json` for computing the face embed distance
+
+
 ## Configuration
 
 Create a .env file in the project root directory with your API keys:
 ```
 touch .env
-echo "OPENAI_API_KEY=your_openai_api_key_here" >> .env
 echo "FAL_API_KEY=your_fal_api_key_here" >> .env
 ```
 
@@ -59,20 +59,14 @@ These API keys are required for certain features of the application to work prop
 
 # Gradio Demo
 
-A web interface for the face enhancement workflow. 
+A simple web interface for the face enhancement workflow. 
 
 1. Run
 
 ```bash
 python gradio_demo.py
 ```
-
-2. Run this on a separate terminal for port-forwarding 
-```bash
-ssh -L 7860:localhost:7860 root@[IP_ADDRESS] -p [SERVER_PORT] -i [PRIVATE_KEY]
-```
-
-3. Go to http://localhost:7860
+2. Go to http://localhost:7860. You may need to enable port forwarding.
 
 ### Notes
 - The script and demo run a ComfyUI server ephemerally

examples/create_comparison_gif.py

@@ -0,0 +1,94 @@
+#!/usr/bin/env python
+import argparse
+from pathlib import Path
+from PIL import Image
+import numpy as np
+
+def create_comparison_gif(before_img_path, after_img_path, output_path=None, duration=100, frames=20):
+    """
+    Create a comparison GIF with a vertical bar revealing the 'after' image.
+    
+    Args:
+        before_img_path (str): Path to the 'before' image
+        after_img_path (str): Path to the 'after' image
+        output_path (str, optional): Path for the output GIF. Defaults to 'comparison.gif'
+        duration (int, optional): Duration of each frame in ms. Defaults to 100.
+        frames (int, optional): Number of frames in the GIF. Defaults to 20.
+    
+    Returns:
+        str: Path to the created GIF
+    """
+    # Default output path
+    if output_path is None:
+        output_path = 'comparison.gif'
+    
+    # Open images and ensure they have the same size
+    before_img = Image.open(before_img_path)
+    after_img = Image.open(after_img_path)
+    
+    # Resize if they're different
+    if before_img.size != after_img.size:
+        after_img = after_img.resize(before_img.size, Image.LANCZOS)
+    
+    width, height = before_img.size
+    
+    # Create frames for the GIF
+    gif_frames = []
+    
+    for i in range(frames + 1):
+        # Calculate position of the reveal bar
+        bar_position = int((width * i) / frames)
+        
+        # Create a new frame
+        frame = Image.new('RGBA', (width, height))
+        
+        # Paste the 'before' image
+        frame.paste(before_img, (0, 0))
+        
+        # Create a mask for the 'after' image
+        mask = Image.new('L', (width, height), 0)
+        mask_array = np.array(mask)
+        mask_array[:, :bar_position] = 255
+        mask = Image.fromarray(mask_array)
+        
+        # Paste the 'after' image with the mask
+        frame.paste(after_img, (0, 0), mask)
+        
+        # Add to frames
+        gif_frames.append(frame.convert('RGBA'))
+    
+    # Save as GIF
+    gif_frames[0].save(
+        output_path,
+        save_all=True,
+        append_images=gif_frames[1:],
+        optimize=False,
+        duration=duration,
+        loop=0,
+        disposal=2
+    )
+    
+    return output_path
+
+def main():
+    parser = argparse.ArgumentParser(description='Create a before/after comparison GIF with a sliding reveal effect')
+    parser.add_argument('before_image', help='Path to the before image')
+    parser.add_argument('after_image', help='Path to the after image')
+    parser.add_argument('--output', '-o', help='Output path for the GIF', default='comparison.gif')
+    parser.add_argument('--duration', '-d', type=int, help='Duration of each frame in ms', default=100)
+    parser.add_argument('--frames', '-f', type=int, help='Number of frames to generate', default=20)
+    
+    args = parser.parse_args()
+    
+    output_path = create_comparison_gif(
+        args.before_image,
+        args.after_image,
+        args.output,
+        args.duration,
+        args.frames
+    )
+    
+    print(f"Created comparison GIF: {output_path}")
+
+if __name__ == "__main__":
+    main() 

run.py

@@ -15,5 +15,4 @@ def run_comfyui():
 
 if __name__ == "__main__":
     run_comfyui()
-    print(
-        f"Now run port-forwarding\nssh -L {PORT}:localhost:{PORT} root@[IP_ADDRESS] -p [RUNPOD_PORT] -i ~/.ssh/[PRIVATE_KEY_NAME]")
+    print(f"Enable port-forwarding\nssh -L {PORT}:localhost:{PORT} [NAME]@[IP_ADDRESS] -p [SERVER_PORT] -i [PRIVATE_KEY]")