Skip to content

Internal Documentation

Audience

These pages document the backend service, SFAPI runner, admin tooling, and deployment infrastructure that live in the colliderml-production repository. They are written for platform operators and contributors — not for end users of the colliderml pip package.

What lives where

ConcernRepository
pip package (colliderml), benchmark tasks, HF Spaces, docs siteOpenDataDetector/ColliderML (this repo)
FastAPI backend, SFAPI runner, pipeline scripts, container image workflow, admin dashboardOpenDataDetector/colliderml-production

Pages in this section

  • Backend — FastAPI service architecture, routes, database schema, auth flow, credit ledger
  • SFAPI Runner — NERSC Superfacility API integration, sbatch templates, multi-node submission
  • Admin Dashboard — Gradio admin Space, freeze/grant/ban/usage operations, kill switch
  • Deployment — Render deploy, Docker Compose local dev, environment variables, database migrations
  • Container ImageOpenDataDetector/sw image contents, build checklist, known issues

These pages are intentionally excluded from the site navigation and search index. They are reachable only by direct URL.

Last updated:

Released under the MIT License.