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.

Sign up for GitHub

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

update usage -- readme #321

Merged
merged 2 commits into from
Feb 28, 2023
Merged

update usage -- readme #321

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
68ecb46
update usage
wyli Feb 26, 2023
6f894c1
Update README.md
wyli Feb 28, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 14 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,20 @@ All source code of models (bundles) are tracked in `models/`, and for each disti

## Getting Started

To download and get started with the models, please see [the model browser](https://monai.io/model-zoo.html) and [the example use cases](https://github.com/Project-MONAI/tutorials/tree/main/model_zoo).
To browse the available models, please see https://monai.io/model-zoo.

A basic example to download and extract a bundle is:

```bash
pip install "monai[fire]"
python -m monai.bundle download "wholeBody_ct_segmentation" --bundle_dir "bundles/"
```

- The commands will download `wholeBody_ct_segmentation` to the current directory's `bundles/` subdirectory.
- For more downloading options, please run `python -m monai.bundle download -h`
- For the specific usage of a bundle, please refer to its `docs` folder, for example, `bundles/wholeBody_ct_segmentation/docs`.

To get started with the models, please see [the example use cases](https://github.com/Project-MONAI/tutorials/tree/main/model_zoo).

## License

Expand Down