Skip to content

Commit

Permalink
Add and improve some documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
rudolphpienaar committed May 1, 2024
1 parent aacd17c commit 8ce057f
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 4 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ Based off Project MONAI's [spleen segmentation notebook](https://github.com/Proj

For the most part, the python notebook code could have been mostly used _verbatim_ in the plugin; however, in this example considerable and deeper refactoring was performed. Other than of course now being a complete stand alone implementation, this plugin allows for _continuous_ (or _continued_) training, as well as saving examples of all training/validation/inference datasets as NIfTI volumes to allow for better understanding of the process.

For the _training_ phase, the parent plugin provides input images (training and labeled) and the output is a model (`pth` and `ONNX` format). For the _inference_ phase, the input is a model file, and an image with the output being a segmented result.
For the _training_ phase, the parent plugin provides input images (training and labeled) and the output is a model (`pth` or `ONNX` format). For the _inference_ phase, the input is a model file, an image (or more) to analyze, and the output is a segmented volume file.

## Implementation

Expand Down
6 changes: 3 additions & 3 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -29,9 +29,9 @@ training/validation/inference datasets as NIfTI volumes to allow for
better understanding of the process.

For the *training* phase, the parent plugin provides input images
(training and labeled) and the output is a model (``pth`` and ``ONNX``
format). For the *inference* phase, the input is a model file, and an
image with the output being a segmented result.
(training and labeled) and the output is a model (``pth`` or ``ONNX``
format). For the *inference* phase, the input is a model file, an image
(or more) to analyze, and the output is a segmented volume file.

Implementation
--------------
Expand Down

0 comments on commit 8ce057f

Please sign in to comment.