Skip to content

releasing v1.5 -- checklist #8421

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

Open
31 tasks
KumoLiu opened this issue Apr 11, 2025 · 3 comments
Open
31 tasks

releasing v1.5 -- checklist #8421

KumoLiu opened this issue Apr 11, 2025 · 3 comments

Comments

@KumoLiu
Copy link
Contributor

KumoLiu commented Apr 11, 2025

tentative: 18th Apr

Review the deprecated APIs

  • remove any promised deprecated functionality

Release a candidate version

  • Tag and release PYPI version [X.Y.Z]rc[K] following the contributing guide, need trigger release pipeline on blossom.
  • Make sure all CI pipelines pass.

Verify the new PyPI release

Quality assurance for the relevant repos

The new PyPI release candidate should be checked against all the relevant repositories under Project-MONAI, for example, the tutorials repo:

  • Run all Jupyter notebooks, replace pip install monai with pip install monai==[X.Y.Z]rc[K].
  • File new tickets and create new pull requests to address any technical issues.
  • Release a new candidate after addressing all the issues.
  • Testing related repositories
    • MONAI unit and integration tests
    • MONAI tutorial tests
    • MONAILabel unit and integration tests
    • MONAI model zoo tests
    • QA regression tests

Prepare documentation

Release a milestone version

Revisit the GitHub project tab

@KumoLiu KumoLiu pinned this issue Apr 25, 2025
KumoLiu added a commit to KumoLiu/MONAI that referenced this issue Apr 25, 2025
remove deprecated functionality

Signed-off-by: YunLiu <[email protected]>
@ziw-liu
Copy link

ziw-liu commented May 8, 2025

There is also a RC tag: https://github.com/Project-MONAI/MONAI/releases/tag/1.4.1rc1

Will that ever be released as 1.4.1?

KumoLiu added a commit that referenced this issue May 9, 2025
remove deprecated functionality

Part of #8421

### Description
Removed Functionality:
- metrics: Removed `compute_percent_hausdorff_distance`. Use
`compute_hausdorff_distance` with the `percentile` argument instead.
- bundle: Removed `net_name`, `net_kwargs`, and `return_state_dict`
arguments from `load()`. Use the `model` argument for network
instantiation.
- bundle: Removed `workflow` argument from `BundleWorkflow` and
`ConfigWorkflow`. Use `workflow_type` instead.
- networks: Removed `img_size` argument from `SwinUNETR`. Input size
checks are now performed during `forward()`.

Default Value Changes:
- `GeneralizedDiceScore`: Changed default `reduction` from `MEAN_BATCH`
to `MEAN`.
- `CropForeground` / `CropForegroundd`: Changed default `allow_smaller`
from `True` to `False`.
- `get_mask_edges`: Changed default `always_return_as_numpy` from `True`
to `False`.
- `generate_spatial_bounding_box`: Changed default `allow_smaller` from
`True` to `False`.


### 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).
- [ ] 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.

---------

Signed-off-by: YunLiu <[email protected]>
Signed-off-by: monai-bot <[email protected]>
Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
Co-authored-by: monai-bot <[email protected]>
ericspod pushed a commit to Project-MONAI/tutorials that referenced this issue May 11, 2025
Part of Project-MONAI/MONAI#8421

### Description
Remove deprecated feature for v1.5

### Checks
<!--- Put an `x` in all the boxes that apply, and remove the not
applicable items -->
- [ ] Avoid including large-size files in the PR.
- [ ] Clean up long text outputs from code cells in the notebook.
- [ ] For security purposes, please check the contents and remove any
sensitive info such as user names and private key.
- [ ] Ensure (1) hyperlinks and markdown anchors are working (2) use
relative paths for tutorial repo files (3) put figure and graphs in the
`./figure` folder
- [ ] Notebook runs automatically `./runner.sh -t <path to .ipynb file>`

---------

Signed-off-by: YunLiu <[email protected]>
Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
KumoLiu added a commit to Project-MONAI/tutorials that referenced this issue May 25, 2025
Part of Project-MONAI/MONAI#8421

### Checks
<!--- Put an `x` in all the boxes that apply, and remove the not
applicable items -->
- [ ] Avoid including large-size files in the PR.
- [ ] Clean up long text outputs from code cells in the notebook.
- [ ] For security purposes, please check the contents and remove any
sensitive info such as user names and private key.
- [ ] Ensure (1) hyperlinks and markdown anchors are working (2) use
relative paths for tutorial repo files (3) put figure and graphs in the
`./figure` folder
- [ ] Notebook runs automatically `./runner.sh -t <path to .ipynb file>`

Signed-off-by: YunLiu <[email protected]>
@adamltyson
Copy link

Hi @KumoLiu,

Do you have an idea of when this new version will be released? We'd love to use MONAI within @brainglobe, but we need support for numpy>2.

Thanks!

@arthurdjn
Copy link

Same here. Can work on a few PRs too

@ericspod ericspod mentioned this issue Jun 6, 2025
7 tasks
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

No branches or pull requests

4 participants