Skip to content

adds release note v1.1#5693

Merged
wyli merged 10 commits intoProject-MONAI:devfrom
wyli:release-note-1.1
Dec 15, 2022
Merged

adds release note v1.1#5693
wyli merged 10 commits intoProject-MONAI:devfrom
wyli:release-note-1.1

Conversation

@wyli
Copy link
Copy Markdown
Contributor

@wyli wyli commented Dec 8, 2022

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

part of #5626
changelog updates

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 mentioned this pull request Dec 8, 2022
24 tasks
@wyli wyli marked this pull request as ready for review December 14, 2022 10:46
@wyli wyli requested review from Nic-Ma, ericspod and rijobro December 14, 2022 10:46
@mingxin-zheng
Copy link
Copy Markdown
Contributor

mingxin-zheng commented Dec 14, 2022

Hi @wyli , thanks for drafting the notes. I see there are two items for Auto3DSeg. Maybe we can expand them a bit more to provide more contexts in the release note. Below is a draft of mine (cc @myron @dongyang0122 for visibility and comments)

The pending ones are related to the ALGO_HASH update in PR #5733 .

Added
- * Auto3DSeg `AutoRunner` added option `self.algos` to manually specify algorithms to run (instead of always downloading a zip)
- * Auto3DSeg `AutoRunner` added input options `train`, `algo_gen`, `analyze` will default to None, indicating to automatically decide whether this step is necessary based on cache (history).
- * Auto3DSeg `AutoRunner` added method `set_analyze_params` to set `DataAnalyser` parameters (e.g. run it on gpu)
- * Auto3DSeg `AutoRunner` added a dry-run mode for hyper-parameter optimization(HPO) module so that users can get the commands to run NNI without actually using them.

(pending)
- * Auto3DSeg `BundleGen` added a new feature that automatically optimizes the parameter of model training configuration and maximize GPU memory utilization according to the devices in the house.

(also pending to merge because of the update of ALGO_HASH)
- * Auto3DSeg `SegResNet` is refracted to be more efficient, modular, with added support on minimal custom component (BYOC). Currently testing performance. The minimal user input config for the hecktor22 dataset would include a BYOC transform.

Fixed
- * Auto3DSeg `AutoRunner` will no longer fail if the users first set their ensemble method to `AlgoEnsembleBestByFold` and then change the `num_fold` by `set_num_fold`
- * Auto3DSeg `DataAnalyzer` now accepts `None` as the label key to indicate there is no label in the command line mode
- * Auto3DSeg `DataAnalyzer` will no longer crash when label image is empty (no foreground voxels are in this case, previously it crashed)
- * Auto3DSeg ensemble module can find the algorithm folders generated by the hyper-parameter optimization module.
- * Auto3DSeg ensemble module currently can use the voting method under sigmoid mode (one-hot encoding).
- * Auto3DSeg ensemble method `AlgoEnsembleBestN` will no longer fail if the number of trained algorithms is less than the pre-defined N best algorithms.


Changed
- * Auto3DSeg `AutoRunner` changed `self.cache` dict to be a single level (since it only has 4 items), instead of a nested dictionary
- * Auto3DSeg `AutoRunner` removed default setting `sigmoid=True` in `set_prediction_params`, since it's somewhat arbitrary
- * Auto3DSeg `AutoRunner` will raise errors if previous steps are not completed (e.g. ensemble requires train step)
- * Auto3DSeg `AutoRunner` changed its defaults to run data analysis on GPU (previously it was CPU)
- * Auto3DSeg `AutoRunner` will save ensemble prediction labels in uint8 (unless specified; previously it was floats)
- * Auto3DSeg `AutoRunner` will print training progress in Console (previously no output was produced at all for a very long time)
- * Auto3DSeg `AutoRunner` will execute training in sorted order (fold0, fold1, fold2..), Previously it was in random order
- * Auto3DSeg `AutoRunner` now picks the best algorithm in each folder (`AlgoEnsembleBestByFold`) to ensemble algorithm by default, instead of finding the best N algorithms (`AlgoEnsembleBestN`)
- * Auto3DSeg `DataAnalyzer` uses GPU to improve speed by running data loading in parallel
- * Auto3DSeg `DataAnalyzer` can automatically fix shape mismatch (instead of crashing) when label is slightly different in size compared to image
- * Auto3DSeg `DataAnalyzer` saves summary stats on the top in `datastats.yaml` (previously it was at the very bottom)
- * Auto3DSeg `DataAnalyzer`'s connected component stastical analysis switched its default to false, since it’s currently not used, and takes a long time to comput)

(also pending to merge because of the update of ALGO_HASH)
- * All default algorithm templates in Auto3DSeg are unified to use epochs to mark the progress of training and validation.

@wyli
Copy link
Copy Markdown
Contributor Author

wyli commented Dec 14, 2022

thanks @mingxin-zheng, I'll update the relevant DataAnalyzer changes. for monai.apps.auto3dseg it's unstable anyway, I'll omit the details

wyli added 7 commits December 15, 2022 12:23
Signed-off-by: Wenqi Li <[email protected]>
Signed-off-by: Wenqi Li <[email protected]>
Signed-off-by: Wenqi Li <[email protected]>
Signed-off-by: Wenqi Li <[email protected]>
Signed-off-by: Wenqi Li <[email protected]>
Signed-off-by: Wenqi Li <[email protected]>
Signed-off-by: Wenqi Li <[email protected]>
@wyli
Copy link
Copy Markdown
Contributor Author

wyli commented Dec 15, 2022

/black

monai-bot and others added 2 commits December 15, 2022 12:51
Signed-off-by: monai-bot <[email protected]>
Signed-off-by: Wenqi Li <[email protected]>
@wyli
Copy link
Copy Markdown
Contributor Author

wyli commented Dec 15, 2022

/build

@wyli wyli enabled auto-merge (squash) December 15, 2022 13:01
@wyli wyli merged commit 5f6cb2d into Project-MONAI:dev Dec 15, 2022
@wyli wyli deleted the release-note-1.1 branch January 6, 2023 14:49
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.

4 participants