Skip to content
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

[DOC] Getting started with examples README #304

Open
dbericat opened this issue Jun 22, 2022 · 1 comment
Open

[DOC] Getting started with examples README #304

dbericat opened this issue Jun 22, 2022 · 1 comment
Assignees
@vikashg @CPBridge
Labels
Contribution wanted If you are looking for an issue to resolve that will help Project MONAI App SDK documentation Improvements or additions to documentation enhancement New feature or request good first issue Good for newcomers help wanted Extra attention is needed

Comments

@dbericat
Copy link
Member

Report incorrect documentation

Create README at examples and Jupyter notebook tutorials to describe what each example is meant to showcase. Similar to https://github.com/Project-MONAI/tutorials

I can see 3 categories:

  1. MONAI Bundle -> MAP - link to key inference operator
  2. Model trained with MONAI, but not bundle available -> MAP - link to key inference operator
  3. Model NOT trained with MONAI -> MAP - link to how to create your own custom operator (I don't think we have this example yet)

Also add to documentation:
https://docs.monai.io/projects/monai-deploy-app-sdk/en/latest/getting_started/examples.html#apps
@dbericat dbericat added documentation Improvements or additions to documentation enhancement New feature or request good first issue Good for newcomers help wanted Extra attention is needed Contribution wanted If you are looking for an issue to resolve that will help Project MONAI App SDK labels Jun 22, 2022
@dbericat
Copy link
Member Author

@AnilMistry @MMelQin @GreySeaWolf FYI

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@vikashg vikashg

@CPBridge CPBridge

Labels
Contribution wanted If you are looking for an issue to resolve that will help Project MONAI App SDK documentation Improvements or additions to documentation enhancement New feature or request good first issue Good for newcomers help wanted Extra attention is needed
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
3 participants
@vikashg @dbericat @CPBridge