docs(docker): adds docker information

hotosm · Nov 23, 2024 · 9351971 · 9351971
1 parent 6e5c106
commit 9351971
Show file tree

Hide file tree

Showing 2 changed files with 26 additions and 3 deletions.
diff --git a/API/requirements.txt b/API/requirements.txt
@@ -1,9 +1,9 @@
 fastapi==0.103.2
 uvicorn==0.22.0
 fairpredictor
-# tflite-runtime==2.14.0
-tensorflow==2.12.0 
-efficientnet==1.1.1
+tflite-runtime==2.14.0
+# tensorflow==2.12.0 
+# efficientnet==1.1.1
 onnx==1.17.0
 onnxruntime==1.20.1
 # hot-fair-utilities==2.0.2 ## TODO : Get rid of this after the testing with YOLOv1
diff --git a/README.md b/README.md
@@ -65,3 +65,26 @@ In order to perform load testing we use Locust , To enable this hit following co
     ```
 Populate your HOST and replace it with BASE URL of the Predictor URL 
 
+
+## Docker 
+
+### Build 
+```bash
+sudo docker build . -t fairpredictor 
+```
+
+### Run 
+```bash
+sudo docker run --rm --name fairpredictor -v $(pwd):/mnt -p 8000:8000 fairpredictor
+```
+
+### Navigate to localhost:8000 and shoot following request body 
+```json
+{
+  "bbox": [100.56228021333352, 13.685230854641182, 100.56383321235313, 13.685961853747969],
+  "checkpoint": "/mnt/tests/checkpoints/ramp/checkpoint.tflite",
+  "zoom_level": 20,
+  "source": "https://tiles.openaerialmap.org/6501a65c0906de000167e64d/0/6501a65c0906de000167e64e/{z}/{x}/{y}"
+}
+```
+