initial setup

.gitignore

@@ -0,0 +1,141 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+pip-wheel-metadata/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# Pickle files
+*.pkl
+
+# Various files
+ignored
+debug
+*.zip
+lc0
+!bin/lc0
+wandb
+**/.DS_Store
+
+*secret*
+.artifacts

.python-version

@@ -0,0 +1 @@
+3.9

Dockerfile

@@ -0,0 +1,18 @@
+# Read the doc: https://huggingface.co/docs/hub/spaces-sdks-docker
+# you will also find guides on how best to write your Dockerfile
+
+FROM python:3.9
+
+RUN useradd -m -u 1000 user
+USER user
+ENV PATH="/home/user/.local/bin:$PATH"
+
+WORKDIR /app
+
+RUN pip install uv --no-cache-dir
+COPY --chown=user ./pyproject.toml pyproject.toml
+COPY --chown=user ./uv.lock uv.lock
+RUN uv sync
+
+COPY --chown=user . /app
+ENTRYPOINT ["/app/entrypoint.sh"]

Makefile

@@ -0,0 +1,9 @@
+.PHONY dev:
+dev:
+	@echo "Starting the application..."
+	@uv run uvicorn api.main:app --reload
+
+.PHONY start:
+start:
+	@echo "Starting the application..."
+	@uv run uvicorn api.main:app --host 0.0.0.0 --port 8000

README.md

@@ -1,10 +1,10 @@
 ---
-title: Team13.4
-emoji: 😻
+title: Team 13.4
+emoji: 🛰️
 colorFrom: red
 colorTo: yellow
 sdk: docker
 pinned: false
 ---
 
-Check out the configuration reference at https://huggingface.co/docs/hub/spaces-config-reference
+# Team 13.4

api/auth.py

@@ -0,0 +1,18 @@
+"""
+Authentication module for API
+"""
+
+from fastapi import HTTPException, Security
+from fastapi.security import api_key
+
+from api import constants
+
+api_key_header = api_key.APIKeyHeader(name="X-API-KEY")
+
+
+async def validate_api_key(key: str = Security(api_key_header)):
+    if constants.X_API_KEY == "":
+        raise HTTPException(status_code=500, detail="API Key is not set in the server")
+    if key != constants.X_API_KEY:
+        raise HTTPException(status_code=401, detail="Unauthorized - API Key is wrong")
+    return None

api/constants.py

@@ -0,0 +1,7 @@
+"""
+Constants for the whole API.
+"""
+
+import os
+
+X_API_KEY = os.environ.get("X_API_KEY", "")

api/inference/router.py

@@ -0,0 +1,35 @@
+"""
+Generate router
+"""
+
+import logging
+from contextlib import asynccontextmanager
+
+from fastapi import APIRouter
+
+from api.schema import SuccessDetail
+
+
+@asynccontextmanager
+async def lifespan(app: APIRouter):
+    logger = logging.getLogger("uvicorn")
+    logger.info("Starting inference router...")
+    yield
+    logger.info("Shutting down inference router...")
+
+
+router = APIRouter(
+    lifespan=lifespan,
+)
+
+
+@router.get(
+    "/",
+    status_code=200,
+    response_model=SuccessDetail,
+)
+async def home():
+    """
+    Submodule home page.
+    """
+    return {"success": "Welcome to the inference submodule!"}

api/inference/schema.py

@@ -0,0 +1,28 @@
+"""
+Schema for the inference endpoint
+"""
+
+from pydantic import BaseModel, validator
+from enum import Enum
+
+class Sex(str, Enum):
+    male = "m"
+    female = "f"
+
+
+class Patient(BaseModel):
+    age: int
+    sex: Sex
+
+    @validator('age')
+    def patient_age_must_be_legit(cls, v):
+        if v < 18:
+            raise ValueError('age must be at least 18')
+        if v > 100:
+            raise ValueError('age must be at most 100')
+        return v
+    
+class InferenceRequest(BaseModel):
+
+    model_name: str
+    patient: Patient

api/main.py

@@ -0,0 +1,66 @@
+"""
+Main API module.
+"""
+
+import logging
+from contextlib import asynccontextmanager
+
+from fastapi import FastAPI, Depends
+from fastapi.middleware.cors import CORSMiddleware
+
+from api.inference import router as inference_router
+from api.requirements import router as requirements_router
+from api import auth
+from api.schema import SuccessDetail
+
+
+@asynccontextmanager
+async def lifespan(app: FastAPI):
+    logger = logging.getLogger("uvicorn")
+    logger.info(f"Starting up...")
+    yield
+    logger.info(f"Shutting down...")
+
+
+app = FastAPI(
+    title="Team 13 API",
+    lifespan=lifespan,
+)
+
+origins = ["*"]
+app.add_middleware(
+    CORSMiddleware,
+    allow_origins=origins,
+    allow_credentials=True,
+    allow_methods=["*"],
+    allow_headers=["*"],
+)
+
+
+@app.get(
+    "/",
+    tags=["HOME"],
+    summary="Home page",
+    status_code=200,
+    response_model=SuccessDetail,
+)
+async def home():
+    """
+    Home page.
+    """
+    return {"success": "Welcome to yet another API!"}
+
+
+app.include_router(
+    requirements_router.router,
+    prefix="/requirements",
+    tags=["REQUIREMENTS"],
+    dependencies=[Depends(auth.validate_api_key)],
+)
+
+app.include_router(
+    inference_router.router,
+    prefix="/inference",
+    tags=["INFERENCE"],
+    dependencies=[Depends(auth.validate_api_key)],
+)

api/requirements/router.py

@@ -0,0 +1,35 @@
+"""
+Generate router
+"""
+
+import logging
+from contextlib import asynccontextmanager
+
+from fastapi import APIRouter
+
+from api.schema import SuccessDetail
+
+
+@asynccontextmanager
+async def lifespan(app: APIRouter):
+    logger = logging.getLogger("uvicorn")
+    logger.info("Starting requirements router...")
+    yield
+    logger.info("Shutting down requirements router...")
+
+
+router = APIRouter(
+    lifespan=lifespan,
+)
+
+
+@router.get(
+    "/",
+    status_code=200,
+    response_model=SuccessDetail,
+)
+async def home():
+    """
+    Submodule home page.
+    """
+    return {"success": "Welcome to the requirements submodule!"}

api/requirements/schema.py

@@ -0,0 +1,6 @@
+from pydantic import BaseModel
+
+
+class RequirementsRequest(BaseModel):
+
+    model_name: str

api/schema.py

@@ -0,0 +1,33 @@
+"""
+Global API Schema
+"""
+
+from pydantic import BaseModel
+
+
+class ErrorDetail(BaseModel):
+    error: str
+
+    model_config = {
+        "json_schema_extra": {
+            "examples": [
+                {
+                    "error": "description of the error",
+                }
+            ],
+        }
+    }
+
+
+class SuccessDetail(BaseModel):
+    success: str
+
+    model_config = {
+        "json_schema_extra": {
+            "examples": [
+                {
+                    "success": "description of the success",
+                }
+            ],
+        }
+    }

entry.sh

@@ -0,0 +1,4 @@
+# Entrypoint
+
+echo "Starting the application..."
+uv run uvicorn api.main:app --host 0.0.0.0 --port 8000

pyproject.toml

@@ -0,0 +1,11 @@
+[project]
+name = "fhe"
+version = "0.0.0-dev"
+description = "Add your description here"
+readme = "README.md"
+requires-python = ">=3.9"
+dependencies = [
+    "fastapi>=0.103.2",
+    "pydantic>=1.10.18",
+    "uvicorn[standard]>=0.30.6",
+]