From fafd815866a92f9b2b673f945f95fb7bfec56e03 Mon Sep 17 00:00:00 2001 From: Aakash Gupta Date: Tue, 26 May 2026 14:18:38 +0530 Subject: [PATCH] MacOS installation instructions --- README.md | 27 +++++++++++++++++++++++++++ start_services.sh | 5 +++++ 2 files changed, 32 insertions(+) diff --git a/README.md b/README.md index 9c3d15e..d7f3a27 100644 --- a/README.md +++ b/README.md @@ -107,3 +107,30 @@ MLFLOW_TRACKING_URI=http://localhost:8080 uv run modelplane annotate --annotator ``` MLFLOW_TRACKING_URI=http://localhost:8080 uv run modelplane annotate --annotator_id {annotator_id1} --annotator_id {annotator_id2} --ensemble_strategy {ensemble_strategy} --experiment expname --response_file path/to/response.csv ``` + +### Installation Instructions + +#### For MacOS + +Follow the instructions to install Docker-Desktop and start the application: + +https://docs.docker.com/desktop/setup/install/mac-install/ + + +``` +./start_services -d +``` + +_Note: The script will create three folders ../modelplane-flights, /mlflow and /flightpaths/.cache_ + +Jupyter notebook will be available at port: 8888 + +MLFlow dashboard will be available at port: 8080 + +#### For Linux + + + +#### For Windows + + diff --git a/start_services.sh b/start_services.sh index 446f9a0..6fe309c 100755 --- a/start_services.sh +++ b/start_services.sh @@ -38,6 +38,11 @@ else SSH_FLAG="" fi +mkdir -p ../modelplane-flights +mkdir -p mlruns +mkdir -p flightpaths/.cache + + docker compose down "${SERVICES[@]}" docker compose build $SSH_FLAG "${SERVICES[@]}" docker compose up $DETACHED "${SERVICES[@]}"