Updated dockerfile, run.sh and readme file to fit with hugginggface space

Dockerfile

@@ -5,28 +5,35 @@
 ########################
 FROM python:3.10-slim AS runtime
 
-# -- Environment hygiene ---------------------------------------------------
+# ── Environment hygiene ────────────────────────────────────────────────────
 ENV PYTHONDONTWRITEBYTECODE=1 \
     PYTHONUNBUFFERED=1 \
     PIP_DISABLE_PIP_VERSION_CHECK=1 \
-    PIP_NO_CACHE_DIR=1
+    PIP_NO_CACHE_DIR=1 \
+    # Streamlit: suppress browser launch & telemetry inside container
+    STREAMLIT_BROWSER_GATHER_USAGE_STATS=false \
+    STREAMLIT_SERVER_HEADLESS=true
 
-# -- System deps -----------------------------------------------------------
+# ── System deps ────────────────────────────────────────────────────────────
 RUN apt-get update && \
     apt-get install -y --no-install-recommends \
-        git build-essential && \
-    rm -rf /var/lib/apt/lists/*
+        git build-essential \
+        openjdk-17-jre-headless          \
+        curl                             \
+        && rm -rf /var/lib/apt/lists/*
 
-# -- Python deps -----------------------------------------------------------
+# ── Python deps ────────────────────────────────────────────────────────────
 WORKDIR /app
 COPY requirements.txt .
-RUN pip install --upgrade pip && pip install -r requirements.txt
+RUN pip install --upgrade pip && pip install -r requirements.txt \
+    && pip install streamlit
 
-# -- Project code ----------------------------------------------------------
+# ── Project code ──────────────────────────────────────────────────────────
 COPY . .
 
-# ---- Default entrypoint (can be over-ridden) ----
-CMD ["python", "-m", "evaluation.pipeline"]
+# ── Default entrypoint  → Streamlit dashboard ─────────────────────────────
+EXPOSE 8501
+ENTRYPOINT ["streamlit", "run", "scripts/dashboard.py", "--server.port", "8501", "--server.address", "0.0.0.0"]
 
 
 ########################
@@ -34,19 +41,25 @@ CMD ["python", "-m", "evaluation.pipeline"]
 ########################
 FROM runtime AS dev
 
-# Add extra tooling useful during development & CI
+# Extra tooling for development & CI
 RUN pip install \
       black isort flake8 pytest \
       mkdocs-material
 
-# Drop into an interactive shell by default
+# Default to an interactive shell
 CMD ["/bin/bash"]
 
-
-# Production container (minimal)
-#docker build -t rag-eval .
-#docker run --rm rag-eval --help
-
-# Development container (with lint / test / docs tooling)
-#docker build -t rag-eval-dev --target dev .
-#docker run --rm -it rag-eval-dev
+###########################################################################
+# Build / run cheat-sheet                                                 #
+# ----------------------------------------------------------------------- #
+# Production container (dashboard):                                       #
+#   docker build -t rag-eval .                                            #
+#   docker run -p 8501:8501 rag-eval                                      #
+#                                                                         #
+# Alternative CLI usage:                                                  #
+#   docker run --rm rag-eval python scripts/run_experiments.py --help     #
+#                                                                         #
+# Development container (with lint/test/docs tools):                      #
+#   docker build -t rag-eval-dev --target dev .                           #
+#   docker run --rm -it rag-eval-dev                                      #
+###########################################################################

README.md

@@ -1,4 +1,15 @@
+---
+title: Regulated Domain RAG Evaluation   
+emoji: 🤖                         
+colorFrom: purple                 
+colorTo: indigo                   
+sdk: docker                       
+app_port: 8501                    
+pinned: false
+---
 ````markdown
+Hugginface spaces setup
+
 # Retrieval-Augmented Generation Evaluation Framework  
 *(Legal & Financial domains, with full regulatory-grade metrics and dashboard)*
 

run.sh

@@ -0,0 +1,55 @@
+#!/usr/bin/env bash
+# run.sh
+
+set -euo pipefail
+
+# ---- utils ---------------------------------------------------------------
+die() { echo "❌ $*" >&2; exit 1; }
+
+exists() { command -v "$1" >/dev/null 2>&1; }
+
+PY=python
+[ -n "${VIRTUAL_ENV-}" ] || die "Activate your virtualenv first (python deps)."
+
+CMD=${1:-}
+shift || true   # remove first arg if present
+
+case "${CMD}" in
+  single)
+    CONFIG=${1:-}; QUERIES=${2:-}
+    [ -f "$CONFIG" ] || die "Config YAML not found: $CONFIG"
+    [ -f "$QUERIES" ] || die "Queries JSONL not found: $QUERIES"
+    shift 2
+    ${PY} scripts/run_experiments.py --config "$CONFIG" --queries "$QUERIES" "$@"
+    ;;
+
+  grid)
+    CONFIGS=${1:-}
+    DATASETS=${2:-}
+    shift 2
+    ${PY} scripts/run_grid_experiments.py --configs ${CONFIGS} --datasets ${DATASETS} "$@"
+    ;;
+
+  dashboard)
+    if [[ "${1:-}" == "--docker" ]]; then
+      docker build -t rag-eval .         # uses Dockerfile default (Streamlit)
+      docker run -p 8501:8501 rag-eval
+    else
+      streamlit run scripts/dashboard.py
+    fi
+    ;;
+
+  *)
+    cat <<EOF
+Usage: ./run.sh <mode> [args]
+
+Modes
+-----
+single     CONFIG  QUERIES [extra run_experiments.py flags]
+grid       CONFIG_GLOB  DATASET_GLOB [extra grid flags]
+dashboard  [--docker]   # without flag runs locally
+
+EOF
+    [ -n "$CMD" ] && die "Unknown mode: $CMD"
+    ;;
+esac