Skip to content

Commit 83ba4e4

Browse files
committed
added preliminary sections to design doc
1 parent 6b60e8e commit 83ba4e4

1 file changed

Lines changed: 72 additions & 0 deletions

File tree

Lines changed: 72 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,72 @@
1+
# MONAI Application Package Builder
2+
3+
## Description
4+
5+
This is a proposal for the MONAI Deploy Working Group.
6+
7+
- [Overview](#overview)
8+
- [Goal](#goal)
9+
- [Requirements](#requirements)
10+
- [Creates Deployable Single Container](#creates-deployable-single-container)
11+
- [Packages Required MAP Components](#packages-required-map-components)
12+
- [Offers Intuitive Interface](#offers-intuitive-interface)
13+
- [Input Requirements](#input-requirements)
14+
- [Converting Existing Images](#converting-existing-images)
15+
- [Architecture & Design](#architecture--design)
16+
- [Builder Specification](#builder-specification)
17+
- [Building MAP with MONAI Application](#building-map-with-monai-application)
18+
- [Building MAP from existing container](#building-map-from-existing-container)
19+
20+
## Overview
21+
Data scientists and application developers will require a utility to package their MONAI applications into deployable MONAI Application Packages (MAP). This proposal documents the specification of the initial version of the MONAI Application Package Builder (Builder).
22+
23+
### Goal
24+
25+
The goal of this proposal is to achieve clarity on the initial structure of the Builder, with regards specifically to how it should create a deployable package and the interface it should provide to users.
26+
27+
## Requirements
28+
29+
The following are requirements which need to be met by the MAP Builder specification to be considered complete and approved.
30+
31+
### Creates Deployable Single Container
32+
33+
Builder SHALL produce a functional MAP which SHALL be a deployable single containerized application
34+
35+
### Packages Required MAP Components
36+
37+
Builder SHALL package/provide all required components specified in [MONAI Application Package](./monai-application-package.md).
38+
39+
### Offers Intuitive Interface
40+
41+
Builder SHOULD provide users with an intuitive interface to package an application into a MAP.
42+
43+
Builder SHOULD provide a command-line interface for users to package an application into a MAP.
44+
45+
### Input Requirements
46+
47+
Users SHALL provide the Builder a MONAI application along with any optional pre-trained models to be packaged into a MAP.
48+
49+
### Converting Existing Images
50+
51+
Builder SHALL support converting existing container images into MAPs
52+
53+
## Architecture & Design
54+
55+
Builder SHALL accept a user supplied application and package it into a MAP
56+
57+
[!IMPORTANT]
58+
The full design and layout for a MAP produced by Builder can be found in the [MONAI Application Package](./monai-application-package.md) design document.
59+
60+
### Builder Specification
61+
62+
Builder SHALL adhere to the MAP specification when building a MAP
63+
64+
Builder SHALL be a client that supports the following features
65+
66+
#### Building MAP with MONAI Application
67+
68+
Builder SHALL support building a MAP with a user supplied MONAI application and any optional pre-trained models
69+
70+
#### Building MAP from existing container
71+
72+
Builder SHALL support building a MAP from an existing container

0 commit comments

Comments
 (0)