Skip to content

5381 and deprecate compute_meandice compute_meaniou#5382

Merged
wyli merged 3 commits intoProject-MONAI:devfrom
wyli:5381-update-func-name
Oct 24, 2022
Merged

5381 and deprecate compute_meandice compute_meaniou#5382
wyli merged 3 commits intoProject-MONAI:devfrom
wyli:5381-update-func-name

Conversation

@wyli
Copy link
Copy Markdown
Contributor

@wyli wyli commented Oct 23, 2022

Signed-off-by: Wenqi Li [email protected]

Fixes #5381

Description

  • non-breaking changes to rename compute_meandice to compute_dice
  • non-breaking changes to rename compute_meaniou to compute_iou

Types of changes

  • Non-breaking change (fix or new feature that would not break existing functionality).
  • Breaking change (fix or new feature that would cause existing functionality to change).
  • New tests added to cover the changes.
  • Integration tests passed locally by running ./runtests.sh -f -u --net --coverage.
  • Quick tests passed locally by running ./runtests.sh --quick --unittests --disttests.
  • In-line docstrings updated.
  • Documentation updated, tested make html command in the docs/ folder.

@wyli wyli changed the title 5381 and reviewed modules __all__ 5381 and reviewed metrics module's __all__ Oct 23, 2022
@ericspod
Copy link
Copy Markdown
Member

If we're looking at __all__ we should consider changing __init__.py files to use from whatever import * rather than restating the same list of definitions we have in __all__. We've assumed that modules defining code include a __all__ value stating what should be public, so __init__.py files at the same level don't need to work any of that out so don't need __all__ themselves and can just import with *. Eg. transforms/__init__.py I think can be changed to replace the list of definitions with *.

@wyli wyli changed the title 5381 and reviewed metrics module's __all__ 5381 and deprecate compute_meandice compute_meaniou Oct 23, 2022
@wyli wyli marked this pull request as ready for review October 23, 2022 13:04
@mingxin-zheng
Copy link
Copy Markdown
Contributor

Looks good to me.
compute_meandice was used across dints, unetr, segresnet, segresnet2d in Auto3Dseg templates. I guess we need to update them after the merge. @dongyang0122 @tangy5 @KumoLiu

@wyli wyli force-pushed the 5381-update-func-name branch from 82b0885 to 8b3cc84 Compare October 24, 2022 07:51
@wyli
Copy link
Copy Markdown
Contributor Author

wyli commented Oct 24, 2022

/build

@wyli
Copy link
Copy Markdown
Contributor Author

wyli commented Oct 24, 2022

Looks good to me. compute_meandice was used across dints, unetr, segresnet, segresnet2d in Auto3Dseg templates. I guess we need to update them after the merge. @dongyang0122 @tangy5 @KumoLiu

thanks Mingxin, this patch will be included in v1.0.1, and agree that we should update the templates. It's also fine if we don't have time to update the template hash value for v1.0.1, because by default the deprecation warning will be printed only on the first occurrence within each run.

@wyli wyli merged commit 06dc983 into Project-MONAI:dev Oct 24, 2022
@wyli wyli deleted the 5381-update-func-name branch October 24, 2022 08:58
wyli added a commit that referenced this pull request Oct 24, 2022
Signed-off-by: Wenqi Li <[email protected]>

Fixes #5381

### Description
- non-breaking changes to rename `compute_meandice` to `compute_dice`
- non-breaking changes to rename `compute_meaniou` to `compute_iou`

### Types of changes
<!--- Put an `x` in all the boxes that apply, and remove the not
applicable items -->
- [x] Non-breaking change (fix or new feature that would not break
existing functionality).
- [ ] Breaking change (fix or new feature that would cause existing
functionality to change).
- [x] New tests added to cover the changes.
- [ ] Integration tests passed locally by running `./runtests.sh -f -u
--net --coverage`.
- [x] Quick tests passed locally by running `./runtests.sh --quick
--unittests --disttests`.
- [ ] In-line docstrings updated.
- [ ] Documentation updated, tested `make html` command in the `docs/`
folder.

Signed-off-by: Wenqi Li <[email protected]>
wyli added a commit that referenced this pull request Oct 24, 2022
Signed-off-by: Wenqi Li <[email protected]>

Fixes #5381

- non-breaking changes to rename `compute_meandice` to `compute_dice`
- non-breaking changes to rename `compute_meaniou` to `compute_iou`

<!--- Put an `x` in all the boxes that apply, and remove the not
applicable items -->
- [x] Non-breaking change (fix or new feature that would not break
existing functionality).
- [ ] Breaking change (fix or new feature that would cause existing
functionality to change).
- [x] New tests added to cover the changes.
- [ ] Integration tests passed locally by running `./runtests.sh -f -u
--net --coverage`.
- [x] Quick tests passed locally by running `./runtests.sh --quick
--unittests --disttests`.
- [ ] In-line docstrings updated.
- [ ] Documentation updated, tested `make html` command in the `docs/`
folder.

Signed-off-by: Wenqi Li <[email protected]>
KumoLiu pushed a commit that referenced this pull request Nov 2, 2022
Signed-off-by: Wenqi Li <[email protected]>

Fixes #5381

### Description
- non-breaking changes to rename `compute_meandice` to `compute_dice`
- non-breaking changes to rename `compute_meaniou` to `compute_iou`

### Types of changes
<!--- Put an `x` in all the boxes that apply, and remove the not
applicable items -->
- [x] Non-breaking change (fix or new feature that would not break
existing functionality).
- [ ] Breaking change (fix or new feature that would cause existing
functionality to change).
- [x] New tests added to cover the changes.
- [ ] Integration tests passed locally by running `./runtests.sh -f -u
--net --coverage`.
- [x] Quick tests passed locally by running `./runtests.sh --quick
--unittests --disttests`.
- [ ] In-line docstrings updated.
- [ ] Documentation updated, tested `make html` command in the `docs/`
folder.

Signed-off-by: Wenqi Li <[email protected]>
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.

compute_meandice and compute_meaniou should be compute_dice and compute_iou

3 participants