Skip to main content

A framework and associated tools to design, verify and analyze performance of MONAI apps

Project description

project-monai

💡 If you want to know more about MONAI Deploy WG vision, overall structure, and guidelines, please read MONAI Deploy main repo first.

MONAI Deploy App SDK

License

MONAI Deploy App SDK offers a framework and associated tools to design, develop and verify AI-driven applications in the healthcare imaging domain.

Features

  • Build medical imaging inference applications using a flexible, extensible & usable Pythonic API
  • Easy management of inference applications via programmable Directed Acyclic Graphs (DAGs)
  • Built-in operators to load DICOM data to be ingested in an inference app
  • Out-of-the-box support for in-proc PyTorch based inference
  • Easy incorporation of MONAI based pre and post transformations in the inference application
  • Package inference application with a single command into a portable MONAI Application Package
  • Locally run and debug your inference application using App Runner

User Guide

User guide is available at docs.monai.io.

Installation

To install the current release, you can simply run:

pip install monai-deploy-app-sdk  # '--pre' to install a pre-release version.

Getting Started

Getting started guide is available at here.

pip install monai-deploy-app-sdk  # '--pre' to install a pre-release version.

# Clone monai-deploy-app-sdk repository for accessing examples.
git clone https://github.com/Project-MONAI/monai-deploy-app-sdk.git
cd monai-deploy-app-sdk

# Install necessary dependencies for simple_imaging_app
pip install scikit-image

# Execute the app locally
python examples/apps/simple_imaging_app/app.py -i examples/apps/simple_imaging_app/brain_mr_input.jpg -o output

# Package app (creating MAP Docker image), using `-l DEBUG` option to see progress.
monai-deploy package examples/apps/simple_imaging_app -c simple_imaging_app/app.yaml -t simple_app:latest --platform x64-workstation -l DEBUG

# Run the app with docker image and an input file locally
## Copy a test input file to 'input' folder
mkdir -p input && rm -rf input/*
cp examples/apps/simple_imaging_app/brain_mr_input.jpg input/
## Launch the app
monai-deploy run simple_app-x64-workstation-dgpu-linux-amd64:latest -i input -o output

Tutorials

Tutorials are provided to help getting started with the App SDK, to name but a few below.

1) Creating a simple image processing app

2) Creating MedNIST Classifier app

YouTube Video (to be updated with the new version):

3) Creating a Segmentation app

YouTube Video (to be updated with the new version):

4) Creating a Segmentation app including visualization with Clara Viz

5) Creating a Segmentation app consuming a MONAI Bundle

Examples

https://github.com/Project-MONAI/monai-deploy-app-sdk/tree/main/examples/apps has example apps that you can see.

  • ai_livertumor_seg_app
  • ai_spleen_seg_app
  • ai_unetr_seg_app
  • dicom_series_to_image_app
  • mednist_classifier_monaideploy
  • simple_imaging_app

Contributing

For guidance on making a contribution to MONAI Deploy App SDK, see the contributing guidelines.

Community

To participate, please join the MONAI Deploy App SDK weekly meetings on the calendar and review the meeting notes.

Join the conversation on Twitter @ProjectMONAI or join our Slack channel.

Ask and answer questions over on MONAI Deploy App SDK's GitHub Discussions tab.

Links

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distributions

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distribution

monai_deploy_app_sdk-0.6.0-py3-none-any.whl (125.1 kB view details)

Uploaded Python 3

File details

Details for the file monai_deploy_app_sdk-0.6.0-py3-none-any.whl.

File metadata

File hashes

Hashes for monai_deploy_app_sdk-0.6.0-py3-none-any.whl
Algorithm Hash digest
SHA256 4ed41c9459c723e8f8ca817e6feb136e3b58943b0afd69d45af6bfceb01b7366
MD5 3d3abbc0eff045202e70072a465e7415
BLAKE2b-256 67df414c50600c56de434df8a794fadecddad42fcad46f1d6b162c795d54a376

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page