Making MONAI Deploy app and MAP run as REST services on Aidoc AiOS #554

MMelQin · 2025-09-19T01:37:34Z

Adds a lightweight Flask-based REST wrapper to run a MONAI Deploy app (AISpleenSeg) with status and callback support, plus scripts and docs to test locally.

Introduces REST endpoints (/status, /process) that run the app in a background thread and optionally POST results to a callback URL
Provides a sample AISpleenSeg app wired into the wrapper, including pipeline composition and result reporting
Adds local test script and documentation for setup, data download, and endpoint testing
Package the REST service app as MAP with monai-deploy CLI and run the MAP container with docker run command for needing additional options such as volume mappings and environment variable passing.

Copilot

Pull Request Overview

Adds a lightweight Flask-based REST wrapper to run a MONAI Deploy app (AISpleenSeg) with status and callback support, plus scripts and docs to test locally.

Introduces REST endpoints (/status, /process) that run the app in a background thread and optionally POST results to a callback URL
Provides a sample AISpleenSeg app wired into the wrapper, including pipeline composition and result reporting
Adds local test script and documentation for setup, data download, and endpoint testing

Reviewed Changes

Copilot reviewed 10 out of 10 changed files in this pull request and generated 13 comments.

Show a summary per file

File	Description
platforms/aidoc/restful_app/app.py	Flask REST server, job lifecycle handling, and callback dispatch.
platforms/aidoc/restful_app/ai_spleen_seg_app/app.py	AISpleenSeg app composition and result packaging for callback.
platforms/aidoc/restful_app/ai_spleen_seg_app/init.py	Package init for AISpleenSeg; alters sys.path.
platforms/aidoc/restful_app/ai_spleen_seg_app/main.py	Entrypoint to run AISpleenSeg standalone.
platforms/aidoc/restful_app/ai_spleen_seg_app/app.yaml	App metadata and resource hints.
platforms/aidoc/restful_app/requirements.txt	Wrapper runtime dependencies (Flask, requests, SDK, MONAI, Torch, etc.).
platforms/aidoc/restful_app/ai_spleen_seg_app/requirements.txt	App-specific dependencies; overlaps with wrapper requirements.
platforms/aidoc/restful_app/env_settings_repo.sh	Example environment variable settings (model/input/output).
platforms/aidoc/test_endpoints.sh	Script to test endpoints and capture callback via netcat.
platforms/aidoc/README.md	How-to run, test, and callback payload examples.

_{Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.}

platforms/aidoc/restful_app/ai_spleen_seg_app/app.py

platforms/aidoc/restful_app/app.py

platforms/aidoc/restful_app/requirements.txt

platforms/aidoc/restful_app/ai_spleen_seg_app/requirements.txt

platforms/aidoc/restful_app/ai_spleen_seg_app/__init__.py

platforms/aidoc/README.md

Copilot

Pull Request Overview

Copilot reviewed 10 out of 10 changed files in this pull request and generated 3 comments.

_{Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.}

platforms/aidoc/restful_app/app.py

platforms/aidoc/restful_app/ai_spleen_seg_app/app.py

Copilot

Pull Request Overview

Copilot reviewed 10 out of 10 changed files in this pull request and generated 4 comments.

_{Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.}

platforms/aidoc/restful_app/ai_spleen_seg_app/app.py

platforms/aidoc/restful_app/app.py

platforms/aidoc/test_endpoints.sh

Copilot

Pull Request Overview

Copilot reviewed 10 out of 10 changed files in this pull request and generated 3 comments.

_{Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.}

platforms/aidoc/restful_app/app.py

platforms/aidoc/restful_app/ai_spleen_seg_app/app.py

mocsharp

LGTM. Tested the test_endpoints.sh script and everything look good. Thanks!

Signed-off-by: M Q <[email protected]>

…1 release Signed-off-by: M Q <[email protected]>

Signed-off-by: M Q <[email protected]>

platforms/aidoc/restful_app/app.py

Signed-off-by: Elan Somasundaram <[email protected]> Signed-off-by: chezhia <[email protected]>

Signed-off-by: chezhia <[email protected]>

… of latest holoscan SDK CUDA 12 version (#565) * Make affine and space consistent as space is properly parse by MONAI transforms Signed-off-by: M Q <[email protected]> * Typing improvements Signed-off-by: M Q <[email protected]> * Make image metadata Affine and Space consistent, either LPS or RAS Signed-off-by: M Q <[email protected]> * Update monai/deploy/operators/monai_seg_inference_operator.py Co-authored-by: Copilot <[email protected]> Signed-off-by: Ming M Qin <[email protected]> * Correct CoPilot suggested code which failed liniting Signed-off-by: M Q <[email protected]> * Fix complaint from new version of mypy Signed-off-by: M Q <[email protected]> * Support the latest holoscan SDK CUDA 12 version, holoscan-cu12 Signed-off-by: M Q <[email protected]> * Docs gen works with Python 3.10+ Signed-off-by: M Q <[email protected]> * Fix complaints on single quote vs dhouble quote for string Signed-off-by: M Q <[email protected]> * Making docs gen require python >= 3.10 Signed-off-by: M Q <[email protected]> * Fix docs build error on readthedocs, although local builds had no issues Signed-off-by: M Q <[email protected]> --------- Signed-off-by: M Q <[email protected]> Signed-off-by: Ming M Qin <[email protected]> Co-authored-by: Copilot <[email protected]>

* Update release notes for v3.3.0 Signed-off-by: M Q <[email protected]> * Update the index file Signed-off-by: M Q <[email protected]> * Bump version: 3.2.0 → 3.3.0 Signed-off-by: M Q <[email protected]> --------- Signed-off-by: M Q <[email protected]>

Signed-off-by: M Q <[email protected]>

sonarqubecloud · 2025-10-31T02:47:42Z

Quality Gate failed

Failed conditions
26.3% Duplication on New Code (required ≤ 3%)

See analysis details on SonarQube Cloud

MMelQin · 2025-10-31T02:57:56Z

SonarQubeCloud / SonarCloud Code Analysis Quality Gate failure can be ignored, because the example in this PR deliberately reuses the same example code to illustrate how to make it an REST service for Aidoc.

MMelQin requested a review from Copilot September 19, 2025 01:37

Copilot AI reviewed Sep 19, 2025

View reviewed changes

MMelQin requested a review from Copilot September 19, 2025 05:30

Copilot AI reviewed Sep 19, 2025

View reviewed changes

platforms/aidoc/restful_app/app.py Outdated Show resolved Hide resolved

platforms/aidoc/restful_app/app.py Show resolved Hide resolved

platforms/aidoc/restful_app/ai_spleen_seg_app/app.py Show resolved Hide resolved

MMelQin requested a review from Copilot September 19, 2025 05:53

MMelQin changed the title ~~Add code and doc for making MONAI apps as RESTful service on Aidoc AIOS~~ Making MONAI apps as REST service on Aidoc AiOS Sep 19, 2025

Copilot AI reviewed Sep 19, 2025

View reviewed changes

platforms/aidoc/restful_app/ai_spleen_seg_app/app.py Show resolved Hide resolved

platforms/aidoc/restful_app/app.py Show resolved Hide resolved

platforms/aidoc/restful_app/app.py Outdated Show resolved Hide resolved

platforms/aidoc/test_endpoints.sh Show resolved Hide resolved

MMelQin changed the title ~~Making MONAI apps as REST service on Aidoc AiOS~~ Making MONAI Deploy apps and MAP run as REST services on Aidoc AiOS Sep 20, 2025

MMelQin changed the title ~~Making MONAI Deploy apps and MAP run as REST services on Aidoc AiOS~~ Making MONAI Deploy app and MAP run as REST services on Aidoc AiOS Sep 20, 2025

MMelQin requested a review from Copilot September 20, 2025 02:45

Copilot AI reviewed Sep 20, 2025

View reviewed changes

platforms/aidoc/restful_app/app.py Show resolved Hide resolved

platforms/aidoc/restful_app/app.py Show resolved Hide resolved

platforms/aidoc/restful_app/ai_spleen_seg_app/app.py Show resolved Hide resolved

MMelQin requested review from bluna301 and mocsharp September 20, 2025 02:50

MMelQin force-pushed the mq/restful_poc branch from 38b22df to 6e63d95 Compare September 20, 2025 02:58

mocsharp approved these changes Sep 30, 2025

View reviewed changes

MMelQin added 13 commits October 1, 2025 00:46

Initial code for making a RESTful miscroservice with MONAI App SDK

b3f1457

Signed-off-by: M Q <[email protected]>

Removed operator local fix and use newly released MONAI App SDK v3.5.…

11f8184

…1 release Signed-off-by: M Q <[email protected]>

Removed local copy of operator that had a temp fix

cdc8b0e

Signed-off-by: M Q <[email protected]>

Add proper callback message

3164908

Signed-off-by: M Q <[email protected]>

Proper json string and security fix

ed95fb1

Signed-off-by: M Q <[email protected]>

Fix complaints

aee7695

Signed-off-by: M Q <[email protected]>

Updated readme

2967b91

Signed-off-by: M Q <[email protected]>

Update per review comments

c228ce0

Signed-off-by: M Q <[email protected]>

More update

e588068

Signed-off-by: M Q <[email protected]>

Set header

e1a73f4

Signed-off-by: M Q <[email protected]>

Added packaging and running MAP of the REST service

a92767a

Signed-off-by: M Q <[email protected]>

Add app.yaml that has missed the checkin

b4db5ea

Signed-off-by: M Q <[email protected]>

pin monai<=1.5.0 for now as 1.5.1 has breaking changes

0bc3bf5

Signed-off-by: M Q <[email protected]>

MMelQin force-pushed the mq/restful_poc branch from 5d0d972 to 0bc3bf5 Compare October 1, 2025 07:48

barakc-aidoc reviewed Oct 23, 2025

View reviewed changes

platforms/aidoc/restful_app/app.py Show resolved Hide resolved

barakc-aidoc approved these changes Oct 23, 2025

View reviewed changes

MMelQin mentioned this pull request Oct 29, 2025

Make affine and space metadata consistent as well as updating support of latest holoscan SDK CUDA 12 version #565

Merged

chezhia and others added 8 commits October 30, 2025 19:37

Add CCHMC nnUNet fifteen checkpoint application example

2e4f3bc

Signed-off-by: Elan Somasundaram <[email protected]> Signed-off-by: chezhia <[email protected]>

Update README documentation

27da8dd

Signed-off-by: Elan Somasundaram <[email protected]> Signed-off-by: chezhia <[email protected]>

flake8 fixed

b42b893

Signed-off-by: chezhia <[email protected]>

all tests pass

f9420e4

Signed-off-by: chezhia <[email protected]>

Mq/release 3.3 (#567)

0f6b5fd

* Update release notes for v3.3.0 Signed-off-by: M Q <[email protected]> * Update the index file Signed-off-by: M Q <[email protected]> * Bump version: 3.2.0 → 3.3.0 Signed-off-by: M Q <[email protected]> --------- Signed-off-by: M Q <[email protected]>

Use string enum for status

4c3dd80

Signed-off-by: M Q <[email protected]>

Fix the lovely formatting complaint

16c8b67

Signed-off-by: M Q <[email protected]>

MMelQin merged commit f17c518 into main Oct 31, 2025
4 of 5 checks passed

Making MONAI Deploy app and MAP run as REST services on Aidoc AiOS #554

Making MONAI Deploy app and MAP run as REST services on Aidoc AiOS #554

Uh oh!

Conversation

MMelQin commented Sep 19, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Uh oh!

Uh oh!

Uh oh!

Uh oh!

mocsharp left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

sonarqubecloud bot commented Oct 31, 2025

Quality Gate failed

Uh oh!

MMelQin commented Oct 31, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

MMelQin commented Sep 19, 2025 •

edited

Loading