Skip to content

Commit

Permalink
Update doc for segment_image.py (#1290)
Browse files Browse the repository at this point in the history
* Update segment_image.py

* Fixed RST
  • Loading branch information
jcohenadad committed Feb 13, 2023
1 parent 16f67d4 commit e101ebe
Showing 1 changed file with 7 additions and 3 deletions.
10 changes: 7 additions & 3 deletions ivadomed/scripts/segment_image.py
Original file line number Diff line number Diff line change
Expand Up @@ -70,10 +70,14 @@ def segment_image(fname_images: str, path_model: str, suffix_out: str, options:
"""
Applies a trained model on image(s). Output predictions are generated in the current directory.
For example::
ivadomed_segment_image -i t2s.nii.gz -m /usr/bob/my_model_directory
Args:
fname_images (str): Image(s) to segment. You can specify more than one image (separate with space).
path_model (str): Path to folder that contains ONNX and/or PT model and ivadomed JSON config file.
suffix_out (str): Suffix to add to the input image. Default: '_pred'.
fname_images (str): Image(s) to segment. You can specify more than one image (separate with space). Flag: ``--image``, ``-i``
path_model (str): Path to folder that contains ONNX and/or PT model and ivadomed JSON config file. Flag: ``--model``, ``-m``
suffix_out (str): Suffix to add to the input image. Default: '_pred'. Flag: ``--suffix-out``, ``-s``
options (dict): Options to pass to `imed_inference.segment_volume`.
Returns:
Expand Down

0 comments on commit e101ebe

Please sign in to comment.