From 8daddb49e3179385799616bef75905e2b2227ecb Mon Sep 17 00:00:00 2001 From: YuChenLee1115 Date: Sun, 29 Dec 2024 10:41:01 +0800 Subject: [PATCH] docs: add quick start example to README --- README.md | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/README.md b/README.md index e5607ccb02..0b2da103c4 100644 --- a/README.md +++ b/README.md @@ -59,6 +59,19 @@ If you have used MONAI in your research, please cite us! The citation can be exp [The MONAI Model Zoo](https://github.com/Project-MONAI/model-zoo) is a place for researchers and data scientists to share the latest and great models from the community. Utilizing [the MONAI Bundle format](https://docs.monai.io/en/latest/bundle_intro.html) makes it easy to [get started](https://github.com/Project-MONAI/tutorials/tree/main/model_zoo) building workflows with MONAI. +## Quick Start Example +Here's a simple example of using MONAI for medical image preprocessing: + +```python +import monai +from monai.transforms import LoadImage, Spacing + +# Load a medical image +image = LoadImage()(image_path) +# Resample the image to a specific spacing +spaced_image = Spacing(pixdim=(1.5, 1.5, 2.0))(image) +``` + ## Contributing For guidance on making a contribution to MONAI, see the [contributing guidelines](https://github.com/Project-MONAI/MONAI/blob/dev/CONTRIBUTING.md).