Meta-Hackathon / START_HERE.md
parthpethia's picture
Add Email Triage OpenEnv environment - production-ready with 3 graded tasks and Flask API
fee8744

#!/bin/bash

Email Triage OpenEnv - Quick Start Deployment Script

This script prepares the project for deployment to HF Spaces

echo "==========================================" echo "Email Triage OpenEnv - Deployment Guide" echo "==========================================" echo ""

Check prerequisites

echo "[1] Checking Prerequisites..." python --version > /dev/null && echo " βœ“ Python installed" || exit 1 git --version > /dev/null && echo " βœ“ Git installed" || exit 1 python -c "import huggingface_hub" > /dev/null 2>&1 && echo " βœ“ Hugging Face Hub installed" || echo " βœ— Install: pip install huggingface-hub" echo ""

Display project structure

echo "[2] Project Files Ready" echo " Core: environment/ (5 files)" echo " API: app.py, inference.py" echo " Config: Dockerfile, requirements.txt" echo " Spec: openenv.yaml" echo " Docs: README.md, deployment guides" echo ""

Show what to do next

echo "[3] Next Steps for Deployment" echo "" echo " Step A: Log in to Hugging Face" echo " $ huggingface-cli login" echo " (Paste your HF token from https://huggingface.co/settings/tokens)" echo ""

echo " Step B: Create HF Space" echo " 1. Visit: https://huggingface.co/spaces" echo " 2. Click 'Create new Space'" echo " 3. Name it: email-triage" echo " 4. Select Runtime: Docker" echo " 5. Click 'Create Space'" echo ""

echo " Step C: Push Code to HF Space" echo " $ cd d:/Projects/meta-hackathon" echo " $ git init" echo " $ git add ." echo ' $ git commit -m "Initial Email Triage OpenEnv"' echo " $ git push https://huggingface.co/spaces/{YOUR-USERNAME}/email-triage main" echo ""

echo " Step D: Wait for Deployment (5-10 minutes)" echo " HF will build the Docker image automatically" echo ""

echo " Step E: Verify Deployment" echo " $ curl https://{YOUR-USERNAME}-email-triage.hf.space/health" echo " Should return: {"status":"ok"}" echo ""

echo "==========================================" echo "Status: READY FOR DEPLOYMENT" echo "==========================================" echo "" echo "Environment Requirements Met:" echo " βœ“ 3 tasks with graders (easy β†’ hard)" echo " βœ“ OpenEnv spec compliant" echo " βœ“ Reward function (0.0-1.0)" echo " βœ“ Flask REST API" echo " βœ“ Baseline inference script" echo " βœ“ Docker container ready" echo " βœ“ Full documentation" echo ""