Metadata-Version: 2.1
Name: monai-deploy-app-sdk
Version: 0.1.0a2
Summary: A framework and associated tools to design, verify and analyze performance of MONAI apps
Home-page: https://monai.io/
Author: MONAI Consortium
Author-email: monai.contact@gmail.com
License: Apache License 2.0
Project-URL: Documentation, https://docs.monai.io/
Project-URL: Bug Tracker, https://github.com/Project-MONAI/monai-deploy-app-sdk/issues
Project-URL: Source Code, https://github.com/Project-MONAI/monai-deploy-app-sdk
Platform: OS Independent
Requires-Python: >=3.6
Description-Content-Type: text/markdown; charset=UTF-8
Provides-Extra: all
Provides-Extra: cucim
License-File: LICENSE

<p align="center">
<img src="https://raw.githubusercontent.com/Project-MONAI/MONAI/dev/docs/images/MONAI-logo-color.png" width="50%" alt='project-monai'>
</p>

# MONAI Deploy Application SDK

MONAI Deploy Application SDK offers a framework and associated tools to design, verify and analyze the performance of AI-driven applications in the healthcare domain.

## Features

> _The codebase is currently under active development._

- Pythonic Framework for app development
- A mechanism to locally run an app via App Runner
- A lightweight app analytics module
- A lightweight 2D/3D visualization module
- A development console
- A set of sample applications
- API documentation & User's Guide

## Installation

To install [the current release](https://pypi.org/project/monai-deploy-app-sdk/), you can simply run:

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

## Getting Started

```bash
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 -t simple_app:latest -l DEBUG

# Run the app with docker image and input file locally
monai-deploy run simple_app:latest examples/apps/simple_imaging_app/brain_mr_input.jpg output
```

[MedNIST demo](TBD) is available on Colab.

[Examples](https://github.com/Project-MONAI/monai-deploy-app-sdk/tree/main/examples) and [notebook tutorials](https://github.com/Project-MONAI/monai-deploy-app-sdk/tree/main/notebooks) are located at [Project-MONAI/monai-deploy-app-sdk](https://github.com/Project-MONAI/monai-deploy-app-sdk).

Technical documentation is available at [docs.monai.io](https://docs.monai.io).

## Contributing

For local development, please execute the following command:

```bash
./run setup
```

This will set up the development environment, installing necessary packages.

For guidance on making a contribution to MONAI Deploy Application SDK, see the [contributing guidelines](CONTRIBUTING.md).

## Community

Join the conversation on Twitter [@ProjectMONAI](https://twitter.com/ProjectMONAI) or join our [Slack channel](https://forms.gle/QTxJq3hFictp31UM9).

## Links

- Website: <https://monai.io>
- API documentation: <https://docs.monai.io/projects/deploy>
- Code: <https://github.com/Project-MONAI/monai-deploy-app-sdk>
- Project tracker: <https://github.com/Project-MONAI/monai-deploy-app-sdk/projects>
- Issue tracker: <https://github.com/Project-MONAI/monai-deploy-app-sdk/issues>
- Wiki: <https://github.com/Project-MONAI/monai-deploy-app-sdk/wiki>
- Test status: <https://github.com/Project-MONAI/monai-deploy-app-sdk/actions>
- PyPI package: <https://pypi.org/project/monai-deploy-app-sdk>
<!-- - Docker Hub: <https://hub.docker.com/r/projectmonai/monai-deploy-app-sdk> -->


