Skip to content

Commit 46baca2

Browse files
authored
Updating the SDK to use newer and updated dependencies, namely Holoscan SDK (#481)
* Updated the SDK to use Holoscan SDK v1.0, and tested apps and Notebooks Signed-off-by: M Q <mingmelvinq@nvidia.com> * Doc updates Signed-off-by: M Q <mingmelvinq@nvidia.com> * Fix typo Signed-off-by: M Q <mingmelvinq@nvidia.com> * Add Holoscan license file Signed-off-by: M Q <mingmelvinq@nvidia.com> * Add release note and editorial changes Signed-off-by: M Q <mingmelvinq@nvidia.com> * Update readme Signed-off-by: M Q <mingmelvinq@nvidia.com> * Add missing packages in the example in the Readme Signed-off-by: M Q <mingmelvinq@nvidia.com> * Add new package to make gen_docs work even just in Python 3.8 env Signed-off-by: M Q <mingmelvinq@nvidia.com> * Updated user guide Signed-off-by: M Q <mingmelvinq@nvidia.com> * Rerun the notebook to clear some warnings Signed-off-by: M Q <mingmelvinq@nvidia.com> * rerun notebook Signed-off-by: M Q <mingmelvinq@nvidia.com> * touch the file Signed-off-by: M Q <mingmelvinq@nvidia.com> * touch the file Signed-off-by: M Q <mingmelvinq@nvidia.com> * fix formatting complaints Signed-off-by: M Q <mingmelvinq@nvidia.com> * ignore the complaint Signed-off-by: M Q <mingmelvinq@nvidia.com> * touch file Signed-off-by: M Q <mingmelvinq@nvidia.com> * touch the file Signed-off-by: M Q <mingmelvinq@nvidia.com> * Successfully run after getting new clara-viz fix for Python 3.10+ Signed-off-by: M Q <mingmelvinq@nvidia.com> * specififies OS and CUDA requirements in the release note Signed-off-by: M Q <mingmelvinq@nvidia.com> * Adding a note for doc building succeeding with Python3.8 only Signed-off-by: M Q <mingmelvinq@nvidia.com> * Update docs and Notebooks Signed-off-by: M Q <mingmelvinq@nvidia.com> * Explicitly specifying GPU and CUDA12 req. Signed-off-by: M Q <mingmelvinq@nvidia.com> * Explicitly specifying GPU and CUDA12 req in README. Signed-off-by: M Q <mingmelvinq@nvidia.com> * Add ref to MONAI guide per review commnents Signed-off-by: M Q <mingmelvinq@nvidia.com> --------- Signed-off-by: M Q <mingmelvinq@nvidia.com>
1 parent a83f932 commit 46baca2

28 files changed

+2738
-4312
lines changed

CODE_OF_CONDUCT.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -67,8 +67,8 @@ members of the project's leadership.
6767

6868
## Attribution
6969

70-
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
71-
available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
70+
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.1,
71+
available at https://www.contributor-covenant.org/version/2/1/code_of_conduct
7272

7373
[homepage]: https://www.contributor-covenant.org
7474

CONTRIBUTING.md

Lines changed: 14 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,8 @@
1919

2020
Welcome to Project MONAI Deploy App SDK! We're excited you're here and want to contribute. This documentation is intended for individuals and institutions interested in contributing to MONAI Deploy App SDK. MONAI Deploy App SDK is an open-source project and, as such, its success relies on its community of contributors willing to keep improving it. Your contribution will be a valued addition to the code base; we simply ask that you read this page and understand our contribution process, whether you are a seasoned open-source contributor or whether you are a first-time contributor.
2121

22+
Please also refer to [MONAI Contributing Guide](https://github.com/Project-MONAI/MONAI/blob/dev/CONTRIBUTING.md) for general information as well as MONAI Core specifics.
23+
2224
### Communicate with us
2325

2426
We are happy to talk with you about your needs for MONAI Deploy App SDK and your ideas for contributing to the project. One way to do this is to create an issue discussing your thoughts. It might be that a very similar feature is under development or already exists, so an issue is a great starting point. If you are looking for an issue to resolve that will help Project MONAI Deploy App SDK, see the [*good first issue*](https://github.com/Project-MONAI/monai-deploy-app-sdk/labels/good%20first%20issue) and [*Contribution wanted*](https://github.com/Project-MONAI/monai-deploy-app-sdk/labels/Contribution%20wanted) labels.
@@ -74,7 +76,7 @@ Before submitting a pull request, we recommend that all linting should pass, by
7476
License information: all source code files should start with this paragraph:
7577

7678
```python
77-
# Copyright 2021 MONAI Consortium
79+
# Copyright 2021-2024 MONAI Consortium
7880
# Licensed under the Apache License, Version 2.0 (the "License");
7981
# you may not use this file except in compliance with the License.
8082
# You may obtain a copy of the License at
@@ -135,6 +137,10 @@ MONAI Deploy App SDK's code coverage report is available at [CodeCov](https://co
135137

136138
#### Building the documentation
137139

140+
:::{note}
141+
Please note that the documentation builds successfully in Python 3.8 environment, but fails with Python 3.10.
142+
:::
143+
138144
MONAI's documentation is located at `docs/`.
139145

140146
```bash
@@ -241,21 +247,22 @@ For string definition, [f-string](https://www.python.org/dev/peps/pep-0498/) is
241247

242248
### Submitting pull requests
243249

244-
TBD
250+
Please see this [general guidance](https://github.com/gabrieldemarmiesse/getting_started_open_source)
245251

246252
## The code reviewing process
247253

248-
TBD
254+
Please see this [general guidance](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/about-pull-request-reviews)
249255

250256
### Reviewing pull requests
251257

252-
TBD
258+
At least one contributor of the project needs to approve a pull request.
253259

254260
## Admin tasks
255261

256-
TBD
262+
The contributors with Admin role in the project handle admin tasks.
257263

258264
### Release a new version
259265

260-
[github ci]: https://github.com/Project-MONAI/monai-deploy-app-sdk/actions
261-
[monai-deploy-app-sdk issue list]: https://github.com/Project-MONAI/monai-deploy-app-sdk/issues
266+
[github ci](https://github.com/Project-MONAI/monai-deploy-app-sdk/actions)
267+
268+
[monai-deploy-app-sdk issue list](https://github.com/Project-MONAI/monai-deploy-app-sdk/issues)

README.md

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ MONAI Deploy App SDK offers a framework and associated tools to design, develop
2222

2323
## User Guide
2424

25-
User guide is available at [docs.monai.io](https://docs.monai.io/projects/monai-deploy-app-sdk/en/latest/).
25+
User guide is available at [docs.monai.io](https://docs.monai.io/projects/monai-deploy-app-sdk/en/stable/).
2626

2727
## Installation
2828

@@ -32,9 +32,15 @@ To install [the current release](https://pypi.org/project/monai-deploy-app-sdk/)
3232
pip install monai-deploy-app-sdk # '--pre' to install a pre-release version.
3333
```
3434

35+
Please also note the following system requirements:
36+
- Ubuntu 22.04 on X86-64 is required, as this is the only X86 platform that the underlying Holoscan SDK has been tested to support as of now.
37+
- [CUDA 12](https://developer.nvidia.com/cuda-12-0-0-download-archive) is required along with a supported NVIDIA GPU with at least 8GB of video RAM. If AI inference is not used in the example application and a GPU is not installed, at least [CUDA 12 runtime](https://pypi.org/project/nvidia-cuda-runtime-cu12/) is required, as this is one of the requirements of Holoscan SDK, in addition, the `LIB_LIBRARY_PATH` must be set to include the installed shared library, e.g. in a Python 3.8 env, ```export LD_LIBRARY_PATH=`pwd`/.venv/lib/python3.8/site-packages/nvidia/cuda_runtime/lib:$LD_LIBRARY_PATH```
38+
39+
40+
3541
## Getting Started
3642

37-
Getting started guide is available at [here](https://docs.monai.io/projects/monai-deploy-app-sdk/en/latest/getting_started/index.html).
43+
Getting started guide is available at [here](https://docs.monai.io/projects/monai-deploy-app-sdk/en/stable/getting_started/index.html).
3844

3945
```bash
4046
pip install monai-deploy-app-sdk # '--pre' to install a pre-release version.
@@ -44,7 +50,7 @@ git clone https://github.com/Project-MONAI/monai-deploy-app-sdk.git
4450
cd monai-deploy-app-sdk
4551

4652
# Install necessary dependencies for simple_imaging_app
47-
pip install scikit-image
53+
pip install matplotlib Pillow scikit-image
4854

4955
# Execute the app locally
5056
python examples/apps/simple_imaging_app/app.py -i examples/apps/simple_imaging_app/brain_mr_input.jpg -o output
Lines changed: 202 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,202 @@
1+
2+
Apache License
3+
Version 2.0, January 2004
4+
http://www.apache.org/licenses/
5+
6+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
7+
8+
1. Definitions.
9+
10+
"License" shall mean the terms and conditions for use, reproduction,
11+
and distribution as defined by Sections 1 through 9 of this document.
12+
13+
"Licensor" shall mean the copyright owner or entity authorized by
14+
the copyright owner that is granting the License.
15+
16+
"Legal Entity" shall mean the union of the acting entity and all
17+
other entities that control, are controlled by, or are under common
18+
control with that entity. For the purposes of this definition,
19+
"control" means (i) the power, direct or indirect, to cause the
20+
direction or management of such entity, whether by contract or
21+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
22+
outstanding shares, or (iii) beneficial ownership of such entity.
23+
24+
"You" (or "Your") shall mean an individual or Legal Entity
25+
exercising permissions granted by this License.
26+
27+
"Source" form shall mean the preferred form for making modifications,
28+
including but not limited to software source code, documentation
29+
source, and configuration files.
30+
31+
"Object" form shall mean any form resulting from mechanical
32+
transformation or translation of a Source form, including but
33+
not limited to compiled object code, generated documentation,
34+
and conversions to other media types.
35+
36+
"Work" shall mean the work of authorship, whether in Source or
37+
Object form, made available under the License, as indicated by a
38+
copyright notice that is included in or attached to the work
39+
(an example is provided in the Appendix below).
40+
41+
"Derivative Works" shall mean any work, whether in Source or Object
42+
form, that is based on (or derived from) the Work and for which the
43+
editorial revisions, annotations, elaborations, or other modifications
44+
represent, as a whole, an original work of authorship. For the purposes
45+
of this License, Derivative Works shall not include works that remain
46+
separable from, or merely link (or bind by name) to the interfaces of,
47+
the Work and Derivative Works thereof.
48+
49+
"Contribution" shall mean any work of authorship, including
50+
the original version of the Work and any modifications or additions
51+
to that Work or Derivative Works thereof, that is intentionally
52+
submitted to Licensor for inclusion in the Work by the copyright owner
53+
or by an individual or Legal Entity authorized to submit on behalf of
54+
the copyright owner. For the purposes of this definition, "submitted"
55+
means any form of electronic, verbal, or written communication sent
56+
to the Licensor or its representatives, including but not limited to
57+
communication on electronic mailing lists, source code control systems,
58+
and issue tracking systems that are managed by, or on behalf of, the
59+
Licensor for the purpose of discussing and improving the Work, but
60+
excluding communication that is conspicuously marked or otherwise
61+
designated in writing by the copyright owner as "Not a Contribution."
62+
63+
"Contributor" shall mean Licensor and any individual or Legal Entity
64+
on behalf of whom a Contribution has been received by Licensor and
65+
subsequently incorporated within the Work.
66+
67+
2. Grant of Copyright License. Subject to the terms and conditions of
68+
this License, each Contributor hereby grants to You a perpetual,
69+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
70+
copyright license to reproduce, prepare Derivative Works of,
71+
publicly display, publicly perform, sublicense, and distribute the
72+
Work and such Derivative Works in Source or Object form.
73+
74+
3. Grant of Patent License. Subject to the terms and conditions of
75+
this License, each Contributor hereby grants to You a perpetual,
76+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
77+
(except as stated in this section) patent license to make, have made,
78+
use, offer to sell, sell, import, and otherwise transfer the Work,
79+
where such license applies only to those patent claims licensable
80+
by such Contributor that are necessarily infringed by their
81+
Contribution(s) alone or by combination of their Contribution(s)
82+
with the Work to which such Contribution(s) was submitted. If You
83+
institute patent litigation against any entity (including a
84+
cross-claim or counterclaim in a lawsuit) alleging that the Work
85+
or a Contribution incorporated within the Work constitutes direct
86+
or contributory patent infringement, then any patent licenses
87+
granted to You under this License for that Work shall terminate
88+
as of the date such litigation is filed.
89+
90+
4. Redistribution. You may reproduce and distribute copies of the
91+
Work or Derivative Works thereof in any medium, with or without
92+
modifications, and in Source or Object form, provided that You
93+
meet the following conditions:
94+
95+
(a) You must give any other recipients of the Work or
96+
Derivative Works a copy of this License; and
97+
98+
(b) You must cause any modified files to carry prominent notices
99+
stating that You changed the files; and
100+
101+
(c) You must retain, in the Source form of any Derivative Works
102+
that You distribute, all copyright, patent, trademark, and
103+
attribution notices from the Source form of the Work,
104+
excluding those notices that do not pertain to any part of
105+
the Derivative Works; and
106+
107+
(d) If the Work includes a "NOTICE" text file as part of its
108+
distribution, then any Derivative Works that You distribute must
109+
include a readable copy of the attribution notices contained
110+
within such NOTICE file, excluding those notices that do not
111+
pertain to any part of the Derivative Works, in at least one
112+
of the following places: within a NOTICE text file distributed
113+
as part of the Derivative Works; within the Source form or
114+
documentation, if provided along with the Derivative Works; or,
115+
within a display generated by the Derivative Works, if and
116+
wherever such third-party notices normally appear. The contents
117+
of the NOTICE file are for informational purposes only and
118+
do not modify the License. You may add Your own attribution
119+
notices within Derivative Works that You distribute, alongside
120+
or as an addendum to the NOTICE text from the Work, provided
121+
that such additional attribution notices cannot be construed
122+
as modifying the License.
123+
124+
You may add Your own copyright statement to Your modifications and
125+
may provide additional or different license terms and conditions
126+
for use, reproduction, or distribution of Your modifications, or
127+
for any such Derivative Works as a whole, provided Your use,
128+
reproduction, and distribution of the Work otherwise complies with
129+
the conditions stated in this License.
130+
131+
5. Submission of Contributions. Unless You explicitly state otherwise,
132+
any Contribution intentionally submitted for inclusion in the Work
133+
by You to the Licensor shall be under the terms and conditions of
134+
this License, without any additional terms or conditions.
135+
Notwithstanding the above, nothing herein shall supersede or modify
136+
the terms of any separate license agreement you may have executed
137+
with Licensor regarding such Contributions.
138+
139+
6. Trademarks. This License does not grant permission to use the trade
140+
names, trademarks, service marks, or product names of the Licensor,
141+
except as required for reasonable and customary use in describing the
142+
origin of the Work and reproducing the content of the NOTICE file.
143+
144+
7. Disclaimer of Warranty. Unless required by applicable law or
145+
agreed to in writing, Licensor provides the Work (and each
146+
Contributor provides its Contributions) on an "AS IS" BASIS,
147+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
148+
implied, including, without limitation, any warranties or conditions
149+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
150+
PARTICULAR PURPOSE. You are solely responsible for determining the
151+
appropriateness of using or redistributing the Work and assume any
152+
risks associated with Your exercise of permissions under this License.
153+
154+
8. Limitation of Liability. In no event and under no legal theory,
155+
whether in tort (including negligence), contract, or otherwise,
156+
unless required by applicable law (such as deliberate and grossly
157+
negligent acts) or agreed to in writing, shall any Contributor be
158+
liable to You for damages, including any direct, indirect, special,
159+
incidental, or consequential damages of any character arising as a
160+
result of this License or out of the use or inability to use the
161+
Work (including but not limited to damages for loss of goodwill,
162+
work stoppage, computer failure or malfunction, or any and all
163+
other commercial damages or losses), even if such Contributor
164+
has been advised of the possibility of such damages.
165+
166+
9. Accepting Warranty or Additional Liability. While redistributing
167+
the Work or Derivative Works thereof, You may choose to offer,
168+
and charge a fee for, acceptance of support, warranty, indemnity,
169+
or other liability obligations and/or rights consistent with this
170+
License. However, in accepting such obligations, You may act only
171+
on Your own behalf and on Your sole responsibility, not on behalf
172+
of any other Contributor, and only if You agree to indemnify,
173+
defend, and hold each Contributor harmless for any liability
174+
incurred by, or claims asserted against, such Contributor by reason
175+
of your accepting any such warranty or additional liability.
176+
177+
END OF TERMS AND CONDITIONS
178+
179+
APPENDIX: How to apply the Apache License to your work.
180+
181+
To apply the Apache License to your work, attach the following
182+
boilerplate notice, with the fields enclosed by brackets "[]"
183+
replaced with your own identifying information. (Don't include
184+
the brackets!) The text should be enclosed in the appropriate
185+
comment syntax for the file format. We also recommend that a
186+
file or class name and description of purpose be included on the
187+
same "printed page" as the copyright notice for easier
188+
identification within third-party archives.
189+
190+
Copyright [yyyy] [name of copyright owner]
191+
192+
Licensed under the Apache License, Version 2.0 (the "License");
193+
you may not use this file except in compliance with the License.
194+
You may obtain a copy of the License at
195+
196+
http://www.apache.org/licenses/LICENSE-2.0
197+
198+
Unless required by applicable law or agreed to in writing, software
199+
distributed under the License is distributed on an "AS IS" BASIS,
200+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
201+
See the License for the specific language governing permissions and
202+
limitations under the License.

docs/requirements.txt

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,4 +36,5 @@ sphinxcontrib-htmlhelp==2.0.0
3636
sphinxcontrib-jsmath==1.0.1
3737
sphinxcontrib-qthelp==1.0.3
3838
sphinxcontrib-serializinghtml==1.1.5
39-
sphinxcontrib-mermaid==0.7.1
39+
sphinxcontrib-mermaid==0.7.1
40+
lxml_html_clean

docs/source/conf.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@
4141

4242
# -- Project information -----------------------------------------------------
4343
project = "MONAI Deploy App SDK"
44-
copyright = "2021 MONAI Consortium"
44+
copyright = "2021-2024 MONAI Consortium"
4545
author = "MONAI Contributors"
4646

4747
# The full version, including alpha/beta/rc tags

docs/source/getting_started/installing_app_sdk.md

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -15,16 +15,14 @@ pip install --upgrade monai-deploy-app-sdk
1515
```
1616

1717
:::{note}
18-
For packaging your application, [MONAI Application Packager](/developing_with_sdk/packaging_app) and [MONAI Application Runner (MAR)](/developing_with_sdk/executing_packaged_app_locally) requires NVIDIA Docker (NVIDIA Container Toolkit) installed:
18+
For packaging and running your application using [MONAI Application Packager](/developing_with_sdk/packaging_app) and [MONAI Application Runner (MAR)](/developing_with_sdk/executing_packaged_app_locally), [NVIDIA Container Toolkit](https://docs.nvidia.com/datacenter/cloud-native/container-toolkit/latest/install-guide.html) needs to be installed.
1919

20-
<https://docs.nvidia.com/datacenter/cloud-native/container-toolkit/install-guide.html#docker>
20+
For version 1.0.0, `nvcr.io/nvidia/clara-holoscan/holoscan:v1.0.3-dgpu` is used by [MONAI Application Packager](/developing_with_sdk/packaging_app) as base image for X86-64 in Linux system, though this will change with versions.
2121

22-
Currently, `nvcr.io/nvidia/clara-holoscan/holoscan:v0.6.0-dgpu` base Docker image is used by [MONAI Application Packager](/developing_with_sdk/packaging_app) by default for X86-64 in Linux system.
23-
24-
The base image size is large so please pull the image in advance to save time. Note that the container image tag in the following example, e.g. v0.6.0, corresponds to the SDK version.
22+
The base image size is large, so it is recommended to pull the image in advance to save time. Note that the container image tag in the following example, e.g. `v1.0.3`, corresponds to the underlying Holoscan SDK version.
2523

2624
```bash
27-
docker pull nvcr.io/nvidia/clara-holoscan/holoscan:v0.6.0-dgpu
25+
docker pull nvcr.io/nvidia/clara-holoscan/holoscan:v1.0.3-dgpu
2826
```
2927

3028
:::

0 commit comments

Comments
 (0)