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.

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

Change bundle name in readme [skip ci] #567

Merged
merged 1 commit into from
Mar 4, 2024

Conversation

yiheng-wang-nv
Copy link
Collaborator

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:

  • 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]>
@yiheng-wang-nv yiheng-wang-nv requested a review from wyli March 4, 2024 09:54
@yiheng-wang-nv yiheng-wang-nv changed the title Change bundle name in readme Change bundle name in readme [skip ci] Mar 4, 2024
@yiheng-wang-nv
Copy link
Collaborator Author

/build

@KumoLiu KumoLiu merged commit 7d4de08 into Project-MONAI:dev Mar 4, 2024
4 checks passed
yiheng-wang-nv added a commit to yiheng-wang-nv/model-zoo that referenced this pull request Jul 29, 2024
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]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants