sql_env / specs /behavior /deployment.md
hjerpe's picture
Upload folder using huggingface_hub
5dd1bb4 verified

System Behavior: deployment

Living document. Updated by /archive-spec when features are completed. Last archived: F007 on 2026-03-28


Added

HF Spaces deployment

The SQLEnv server accepts connections on a public HuggingFace Spaces URL. Visitors can connect via WebSocket, reset an episode, execute actions (DESCRIBE, SAMPLE, QUERY, ANSWER), and receive observations without local setup. The server exposes a healthy status on /health.

Bundled Spider databases in Docker

The Docker image bundles Spider SQLite databases so the server starts without an external download step. Episodes are playable immediately after container startup.

Colab training notebook

A notebook at notebooks/train_grpo.ipynb accepts a HF Space URL, connects to SQLEnv, runs a GRPO training loop, evaluates on held-out questions, and produces matplotlib learning curves in a Colab-compatible flow.

Blog post outline

A structured outline at docs/blog-outline.md provides the narrative skeleton (hook, problem, solution, results, and try-it sections) for manual polish and HF blog submission.

Polished README experience

The repository README presents a project overview, architecture, streamlined quickstart, action reference, training artifact link, and HF Space link, without development-phase caveats.

Modified

Dockerfile runtime packaging and startup

Before: the Docker image built the server but did not bundle required database assets, and startup assumptions were local-first.

After: the Docker image includes bundled Spider SQLite assets, respects the PORT environment variable (defaulting to 8000), and runs as a non-root user for HF Spaces compatibility.