Skip to content

Commit 90d15ca

Browse files
authored
Merge pull request #158 from Project-MONAI/add_tutorial_links
Update README.md to add tutorial links
2 parents bbc3894 + 7a64971 commit 90d15ca

File tree

1 file changed

+31
-2
lines changed

1 file changed

+31
-2
lines changed

README.md

Lines changed: 31 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,10 @@ MONAI Deploy App SDK offers a framework and associated tools to design, develop
1818
- Package inference application with a single command into a portable MONAI Application Package
1919
- Locally run and debug your inference application using App Runner
2020

21+
## User Guide
22+
23+
User guide is available at [docs.monai.io](https://docs.monai.io/projects/monai-deploy-app-sdk/en/latest/).
24+
2125
## Installation
2226

2327
To install [the current release](https://pypi.org/project/monai-deploy-app-sdk/), you can simply run:
@@ -28,6 +32,8 @@ pip install monai-deploy-app-sdk # '--pre' to install a pre-release version.
2832

2933
## Getting Started
3034

35+
Getting started guide is available at [here](https://docs.monai.io/projects/monai-deploy-app-sdk/en/latest/getting_started/index.html).
36+
3137
```bash
3238
pip install monai-deploy-app-sdk # '--pre' to install a pre-release version.
3339

@@ -52,9 +58,32 @@ cp examples/apps/simple_imaging_app/brain_mr_input.jpg input/
5258
monai-deploy run simple_app:latest input output
5359
```
5460

55-
[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).
61+
### [Tutorials](https://docs.monai.io/projects/monai-deploy-app-sdk/en/latest/getting_started/tutorials/index.html)
5662

57-
User guide is available at [docs.monai.io](https://docs.monai.io/projects/monai-deploy-app-sdk/en/latest/).
63+
#### [1) Creating a simple image processing app](https://docs.monai.io/projects/monai-deploy-app-sdk/en/latest/getting_started/tutorials/01_simple_app.html)
64+
65+
#### [2) Creating MedNIST Classifier app](https://docs.monai.io/projects/monai-deploy-app-sdk/en/latest/getting_started/tutorials/02_mednist_app.html)
66+
67+
YouTube Video:
68+
69+
- [MedNIST Classification Example](https://www.youtube.com/watch?v=WwjilJFHuU4)
70+
71+
### [3) Creating a Segmentation app](https://docs.monai.io/projects/monai-deploy-app-sdk/en/latest/getting_started/tutorials/03_segmentation_app.html)
72+
73+
YouTube Video:
74+
75+
- [Spleen Organ Segmentation - Jupyter Notebook Tutorial](https://www.youtube.com/watch?v=cqDVxzYt9lY)
76+
- [Spleen Organ Segmentation - Deep Dive](https://www.youtube.com/watch?v=nivgfD4pwWE)
77+
78+
### [Examples](https://docs.monai.io/projects/monai-deploy-app-sdk/en/latest/getting_started/examples.html)
79+
80+
<https://github.com/Project-MONAI/monai-deploy-app-sdk/tree/main/examples/apps> has example apps that you can see.
81+
82+
- ai_spleen_seg_app
83+
- ai_unetr_seg_app
84+
- dicom_series_to_image_app
85+
- mednist_classifier_monaideploy
86+
- simple_imaging_app
5887

5988
## Contributing
6089

0 commit comments

Comments
 (0)