Xavier-Api

Backend API for the XAVIER model

Installation

Using pyproject.toml

pip install -e .

Using UV (Recommended)

uv pip install -e .

Running the API

Start the development server:

uvicorn main:app --host 0.0.0.0 --port 8080 --reload

Once running, access the interactive API documentation:

• Swagger UI: http://127.0.0.1:8080/docs
• ReDoc: http://127.0.0.1:8080/redoc

Requirements

• Python 3.8+
• Uvicorn
• FastAPI
• Pytorch
• Torchvision
• Albumentations
• Numpy
• Pillow

Notes

• Make sure to install all dependencies before running the server.
• For production, consider using a process manager and proper server settings.

🐳 Docker

Building the container

Development

docker build --build-arg MODE=dev -t xavier-api-dev .

Production

docker build --build-arg MODE=prod -t xavier-api .

Running the container

docker run -p 8080:8080 xavier-api