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.

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

[VDR ]add ohif brief overview doc in the readme #84

Closed
wants to merge 3 commits into from
Closed

Conversation

tangy5
Copy link
Collaborator

@tangy5 tangy5 commented Mar 3, 2024

Fix #65 , #66

@mingxin-zheng
Copy link
Collaborator

Hi @tangy5 , can we change the merge target to @zephyrie 's integrated_doc branch?


To begin using the NVIDIA MONAI Cloud APIs, you can sign up for early access by filling out this survey: [NVIDIA MONAI Cloud API Early Access](https://developer.nvidia.com/nvidia-monai-cloud-api-early-access-program/join).

## Getting Started with OHIF Plugin
Copy link
Collaborator

Choose a reason for hiding this comment

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

If we folllow the style @zephyrie 's integrated_doc branch, I would suggest to move the contents of OHIF and DICOMweb to two markdown files.

Copy link
Collaborator

Choose a reason for hiding this comment

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

Yeah, we should break this down so people can find the relevant section and we should not have this in the README but in the docs section for How-To guides.
"DICOMWeb Setup" and "Using OHIF and MONAI Cloud API Plugin", we can also move the instructions from the OHIF plugin setup directory to another docs page "Setting up OHIF and MONAI Cloud API Plugin"

Copy link
Collaborator

Choose a reason for hiding this comment

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

Also, can we update the plugin name / any other displayed name to "NVIDIA MONAI Cloud API"? We should stop using MONAI Service for any naming moving forward.


## Getting Started with OHIF Plugin

MONAI Service provide ready-to-use playgroundw with API server and applications for users.
Copy link
Collaborator

Choose a reason for hiding this comment

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

typo: playgroundw

Copy link
Collaborator

Choose a reason for hiding this comment

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

The whole sentence can be

The MONAI Service offers a ready-to-use environment featuring an API server and applications for users. If you wish to construct and customize the OHIF viewer along with the MONAI Service plugin, please consult the [setup page](https://github.com/NVIDIA/monai-cloud-api/tree/main/plugins/ohif).

If you are going to build and custimize OHIF viewer and MONAI Service plugin. Please refer to the [setup page](https://github.com/NVIDIA/monai-cloud-api/tree/main/plugins/ohif)

### Dicomweb Overview
Dataset storage can be variant, in the open-sourced setup. We recommend Orthanc for hosting dicom format medical images.
Copy link
Collaborator

Choose a reason for hiding this comment

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

The storage of datasets can vary; in our open-source setup, we recommend using Orthanc for hosting DICOM format medical images.

sudo apt-get install orthanc orthanc-dicomweb -y

# Install Plastimatch
sudo apt-get install plastimatch -y
Copy link
Collaborator

Choose a reason for hiding this comment

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

Can these two be merged into one-line?

sudo apt-get install orthanc orthanc-dicomweb plastimatch -y

Copy link
Collaborator

Choose a reason for hiding this comment

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

As far as I can tell, we don't need plastimatch for orthanc, but for the conversion of nifti to dicom? We can leave it as a separate code block, but we should give me information on why we need it, give an example of using it to convert, and also specify the installation is optional and only required for the conversion of files.

For customized setup for Orthanc,

**Steps:**

Copy link
Collaborator

Choose a reason for hiding this comment

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

Add

1. Install Orthanc and DICOMweb plugin

```

```
dicom_web_endpoint = ...
Copy link
Collaborator

Choose a reason for hiding this comment

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

Where will these variables be consumed? MONAI cloud api notebooks?



#### 1. **Study List**
Open OHIF viewer, the index page is a study list. The subjects listed are prepared in dicom-web storage.
Copy link
Collaborator

Choose a reason for hiding this comment

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

Incomplete sentence:

Open OHIF viewer, the index page is a study list

Copy link
Collaborator

Choose a reason for hiding this comment

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

DICOMweb




#### 4. **Run Inferencing Using Selected Method**
Copy link
Collaborator

Choose a reason for hiding this comment

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

After this MR is merged, we can remove the duplicated contents in the notebook: https://github.com/NVIDIA/monai-cloud-api/blob/main_ea4/notebooks/Annotation%20and%20Continuous%20Learning%20Overview.ipynb

Copy link
Collaborator

Choose a reason for hiding this comment

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

Yeah, we should move as much as possible that's duplicate or unnecessary for the actual flow of the notebook to docs.

**Class Prompts**:

The class prompts is used when inference and annotating specific anatomies, VISTA model supprts more
than 100 organs, bones, muscles, etc. Users can selecte one or multiple targets for AI inference.
Copy link
Collaborator

Choose a reason for hiding this comment

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

selecte

Use mouse and click to place the control points within medical images.
In OHIF MONAI Service plugin, user can use point prompts by clicking the
**Point Prompts**:
You can see availabel organs in the panel, select one anatomy for point
Copy link
Collaborator

Choose a reason for hiding this comment

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

availabel


![Save Label](docs/doc_imgs/savelabel.png)

Next, notify the server that an image has been annotated. This step is crucial for continuous learning. The system will take note of the new annotations and after the indicated number of annotated images it will use them to improve the model over time.
Copy link
Collaborator

Choose a reason for hiding this comment

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

continuous learning -> continual learning

This step ensures that your annotations are as accurate as possible.

**Steps**
1. Click the Segmentation button.
Copy link
Collaborator

Choose a reason for hiding this comment

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

button


**Steps**
1. Click the Segmentation button.
2. Select a class of segmentation that needs to be updated.
Copy link
Collaborator

Choose a reason for hiding this comment

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

that needs update

- Refine boundaries
- Add or remove regions

This step ensures that your annotations are as accurate as possible.
Copy link
Collaborator

Choose a reason for hiding this comment

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

This step is crucial to ensure the highest possible accuracy of your annotations.


**Class Prompts**:

The class prompts is used when inference and annotating specific anatomies, VISTA model supprts more
Copy link
Collaborator

Choose a reason for hiding this comment

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

"The class prompt is" or "The class prompts are"

Copy link
Collaborator

Choose a reason for hiding this comment

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

supprts


![study list](docs/doc_imgs/inference_class_prompts_res.png)

User can get the real-time prompt response for the class edits.
Copy link
Collaborator

Choose a reason for hiding this comment

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

Would be good to add a small summary or conclusion after this line.


![Notify](docs/doc_imgs/notify.png)

The associated API call run when you click the `Notify Server` button is below:
Copy link
Collaborator

Choose a reason for hiding this comment

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

Remove, we don't need to inform people during this guide what the corresponding API call is. We should define a Viewer Integration guide that talks about the dataset API calls and how they should be used.

@tangy5 tangy5 added the EA4 label Mar 14, 2024
@@ -14,6 +15,191 @@ The NVIDIA MONAI Cloud APIs offer a comprehensive suite of tools designed to enh
- A robust foundation model, trained on 117 classes encompassing various organs and tumors.
- The model's training and validation involved CT images from over 4,000 patients, ensuring its high accuracy and reliability for medical image analysis.

### How to Get Started
4. Dicon-web Setup and Dataset Configuration:
Copy link
Collaborator

Choose a reason for hiding this comment

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

Dicom

@mingxin-zheng
Copy link
Collaborator

Closing as the doc is available elsewhere.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Need to add a section about the OHIF view demo application in the documentation
3 participants