Skip to content

Commit dd011d3

Browse files
committed
Enhance application documentation and refine requirements for pipeline generator
- Updated the application class documentation to provide clearer descriptions of the vision-language model (VLM) functionality, including details on prompt processing and output generation. - Refined the version constraints for the pydicom dependency in the requirements template to ensure compatibility with future updates while maintaining support for existing features. Signed-off-by: Victor Chang <[email protected]>
1 parent 6f24c51 commit dd011d3

File tree

2 files changed

+6
-4
lines changed

2 files changed

+6
-4
lines changed

tools/pipeline-generator/pipeline_generator/templates/app.py.j2

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -93,8 +93,10 @@ class {{ app_name }}(Application):
9393
This application processes common image formats (JPEG, PNG, etc.) and outputs
9494
classification results as JSON files.
9595
{% elif input_type == "custom" and output_type == "custom" %}
96-
This application processes prompts and images using a vision-language model.
97-
It reads prompts from prompts.yaml and generates text or image outputs based on the specified output type.
96+
This application processes prompts and images using a vision-language model (VLM).
97+
Prompts are specified in a prompts.yaml file and can include tasks such as visual question answering, image captioning, or visual reasoning.
98+
Each prompt entry may contain a textual question or instruction and an associated image path.
99+
The application generates outputs such as text answers, captions, or image overlays, depending on the prompt and the configured output type.
98100
{% else %}
99101
This application follows the pipeline structure:
100102
[Source/{{ 'ImageDirectoryLoader' if input_type == 'image' else 'NiftiDirectoryLoader' }}] → [Preprocessing Op] → [Inference Op] → [Postprocessing Op] → [Sink/{{ 'JSONResultsWriter' if output_type == 'json' else 'NiftiWriter' }}]

tools/pipeline-generator/pipeline_generator/templates/requirements.txt.j2

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,8 +11,8 @@ monai>=1.5.0
1111

1212

1313
# Required by MONAI Deploy SDK (always needed)
14-
pydicom>=2.3.0 # Required by MONAI Deploy SDK even for NIfTI apps
15-
highdicom>=0.18.2 # Required for DICOM segmentation support
14+
pydicom>=2.3.0,<3.0.0 # Required by MONAI Deploy SDK even for NIfTI apps
15+
highdicom>=0.18.2 # Required for DICOM segmentation support
1616

1717
{% if input_type == "image" %}
1818
# Image loading dependencies

0 commit comments

Comments
 (0)