Skip to content

Update docs for MONAI Application Runner's input #141

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 3 commits into from
Sep 21, 2021
Merged

Update docs for MONAI Application Runner's input #141

merged 3 commits into from
Sep 21, 2021

Conversation

@gigony
Copy link
Collaborator

@gigony gigony commented Sep 20, 2021

  • Fix type error for Python 3.7 mypy
  • Update user guide for SDK - part 1
  • Accept only folder input path on App Runner
    • Update code to detect if the input path is a file path or a folder path
    • Update documents accordingly.

@gigony
Fix type error for Python 3.7 mypy
063a09e 
Signed-off-by: Gigon Bae <gbae@nvidia.com>
@gigony gigony added documentation Improvements or additions to documentation architectural story Work related to architecture labels Sep 20, 2021
@gigony gigony added this to the v0.1.0 milestone Sep 20, 2021
@gigony gigony self-assigned this Sep 20, 2021
MMelQin
MMelQin reviewed Sep 20, 2021
View reviewed changes
docs/source/developing_with_sdk/core_concepts.md Outdated
:alt: Developing Application
:align: center
:caption: ⠀⠀Steps to developing application
:caption: ⠀⠀Steps to develop application
Copy link
Collaborator

@MMelQin MMelQin Sep 20, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

application -> an application or applications

Copy link
Collaborator Author

@gigony gigony Sep 20, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Updated! Thank you!
Also updated

Steps to package, local-running, and deploying MONAI Application Package (MAP) to Steps to package, local-running, and deploying a MONAI Application Package (MAP) (adding 'a') in other part of the document.

MMelQin
MMelQin reviewed Sep 20, 2021
View reviewed changes
docs/source/developing_with_sdk/executing_packaged_app_locally.md Outdated

```bash
usage: monai-deploy run [-h] [-l {DEBUG,INFO,WARN,ERROR,CRITICAL}] [-q] <map-image[:tag]> <input> <output>
usage: monai-deploy run [-h] [-l <LEVEL>G,INFO,WARN,ERROR,CRITICAL}] [-q] <map-image[:tag]> <input> <output>
Copy link
Collaborator

@MMelQin MMelQin Sep 20, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is this intended, <LEVEL>G?

Copy link
Collaborator Author

@gigony gigony Sep 20, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You seem to have hawk eyes :)

Let me fix the typo.

MMelQin
MMelQin reviewed Sep 20, 2021
View reviewed changes
docs/source/developing_with_sdk/packaging_app.md Outdated
* `--timeout <VALUE>`: A timeout (overrides default `0`. In seconds.).
* `--version`: A version of the Application (overrides default `"0.0.0"`).
* `--working-dir, -w <WORKDIR>`: A directory mounted in container for Application (overrides default `"/var/monai"`).
Optional Path to the directory containing all application models
Copy link
Collaborator

@MMelQin MMelQin Sep 20, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is this line supposed to be added here?

Copy link
Collaborator Author

@gigony gigony Sep 20, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good catch! Thank you!

This one is a typo. Let me remove it.

MMelQin
MMelQin reviewed Sep 20, 2021
View reviewed changes
MMelQin
MMelQin approved these changes Sep 20, 2021
View reviewed changes
Copy link
Collaborator

@MMelQin MMelQin left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Approved with a few comments.

gigony
gigony commented Sep 20, 2021
View reviewed changes
Copy link
Collaborator Author

@gigony gigony left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @MMelQin for the review!

docs/source/developing_with_sdk/packaging_app.md Outdated
* `--timeout <VALUE>`: A timeout (overrides default `0`. In seconds.).
* `--version`: A version of the Application (overrides default `"0.0.0"`).
* `--working-dir, -w <WORKDIR>`: A directory mounted in container for Application (overrides default `"/var/monai"`).
Optional Path to the directory containing all application models
Copy link
Collaborator Author

@gigony gigony Sep 20, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good catch! Thank you!

This one is a typo. Let me remove it.

docs/source/developing_with_sdk/executing_packaged_app_locally.md Outdated

```bash
usage: monai-deploy run [-h] [-l {DEBUG,INFO,WARN,ERROR,CRITICAL}] [-q] <map-image[:tag]> <input> <output>
usage: monai-deploy run [-h] [-l <LEVEL>G,INFO,WARN,ERROR,CRITICAL}] [-q] <map-image[:tag]> <input> <output>
Copy link
Collaborator Author

@gigony gigony Sep 20, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You seem to have hawk eyes :)

Let me fix the typo.

docs/source/developing_with_sdk/core_concepts.md Outdated
:alt: Developing Application
:align: center
:caption: ⠀⠀Steps to developing application
:caption: ⠀⠀Steps to develop application
Copy link
Collaborator Author

@gigony gigony Sep 20, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Updated! Thank you!
Also updated

Steps to package, local-running, and deploying MONAI Application Package (MAP) to Steps to package, local-running, and deploying a MONAI Application Package (MAP) (adding 'a') in other part of the document.

@gigony
Update user guide for SDK - part 1
41eddc4 
Signed-off-by: Gigon Bae <gbae@nvidia.com>
@gigony
Accept only folder input path on App Runner
a645229 
Signed-off-by: Gigon Bae <gbae@nvidia.com>
@gigony gigony force-pushed the update_app_runner_input branch from 0a21cde to a645229 Compare September 20, 2021 23:46
@bhatt-piyush bhatt-piyush mentioned this pull request Sep 20, 2021
Merged
@gigony gigony merged commit a704c50 into main Sep 21, 2021
@MMelQin MMelQin deleted the update_app_runner_input branch November 5, 2025 21:36
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@bhatt-piyush bhatt-piyush bhatt-piyush approved these changes

@MMelQin MMelQin MMelQin approved these changes

@KavinKrishnan KavinKrishnan Awaiting requested review from KavinKrishnan

Assignees

@gigony gigony

Labels

architectural story Work related to architecture documentation Improvements or additions to documentation

Projects

None yet

Milestone

v0.1.0

Development

Successfully merging this pull request may close these issues.

4 participants

@gigony @bhatt-piyush @MMelQin