Skip to content

Commit 69f4aac

Browse files
Change bundle name in readme [skip ci] (Project-MONAI#567)
Related to Project-MONAI/MONAI#7280 ### Description Before MONAI 1.3.1 release, we can only download bundles that have all lowercase name. Therefore, this PR is used to change example bundle name in README to avoid potential issues with MONAI 1.3 ### Status **Ready** ### Please ensure all the checkboxes: <!--- Put an `x` in all the boxes that apply, and remove the not applicable items --> - [x] Codeformat tests passed locally by running `./runtests.sh --codeformat`. - [ ] In-line docstrings updated. - [ ] Update `version` and `changelog` in `metadata.json` if changing an existing bundle. - [ ] Please ensure the naming rules in config files meet our requirements (please refer to: `CONTRIBUTING.md`). - [ ] Ensure versions of packages such as `monai`, `pytorch` and `numpy` are correct in `metadata.json`. - [ ] Descriptions should be consistent with the content, such as `eval_metrics` of the provided weights and TorchScript modules. - [ ] Files larger than 25MB are excluded and replaced by providing download links in `large_file.yml`. - [ ] Avoid using path that contains personal information within config files (such as use `/home/your_name/` for `"bundle_root"`). Signed-off-by: Yiheng Wang <[email protected]>
1 parent a426962 commit 69f4aac

File tree

1 file changed

+3
-3
lines changed

1 file changed

+3
-3
lines changed

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -11,12 +11,12 @@ A basic example to download and extract a bundle is:
1111

1212
```bash
1313
pip install "monai[fire]"
14-
python -m monai.bundle download "wholeBody_ct_segmentation" --bundle_dir "bundles/"
14+
python -m monai.bundle download "spleen_ct_segmentation" --bundle_dir "bundles/"
1515
```
1616

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

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

0 commit comments

Comments
 (0)