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

Add classification template #533

Merged
merged 4 commits into from
Dec 1, 2023
Merged

Conversation

KumoLiu
Copy link
Collaborator

@KumoLiu KumoLiu commented Nov 29, 2023

Part of tutorial#1456

Description

Add a classification template

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: KumoLiu <[email protected]>
@KumoLiu KumoLiu changed the title fix tutorial#1456 Add classification template Nov 29, 2023
Signed-off-by: KumoLiu <[email protected]>
Signed-off-by: KumoLiu <[email protected]>
Signed-off-by: KumoLiu <[email protected]>
@KumoLiu
Copy link
Collaborator Author

KumoLiu commented Nov 29, 2023

/build

@KumoLiu KumoLiu requested review from ericspod and Nic-Ma November 29, 2023 09:39
@ericspod
Copy link
Member

Hi @KumoLiu looks good! I had a few points about how transforms are being applied but it works for you so it's just a best practice thing. One other suggestion is to have a common.yaml file with all the common definitions in it (eg. network_def), then include that when doing things like training. I hadn't done that for the segmentation template because I wanted to maintain compatibility with the current version of MONAILabel. Here we don't need to worry about that so we can change things now to have a common file or leave it for a future refactor.

@KumoLiu
Copy link
Collaborator Author

KumoLiu commented Nov 30, 2023

Hi @ericspod, I didn't get the point of why we need the common.yaml. I see you created an issue here and also mentioned it in the dev meeting. But seems we don't need to specify the common field in multiple configs, we only need to add what we want to override in the evaluate.yaml or inference.yaml or other configs.

@KumoLiu
Copy link
Collaborator Author

KumoLiu commented Nov 30, 2023

After reading again the configs, I think I get the points. It makes sense if we add a common.yaml but every time we may need to specify multiple configs due to the existence of common.yaml.
Perhaps we could refactor it later when we reach a consensus. What do you think?

@ericspod
Copy link
Member

I'm good to refactor later, it's something we will likely do for both template bundles. I had recommended having a common config file in this bundle tutorial but it's not necessary.

Copy link
Member

@ericspod ericspod left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM!

@KumoLiu KumoLiu merged commit 9432496 into Project-MONAI:dev Dec 1, 2023
2 checks passed
@KumoLiu KumoLiu deleted the cls-template branch December 1, 2023 01:06
yiheng-wang-nv pushed a commit to yiheng-wang-nv/model-zoo that referenced this pull request Jul 29, 2024
Part of tutorial#1456

### Description
Add a classification template

### 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: KumoLiu <[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