Update app with dataset integration and improved UI

.gitignore

@@ -1,5 +1,9 @@
 /.streamlit/secrets.toml
 
+# Documentation (except README)
+*.md
+!README.md
+
 # Byte-compiled / optimized / DLL files
 __pycache__/
 *.py[cod]
@@ -129,3 +133,4 @@ dmypy.json
 
 # Pyre type checker
 .pyre/
+DEPLOYMENT.md

DEPLOYMENT.md

@@ -2,6 +2,8 @@
 
 This guide will walk you through deploying your Streamlit Image Registration app to Hugging Face Spaces using Docker.
 
+**Note**: This app loads images from a Hugging Face dataset (`amithjkamath/exampleimages`) instead of bundling them with the Space, which allows you to avoid the binary file restrictions on Hugging Face Spaces.
+
 ## Prerequisites
 
 1. A Hugging Face account (sign up at https://huggingface.co/join)
@@ -27,7 +29,7 @@ pip install huggingface_hub
 ### Login to Hugging Face
 
 ```bash
-huggingface-cli login
+hf auth login
 ```
 
 When prompted, paste your token. This will store your credentials in `~/.huggingface/token`.
@@ -71,11 +73,19 @@ Make sure your repository contains the following files:
 
 ### Required Files:
 - ✅ `dockerfile` - Your Docker configuration (already created)
-- ✅ `requirements.txt` - Python dependencies (already created)
-- ✅ `image-registration-demo.py` - Your Streamlit app
-- ✅ `rawimage.png` - The sample image used in the app
+- ✅ `requirements.txt` - Python dependencies (already created, includes `datasets` library)
+- ✅ `image-registration-demo.py` - Your Streamlit app (updated to load from HF dataset)
 - ✅ `README.md` - Documentation for your Space
 
+### ⚠️ Important: Image Dataset
+This app loads images from a separate Hugging Face dataset: `amithjkamath/exampleimages`
+
+**Why?** Hugging Face Spaces with the blank Docker template don't support binary files like images in the repository. By loading images from a dataset, we circumvent this limitation.
+
+**Your dataset**: https://huggingface.co/datasets/amithjkamath/exampleimages
+
+The app will automatically download images from this dataset when it starts. Make sure the dataset is public or set up proper authentication if it's private.
+
 ### Optional but Recommended:
 - `.gitignore` - To exclude unnecessary files
 - `LICENSE` - Your license file
@@ -162,8 +172,8 @@ Thumbs.db
 
 ```bash
 # Make sure all your files are committed
-git add dockerfile requirements.txt image-registration-demo.py rawimage.png README.md
-git commit -m "Initial deployment to Hugging Face Spaces"
+git add dockerfile requirements.txt image-registration-demo.py README.md
+git commit -m "Initial deployment to Hugging Face Spaces with dataset integration"
 
 # Push to Hugging Face (assuming you added the remote in Step 3)
 git push hf main
@@ -285,13 +295,13 @@ jobs:
 
 ```bash
 # Check Space status
-huggingface-cli repo info amithkamath/image-registration --repo-type space
+hf repo info amithkamath/image-registration --repo-type space
 
 # View Space logs (if available via CLI)
-huggingface-cli repo logs amithkamath/image-registration --repo-type space
+hf repo logs amithkamath/image-registration --repo-type space
 
 # Delete and recreate Space (careful!)
-huggingface-cli repo delete amithkamath/image-registration --repo-type space
+hf repo delete amithkamath/image-registration --repo-type space
 ```
 
 ## Resources

QUICKSTART.md

@@ -7,7 +7,7 @@
 pip install huggingface_hub
 
 # 2. Login with your token
-huggingface-cli login
+hf auth login
 
 # 3. Run the deployment script
 ./deploy.sh
@@ -19,7 +19,7 @@ huggingface-cli login
 
 ```bash
 # 1. Login to Hugging Face
-huggingface-cli login
+hf auth login
 
 # 2. Add Hugging Face remote
 git remote add hf https://huggingface.co/spaces/amithkamath/image-registration
@@ -79,7 +79,7 @@ Then set as environment variable in Space settings.
 ## 🐛 Common Issues
 
 ### "Authentication failed"
-→ Run `huggingface-cli login` again with a valid token
+→ Run `hf auth login` again with a valid token
 
 ### "Build failed"
 → Check logs at the Space URL, verify dockerfile and requirements.txt
@@ -94,11 +94,12 @@ Then set as environment variable in Space settings.
 
 Ensure these files are in your repo:
 - ✅ `dockerfile` - Docker configuration
-- ✅ `requirements.txt` - Python dependencies  
-- ✅ `image-registration-demo.py` - Your Streamlit app
-- ✅ `rawimage.png` - Sample image
+- ✅ `requirements.txt` - Python dependencies (includes `datasets` library)
+- ✅ `image-registration-demo.py` - Your Streamlit app (loads from HF dataset)
 - ✅ `README.md` - With Hugging Face metadata
 
+**Note**: Images are loaded from the HF dataset `amithjkamath/exampleimages`, not from local files. This avoids binary file restrictions on Hugging Face Spaces.
+
 ## 🔄 Update Workflow
 
 ```bash

deploy.sh

@@ -15,17 +15,17 @@ YELLOW='\033[1;33m'
 RED='\033[0;31m'
 NC='\033[0m' # No Color
 
-# Check if huggingface-cli is installed
-if ! command -v huggingface-cli &> /dev/null; then
+# Check if hf CLI is installed
+if ! command -v hf &> /dev/null; then
     echo -e "${YELLOW}⚠️  Hugging Face CLI not found. Installing...${NC}"
     pip install huggingface_hub
 fi
 
 # Check if logged in
-if ! huggingface-cli whoami &> /dev/null; then
+if ! hf whoami &> /dev/null; then
     echo -e "${YELLOW}⚠️  Not logged in to Hugging Face${NC}"
     echo "Please login with your Hugging Face token:"
-    huggingface-cli login
+    hf auth login
 fi
 
 echo -e "${GREEN}✅ Hugging Face CLI ready${NC}"
@@ -49,7 +49,10 @@ fi
 
 echo ""
 echo "Files to be deployed:"
-git ls-files | grep -E "(dockerfile|requirements\.txt|.*\.py|.*\.png|README\.md|LICENSE)"
+git ls-files | grep -E "(dockerfile|requirements\.txt|.*\.py|README\.md|LICENSE)"
+echo ""
+echo "📊 Note: Images are loaded from HF dataset (amithjkamath/exampleimages)"
+echo "   No need to include rawimage.png or other binary files"
 echo ""
 
 # Confirm deployment
@@ -59,16 +62,24 @@ echo ""
 if [[ $REPLY =~ ^[Yy]$ ]]; then
     echo -e "${YELLOW}📦 Preparing deployment...${NC}"
     
-    # Check if there are uncommitted changes
+    # Add all essential files for the Space
+    echo "Adding files to git..."
+    git add dockerfile requirements.txt image-registration-demo.py README.md LICENSE .gitignore 2>/dev/null || true
+    
+    # Remove deleted files (like rawimage.png)
+    git add -u 2>/dev/null || true
+    
+    # Check if there are changes to commit
     if ! git diff-index --quiet HEAD --; then
-        echo -e "${YELLOW}⚠️  You have uncommitted changes. Committing them...${NC}"
-        git add dockerfile requirements.txt image-registration-demo.py rawimage.png README.md LICENSE 2>/dev/null || true
-        git commit -m "Deploy to Hugging Face Spaces"
+        echo -e "${YELLOW}⚠️  Committing changes...${NC}"
+        git commit -m "Deploy to Hugging Face Spaces - updated app with dataset integration"
+    else
+        echo -e "${GREEN}✅ No new changes to commit${NC}"
     fi
     
     echo -e "${YELLOW}🚀 Pushing to Hugging Face Spaces...${NC}"
     
-    # Push to Hugging Face
+    # Try to push to Hugging Face
     if git push hf main; then
         echo ""
         echo -e "${GREEN}✅ Deployment successful!${NC}"
@@ -83,8 +94,47 @@ if [[ $REPLY =~ ^[Yy]$ ]]; then
         echo "$SPACE_URL"
     else
         echo ""
-        echo -e "${RED}❌ Deployment failed. Check the error messages above.${NC}"
-        exit 1
+        echo -e "${RED}❌ Push failed. The remote branch has changes that aren't in your local branch.${NC}"
+        echo ""
+        echo "This typically happens when:"
+        echo "  - The Space was modified directly on Hugging Face"
+        echo "  - You're deploying from a different machine"
+        echo ""
+        echo -e "${YELLOW}Options:${NC}"
+        echo "  1. Pull and merge: git pull hf main (safer, preserves remote changes)"
+        echo "  2. Force push: Overwrite remote with your local version (will lose remote changes)"
+        echo ""
+        read -p "Do you want to FORCE PUSH and overwrite the remote? (y/n) " -n 1 -r
+        echo ""
+        
+        if [[ $REPLY =~ ^[Yy]$ ]]; then
+            echo -e "${YELLOW}⚠️  Force pushing to Hugging Face Spaces...${NC}"
+            if git push hf main --force; then
+                echo ""
+                echo -e "${GREEN}✅ Force deployment successful!${NC}"
+                echo ""
+                echo "Your app is being built at:"
+                echo "$SPACE_URL"
+                echo ""
+                echo "Check the build logs at:"
+                echo "$SPACE_URL?logs=build"
+                echo ""
+                echo "Once built, your app will be available at:"
+                echo "$SPACE_URL"
+            else
+                echo ""
+                echo -e "${RED}❌ Force push also failed. Check your permissions and network connection.${NC}"
+                exit 1
+            fi
+        else
+            echo ""
+            echo -e "${YELLOW}Force push cancelled.${NC}"
+            echo ""
+            echo "To manually resolve, run:"
+            echo "  git pull hf main"
+            echo "  git push hf main"
+            exit 1
+        fi
     fi
 else
     echo -e "${YELLOW}Deployment cancelled.${NC}"