adding hf deployment

DEPLOYMENT.md

@@ -0,0 +1,309 @@
+# Deploying to Hugging Face Spaces - Complete Guide
+
+This guide will walk you through deploying your Streamlit Image Registration app to Hugging Face Spaces using Docker.
+
+## Prerequisites
+
+1. A Hugging Face account (sign up at https://huggingface.co/join)
+2. Git installed on your local machine
+3. Your Space already created at: https://huggingface.co/spaces/amithkamath/image-registration
+
+## Step 1: Set Up Hugging Face CLI and Authentication
+
+### Install Hugging Face CLI
+```bash
+pip install huggingface_hub
+```
+
+### Create a Hugging Face Token
+
+1. Go to https://huggingface.co/settings/tokens
+2. Click on "New token"
+3. Give it a descriptive name (e.g., "image-registration-deploy")
+4. Select "Write" access (required for pushing to your Space)
+5. Click "Generate token"
+6. **Important**: Copy and save this token securely - you won't be able to see it again!
+
+### Login to Hugging Face
+
+```bash
+huggingface-cli login
+```
+
+When prompted, paste your token. This will store your credentials in `~/.huggingface/token`.
+
+Alternatively, you can set it as an environment variable:
+```bash
+export HF_TOKEN=your_token_here
+```
+
+## Step 2: Configure Git for Hugging Face
+
+Hugging Face Spaces uses Git LFS (Large File Storage) for large files. Set up Git LFS:
+
+```bash
+# Install git-lfs if you haven't already
+# On macOS:
+brew install git-lfs
+
+# Initialize git-lfs
+git lfs install
+```
+
+## Step 3: Clone Your Hugging Face Space
+
+```bash
+# Clone your space repository
+git clone https://huggingface.co/spaces/amithkamath/image-registration
+cd image-registration
+```
+
+Alternatively, if you want to push from your existing local repository:
+
+```bash
+# In your current repo directory
+git remote add hf https://huggingface.co/spaces/amithkamath/image-registration
+```
+
+## Step 4: Prepare Your Files
+
+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
+- ✅ `README.md` - Documentation for your Space
+
+### Optional but Recommended:
+- `.gitignore` - To exclude unnecessary files
+- `LICENSE` - Your license file
+
+### Create a README.md for Hugging Face Space
+
+Create or update your `README.md` with proper metadata at the top:
+
+```markdown
+---
+title: Image Registration Demo
+emoji: 🔄
+colorFrom: blue
+colorTo: green
+sdk: docker
+pinned: false
+license: mit
+---
+
+# Image Registration Demo
+
+This is a demonstration of how transformation matrices affect registration for the affine case.
+
+[Rest of your existing README content...]
+```
+
+## Step 5: Set Up Secrets (for Password Protection)
+
+Your app uses `st.secrets` for password protection. You need to set this up in Hugging Face Spaces:
+
+1. Go to your Space settings: https://huggingface.co/spaces/amithkamath/image-registration/settings
+2. Scroll down to "Repository secrets"
+3. Add secrets as needed
+
+For Streamlit secrets, create a `.streamlit/secrets.toml` file locally (DO NOT commit this to git):
+
+```toml
+[passwords]
+username1 = "password1"
+username2 = "password2"
+```
+
+Then in Hugging Face Space settings, add each secret:
+- Key: `STREAMLIT_SECRETS`
+- Value: The entire contents of your `secrets.toml` file
+
+Alternatively, you can mount secrets as environment variables and modify your app to read from environment variables instead.
+
+## Step 6: Update .gitignore
+
+Create or update `.gitignore` to exclude sensitive and unnecessary files:
+
+```
+# Python
+__pycache__/
+*.py[cod]
+*$py.class
+*.so
+.Python
+env/
+venv/
+.venv
+
+# Streamlit
+.streamlit/secrets.toml
+
+# IDE
+.vscode/
+.idea/
+*.swp
+*.swo
+
+# OS
+.DS_Store
+Thumbs.db
+
+# Other
+*.log
+```
+
+## Step 7: Deploy to Hugging Face Spaces
+
+### Method A: Push from Your Existing Repository
+
+```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"
+
+# Push to Hugging Face (assuming you added the remote in Step 3)
+git push hf main
+```
+
+### Method B: Clone and Deploy
+
+If you cloned the HF space in Step 3:
+
+```bash
+# Copy your files to the cloned space directory
+cp /path/to/your/repo/* /path/to/cloned/space/
+
+# Add and commit
+git add .
+git commit -m "Deploy Streamlit app with Docker"
+
+# Push to Hugging Face
+git push origin main
+```
+
+### Method C: Using Hugging Face Hub Python API
+
+```python
+from huggingface_hub import HfApi
+
+api = HfApi()
+
+# Upload files
+api.upload_folder(
+    folder_path=".",
+    repo_id="amithkamath/image-registration",
+    repo_type="space",
+    ignore_patterns=[".git/*", "__pycache__/*", ".streamlit/secrets.toml"]
+)
+```
+
+## Step 8: Monitor Deployment
+
+1. Go to your Space: https://huggingface.co/spaces/amithkamath/image-registration
+2. Click on the "Logs" tab to see build progress
+3. The build process will:
+   - Build your Docker image
+   - Install dependencies
+   - Start your Streamlit app
+4. Once completed, your app will be available at the Space URL
+
+## Step 9: Troubleshooting
+
+### Build Fails
+- Check the logs in the "Logs" tab
+- Verify all dependencies are correctly specified in `requirements.txt`
+- Ensure the Dockerfile syntax is correct
+
+### App Doesn't Start
+- Check if the correct port (7860) is being used
+- Verify the CMD in Dockerfile is correct
+- Check for Python errors in the logs
+
+### Secrets Not Working
+- Ensure secrets are properly set in Space settings
+- Verify the app can access them correctly
+
+### Image Not Found
+- Make sure `rawimage.png` is committed and pushed to the repository
+- Check file paths are correct (relative to the working directory)
+
+## Step 10: Update Your Deployment
+
+When you want to update your app:
+
+```bash
+# Make changes locally
+git add .
+git commit -m "Description of changes"
+git push hf main
+```
+
+The Space will automatically rebuild and redeploy.
+
+## Advanced: Continuous Deployment from GitHub
+
+If you want to maintain your code on GitHub and automatically deploy to Hugging Face:
+
+1. Keep your main repository on GitHub
+2. Set up a GitHub Action to push to Hugging Face on every commit to main
+3. Create `.github/workflows/deploy-to-hf.yml`:
+
+```yaml
+name: Deploy to Hugging Face Spaces
+
+on:
+  push:
+    branches:
+      - main
+
+jobs:
+  sync:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+        with:
+          fetch-depth: 0
+          lfs: true
+      
+      - name: Push to Hugging Face Space
+        env:
+          HF_TOKEN: ${{ secrets.HF_TOKEN }}
+        run: |
+          git config --global user.email "github-actions@github.com"
+          git config --global user.name "GitHub Actions"
+          git remote add hf https://amithkamath:$HF_TOKEN@huggingface.co/spaces/amithkamath/image-registration
+          git push hf main --force
+```
+
+4. Add your HF_TOKEN as a secret in your GitHub repository settings
+
+## Useful Commands
+
+```bash
+# Check Space status
+huggingface-cli 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
+
+# Delete and recreate Space (careful!)
+huggingface-cli repo delete amithkamath/image-registration --repo-type space
+```
+
+## Resources
+
+- [Hugging Face Spaces Docker Documentation](https://huggingface.co/docs/hub/spaces-sdks-docker)
+- [Hugging Face Spaces Overview](https://huggingface.co/docs/hub/spaces-overview)
+- [Streamlit Documentation](https://docs.streamlit.io/)
+- [Git LFS Documentation](https://git-lfs.github.com/)
+
+## Support
+
+If you encounter issues:
+1. Check the [Hugging Face Forums](https://discuss.huggingface.co/)
+2. Review the [Spaces FAQ](https://huggingface.co/docs/hub/spaces-faq)
+3. Open an issue in the Hugging Face Hub repository

QUICKSTART.md

@@ -0,0 +1,143 @@
+# Quick Reference - Deploying to Hugging Face Spaces
+
+## 🚀 Quick Start (Easiest Method)
+
+```bash
+# 1. Install Hugging Face CLI
+pip install huggingface_hub
+
+# 2. Login with your token
+huggingface-cli login
+
+# 3. Run the deployment script
+./deploy.sh
+```
+
+## 📝 Manual Deployment Steps
+
+### First Time Setup
+
+```bash
+# 1. Login to Hugging Face
+huggingface-cli login
+
+# 2. Add Hugging Face remote
+git remote add hf https://huggingface.co/spaces/amithkamath/image-registration
+
+# 3. Push to deploy
+git push hf main
+```
+
+### Subsequent Deployments
+
+```bash
+# 1. Commit your changes
+git add .
+git commit -m "Your update message"
+
+# 2. Push to deploy
+git push hf main
+```
+
+## 🔑 Getting Your Hugging Face Token
+
+1. Go to: https://huggingface.co/settings/tokens
+2. Click "New token"
+3. Name: "image-registration-deploy"
+4. Access: **Write**
+5. Click "Generate token"
+6. Copy and save the token
+
+## 🔒 Setting Up Secrets (Password Protection)
+
+Your app uses password protection. You need to configure secrets:
+
+### Option 1: Via Hugging Face UI (Recommended)
+
+1. Go to: https://huggingface.co/spaces/amithkamath/image-registration/settings
+2. Scroll to "Repository secrets"
+3. Add secrets for your usernames/passwords
+
+### Option 2: Create secrets.toml file
+
+Create `.streamlit/secrets.toml` (locally, DO NOT commit):
+
+```toml
+[passwords]
+your_username = "your_password"
+another_user = "another_password"
+```
+
+Then set as environment variable in Space settings.
+
+## 📊 Monitoring Your Deployment
+
+- **Space URL**: https://huggingface.co/spaces/amithkamath/image-registration
+- **Build Logs**: https://huggingface.co/spaces/amithkamath/image-registration?logs=build
+- **Settings**: https://huggingface.co/spaces/amithkamath/image-registration/settings
+
+## 🐛 Common Issues
+
+### "Authentication failed"
+→ Run `huggingface-cli login` again with a valid token
+
+### "Build failed"
+→ Check logs at the Space URL, verify dockerfile and requirements.txt
+
+### "App doesn't start"
+→ Ensure port 7860 is used and Streamlit command is correct in dockerfile
+
+### "Secrets not working"
+→ Verify secrets are set in Space settings, check key names match your code
+
+## 📁 Required Files
+
+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
+- ✅ `README.md` - With Hugging Face metadata
+
+## 🔄 Update Workflow
+
+```bash
+# 1. Make changes to your code
+vim image-registration-demo.py
+
+# 2. Test locally
+streamlit run image-registration-demo.py
+
+# 3. Commit and push
+git add .
+git commit -m "Update: description"
+git push hf main
+
+# 4. Monitor deployment
+# Visit: https://huggingface.co/spaces/amithkamath/image-registration
+```
+
+## 🛠️ Testing Locally with Docker
+
+Before deploying, test your Docker setup locally:
+
+```bash
+# Build the image
+docker build -t image-registration .
+
+# Run the container
+docker run -p 7860:7860 image-registration
+
+# Open browser
+open http://localhost:7860
+```
+
+## 📚 Full Documentation
+
+For detailed instructions, see: [DEPLOYMENT.md](./DEPLOYMENT.md)
+
+## 🆘 Need Help?
+
+- [Hugging Face Spaces Docs](https://huggingface.co/docs/hub/spaces-sdks-docker)
+- [Hugging Face Forums](https://discuss.huggingface.co/)
+- [Streamlit Docs](https://docs.streamlit.io/)

README.md

@@ -1,3 +1,13 @@
+---
+title: Image Registration Demo
+emoji: 🔄
+colorFrom: blue
+colorTo: green
+sdk: docker
+pinned: false
+license: mit
+---
+
 # image-registration
 
 This is a demonstration of how transformation matrices affect registration for the affine case.

deploy.sh

@@ -0,0 +1,92 @@
+#!/bin/bash
+
+# Quick deployment script for Hugging Face Spaces
+# This script helps you deploy your Streamlit app to Hugging Face Spaces
+
+set -e
+
+echo "🚀 Hugging Face Spaces Deployment Script"
+echo "=========================================="
+echo ""
+
+# Colors for output
+GREEN='\033[0;32m'
+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
+    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
+    echo -e "${YELLOW}⚠️  Not logged in to Hugging Face${NC}"
+    echo "Please login with your Hugging Face token:"
+    huggingface-cli login
+fi
+
+echo -e "${GREEN}✅ Hugging Face CLI ready${NC}"
+echo ""
+
+# Space details
+SPACE_ID="amithkamath/image-registration"
+SPACE_URL="https://huggingface.co/spaces/$SPACE_ID"
+
+echo "Target Space: $SPACE_ID"
+echo "Space URL: $SPACE_URL"
+echo ""
+
+# Check if remote exists
+if git remote | grep -q "^hf$"; then
+    echo -e "${GREEN}✅ Hugging Face remote already configured${NC}"
+else
+    echo -e "${YELLOW}⚠️  Adding Hugging Face remote...${NC}"
+    git remote add hf "https://huggingface.co/spaces/$SPACE_ID"
+fi
+
+echo ""
+echo "Files to be deployed:"
+git ls-files | grep -E "(dockerfile|requirements\.txt|.*\.py|.*\.png|README\.md|LICENSE)"
+echo ""
+
+# Confirm deployment
+read -p "Do you want to deploy these files to $SPACE_ID? (y/n) " -n 1 -r
+echo ""
+
+if [[ $REPLY =~ ^[Yy]$ ]]; then
+    echo -e "${YELLOW}📦 Preparing deployment...${NC}"
+    
+    # Check if there are uncommitted changes
+    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"
+    fi
+    
+    echo -e "${YELLOW}🚀 Pushing to Hugging Face Spaces...${NC}"
+    
+    # Push to Hugging Face
+    if git push hf main; then
+        echo ""
+        echo -e "${GREEN}✅ 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}❌ Deployment failed. Check the error messages above.${NC}"
+        exit 1
+    fi
+else
+    echo -e "${YELLOW}Deployment cancelled.${NC}"
+    exit 0
+fi

dockerfile

@@ -0,0 +1,42 @@
+# Read the doc: https://huggingface.co/docs/hub/spaces-sdks-docker
+# Dockerfile for Streamlit Image Registration Demo
+
+FROM python:3.11-slim
+
+# Install system dependencies required for OpenCV
+RUN apt-get update && apt-get install -y \
+    freeglut3-dev \
+    libgtk2.0-dev \
+    libgl1-mesa-glx \
+    libglib2.0-0 \
+    libsm6 \
+    libxext6 \
+    libxrender-dev \
+    && rm -rf /var/lib/apt/lists/*
+
+# Create user
+RUN useradd -m -u 1000 user
+USER user
+ENV PATH="/home/user/.local/bin:$PATH"
+
+# Set working directory
+WORKDIR /app
+
+# Copy requirements and install Python dependencies
+COPY --chown=user ./requirements.txt requirements.txt
+RUN pip install --no-cache-dir --upgrade -r requirements.txt
+
+# Copy application files
+COPY --chown=user . /app
+
+# Expose Streamlit default port
+EXPOSE 7860
+
+# Set Streamlit configuration
+ENV STREAMLIT_SERVER_PORT=7860
+ENV STREAMLIT_SERVER_ADDRESS=0.0.0.0
+ENV STREAMLIT_SERVER_HEADLESS=true
+ENV STREAMLIT_BROWSER_GATHER_USAGE_STATS=false
+
+# Run Streamlit app
+CMD ["streamlit", "run", "image-registration-demo.py", "--server.port=7860", "--server.address=0.0.0.0"]

pyproject.toml

@@ -0,0 +1,12 @@
+[project]
+name = "image-registration"
+version = "0.1.0"
+description = "This is a demonstration of how transformation matrices affect registration for the affine case."
+readme = "README.md"
+requires-python = ">=3.11.9"
+dependencies = [
+    "numpy>=2.2.6",
+    "opencv-python-headless>=4.12.0.88",
+    "pillow>=12.0.0",
+    "streamlit>=1.51.0",
+]

requirements.txt

@@ -1,4 +1,4 @@
-opencv-python-headless
-streamlit
-Pillow
-numpy
+numpy>=2.2.6
+opencv-python-headless>=4.12.0.88
+pillow>=12.0.0
+streamlit>=1.51.0