Deploy latest YOLO model and app (version 20250422.7)

README.md

@@ -1,6 +1,21 @@
-# YOLO Segmentation Model Server (Gradio)
+---
+title: ClusterFlux
+emoji: 🧬
+colorFrom: blue
+colorTo: indigo
+sdk: gradio
+sdk_version: "4.0.0"
+app_file: app.py
+pinned: false
+---
 
-This subproject provides a Gradio web app and API endpoint for your YOLO segmentation model.
+# ClusterFlux: YOLO Segmentation Model Server
+
+**ClusterFlux** is an interactive and API-ready Gradio Space for orbital streak image segmentation. It serves a YOLO-based segmentation model, with version tracking and reproducibility features for scientific workflows.
+
+- **Model version** is shown in the UI and included in API responses.
+- **Weights** are managed with Git LFS for large file support.
+- **Designed for integration** with annotation tools (e.g., CVAT) and downstream astronomical data pipelines.
 
 ## Quickstart
 
@@ -19,6 +34,17 @@ python app.py
 3. Deploy to [Hugging Face Spaces](https://huggingface.co/spaces):
    - Push this directory to a new Space as a Gradio app.
 
+## Usage
+
+- Upload an image to receive a segmentation mask generated by the latest YOLO model.
+- The current model version is always visible for traceability.
+- For programmatic access, use the Gradio API endpoint; the response includes both the mask and version.
+
+## Deployment Workflow
+
+- Model weights are copied into `weights/best.pt` and versioned via the `VERSION` file.
+- `deploy.sh` automates model update and Hugging Face Space deployment, with Git LFS support.
+
 ## Integration
 - Replace the dummy `segment` function in `app.py` with your YOLO model inference code.
 - The API will accept an image and return a segmentation mask (as an image).
@@ -26,3 +52,11 @@ python app.py
 ## Notes
 - Add any additional dependencies to `requirements.txt` as needed.
 - For Spaces, ensure your model weights are included or downloadable.
+
+## Citation & Context
+
+This tool is part of the Swinburne DECam synthetic data and galaxy segmentation research project. For scientific use, please cite appropriately and refer to the project thesis for detailed methodology and rationale.
+
+---
+
+For more details, see the [Hugging Face Spaces config reference](https://huggingface.co/docs/hub/spaces-config-reference).