Prepare release notes for v0.20.0 by lagru · Pull Request #6556 · scikit-image/scikit-image

lagru · 2022-10-03T15:56:55Z

Description

Start preparation of the release notes for scikit-image 0.20.0. The initial list of PRs was generated with generate_release_notes.py. Compared to 0.19 and release_template.rst I'm using different sections to structure the changes for now. This is because I'm not very clear on the distinction between suggested sections like "API Changes", "Deprecations" and "Backward Incompatible Changes".

Sort and summarize PRs until creation of this pull request (2022-10-03)
Sort and summarize PRs since creation of this pull request (2022-10-03)
address open questions
Summarize highlights in first section

And keep up to date...

produced by generate_release_notes.py. Still requires manual cleaning.

"New features" MUST be totally backwards compatible. Everything else goes into "changes and new deprecations".

mkcor

Thanks for starting this!

doc/release/release_0.20.rst

stefanv

Thanks for starting this.

The biggest issue I see is that some PRs are listed twice.

doc/release/release_0.20.rst

jarrodmillman · 2022-10-03T20:55:21Z

@lagru Thanks for starting this. I was just chatting w/ Stefan about the 0.20 release. I tentatively volunteered to make the 0.20 release and am happy to do it, if it is helpful.

According to the schedule, Python 3.11.0 final is due Monday, 2022-10-24. I would like to release 0.20 just before or just after the 3.11 release with 3.11 wheels. NumPy, matplotlib, Pandas, and a few other packages have already released 3.11 wheels.

My preference (for what it is worth) would be to release 0.20 before 10/24 and move all the remaining issues and PRs for 0.20 to 0.21.

If we are going to release 0.20 before 10/24, we should release a 0.20rc1 10/17 or before. The main thing left that I would like to see merged first is the meson stuff and I would like to bump the NetworkX requirements. For NetworkX, we are about to release version 3.0 and it would be good to have scikit-image require at least 2.8 as a minimum NetworkX requirement as it has all the pending deprecations for NX 3.0.

lagru · 2022-10-04T07:31:47Z

Thanks everyone. I'll go through the suggested changes. A lot of the stuff I just haven't gotten to yet.

@jarrodmillman I don't have a preference between your suggested release dates. I'll try to get this is shape bit by bit until the middle of next week if that's early enough.

Some suggestions I plan to edit locally, some I'd like to discuss first. Co-authored-by: Stefan van der Walt <sjvdwalt@gmail.com> Co-authored-by: Marianne Corvellec <marianne.corvellec@ens-lyon.org>

Use present tense and imperative tone for release notes. Try to be more precise about why and how things changed. Co-authored-by: Marianne Corvellec <marianne.corvellec@ens-lyon.org> Co-authored-by: Stefan van der Walt <sjvdwalt@gmail.com>

A lot of the removed PRs were already backported to 0.19. So I'm ignoring these for 0.20. Note that I'm checking if the commit is available in these releases with "git tag --contains <COMMIT_HASH>".

I'm confused with what to do abou the Milestone 1.0. Should these be included in 0.20 now. Collect them for now until that's confirmed. Furthermore, collect the backported PRs. We can delete them later but for now it's useful to keep them for review and in case we want to go back. Note that quite a lot are missing because I didn't start this earlier.

jni · 2022-10-11T13:50:54Z

Man there's some nice things in here! 😊 thanks @lagru!

doc/release/release_0.20.rst

lagru · 2022-10-15T16:13:21Z

doc/release/release_0.20.rst

+- Use the minimal required unsigned integer size in ``skimage.filters.rank_order`` which allows to operate the function with higher precision or on larger arrays.
+  Previously, the returned ``labels`` and and ``original_values`` were always of type uint32.
+  (`#6342 <https://github.com/scikit-image/scikit-image/pull/6342>`_).
+- Use the minimal required unsigned integer internally in ``skimage.morphology.reconstruction`` which allows to operate the function with higher precision or on larger arrays.
+  Previously, int32 was used.
+  (`#6342 <https://github.com/scikit-image/scikit-image/pull/6342>`_).


@grlee77, could you please have look if I correctly summarized #6342?

single precision seed now returns single precision output (this function was missed during previous float32 work)

I'm confused about this bit, because I don't see any changes in the PRs diff that should impact seed?

This was just referring to a place where morphology.reconstruct had unconditional promotion to float64 internally. See at the left in the diff here on lines 173-175 where seed and mask used to get copied into a float64 images array. This was changed to use _supported_float_type so it is possible to get single precision output from this function.

https://github.com/scikit-image/scikit-image/pull/6342/files#diff-a0783c211f0b0a66e4cc41bf1838cdafe46ab957a9dfdb685784aecd64135243L173

Thanks for the clarification. So actually mask determines the dtype of the output and not seed?

Good question... I would assume we would want "float_dtype = max { _supported_float_type(seed.dtype), _supported_float_type(mask.dtype) }" 🤔

Co-authored-by: Marianne Corvellec <marianne.corvellec@ens-lyon.org>

as of 2022-12-05.

Only PR left is the one with the long list of completed deprecations.

Co-authored-by: Marianne Corvellec <marianne.corvellec@ens-lyon.org>

lagru · 2022-12-07T12:59:28Z

Okay, after summarizing #6583 😮‍💨, this should be up to date now. 😁 I'm unsure how we want to proceed.

mkcor · 2022-12-08T15:02:51Z

Okay, after summarizing #6583 face_exhaling, this should be up to date now. grin I'm unsure how we want to proceed.

Thanks for all the work, @lagru! I guess that, right after merging this PR, we want to create a branch from main with the right name, which will trigger the builds we need... Do you have this in your notes from the 'knowledge transfer' meeting with @grlee77? 👼

grlee77 · 2022-12-08T18:20:04Z

Thanks for all the work, @lagru! I guess that, right after merging this PR, we want to create a branch from main with the right name, which will trigger the builds we need... Do you have this in your notes from the 'knowledge transfer' meeting with @grlee77?

I don't think we looked more at how to run/test the wheels locally, but didn't really cover all aspects of that. Given the infrequency of these releases, I always refer back to https://github.com/scikit-image/scikit-image/blob/main/RELEASE.txt

We should start with tagging an alpha or release candidate, given the large number of API changes. We can then make sure the wheels seem solid before tagging the final release. I think @jarrodmillman said he may have some time to work on it after a new networkx release is out.

grlee77 · 2022-12-08T18:28:10Z

Forgot to mention that creating the branch does not trigger wheel builds. Only pushing a tag starting with the pattern here will trigger the wheel build action:

scikit-image/.github/workflows/wheel_tests_and_release.yml

Lines 1 to 6 in ae28814

    
           name: Build Wheels and Release 
        
           on: 
        
             push: 
        
               tags: 
        
                 - "v*" 
        
                 - "buildwheels*"

Only those starting with v will attempt to automatically push to PyPI due to this if condition:

scikit-image/.github/workflows/wheel_tests_and_release.yml

Lines 225 to 236 in ae28814

    
           deploy: 
        
             permissions: 
        
               contents: write # for softprops/action-gh-release to create GitHub release 
        
             name: Release 
        
             needs: 
        
               [ 
        
                 build_linux_38_and_above_wheels, 
        
                 build_linux_aarch64_wheels, 
        
                 build_macos_wheels, 
        
                 build_windows_wheels, 
        
               ] 
        
             if: github.repository_owner == 'scikit-image' && startsWith(github.ref, 'refs/tags/v') && always()

lagru · 2022-12-08T18:35:04Z

Also we still have to create the highlights in first section if we want those. But that can probably be done after branching as well.

mkcor · 2022-12-15T11:25:38Z

Hi @lagru, I just merged #6650; the change is so tiny and trivial (does not modify any behavior) that I believe it's fine not to mention this PR in the release notes. Hope you don't mind!

lagru · 2022-12-16T11:13:42Z

@mkcor no worries. Adding an item it is easily done. ;)

doc/release/release_0.20.rst

Co-authored-by: Marianne Corvellec <marianne.corvellec@ens-lyon.org>

doc/release/release_0.20.rst

Co-authored-by: Marianne Corvellec <marianne.corvellec@ens-lyon.org>

See https://github.com/scikit-image/scikit-image/releases/tag/v0.19.0 for an example from an earlier release.

jarrodmillman

We should merge this for the 0.20rc1 release and we can fix it up afterward, if needed.

stefanv · 2023-01-09T23:42:53Z

Thanks @lagru. @jarrodmillman that sounds like a good plan.

This release also completes the transition to indicating multi-channel images with the more flexible channel_axis parameter as well as a many other deprecations to make scikit-image's API more consistent and expressive.

A sentence I think we should tweak a bit to read more easily.

lagru added 5 commits October 3, 2022 12:44

Add automatically generated v0.20 release notes

bd1174b

produced by generate_release_notes.py. Still requires manual cleaning.

Turn pr numbers into URLs

0584a46

Use template structure from release_dev.rst

7314281

Fix urls

f3bf249

Describe first PRs on footprint decomposition

251c33f

lagru added the 📄 type: Documentation Updates, fixes and additions to documentation label Oct 3, 2022

lagru added this to the 0.20 milestone Oct 3, 2022

lagru marked this pull request as draft October 3, 2022 15:57

lagru added 2 commits October 3, 2022 18:25

Remove PRs that were backported to v0.19

c459049

Separate "New features" and "Changes"

a83599e

"New features" MUST be totally backwards compatible. Everything else goes into "changes and new deprecations".

mkcor reviewed Oct 3, 2022

View reviewed changes

stefanv reviewed Oct 3, 2022

View reviewed changes

Apply suggestions from code review

43a1d12

Some suggestions I plan to edit locally, some I'd like to discuss first. Co-authored-by: Stefan van der Walt <sjvdwalt@gmail.com> Co-authored-by: Marianne Corvellec <marianne.corvellec@ens-lyon.org>

lagru mentioned this pull request Oct 5, 2022

Add spacing to regionprops and moments. #6296

Merged

6 tasks

Clarify some new features and address review

f756c44

Use present tense and imperative tone for release notes. Try to be more precise about why and how things changed. Co-authored-by: Marianne Corvellec <marianne.corvellec@ens-lyon.org> Co-authored-by: Stefan van der Walt <sjvdwalt@gmail.com>

mkcor mentioned this pull request Oct 5, 2022

Meta-issue: pending API changes for 2.0 #5439

Closed

lagru added 2 commits October 5, 2022 15:31

Add work on release notes

7f84ac6

A lot of the removed PRs were already backported to 0.19. So I'm ignoring these for 0.20. Note that I'm checking if the commit is available in these releases with "git tag --contains <COMMIT_HASH>".

Continue work on release notes

122c3fa

lagru force-pushed the prep-v0.20-notes branch from 0e76df3 to 122c3fa Compare October 8, 2022 20:21

lagru added 3 commits October 13, 2022 15:17

Merge branch 'main' into prep-v0.20-notes

e7c687d

Continue work on release notes

71999a8

Fix too short title underline

719da9c

jarrodmillman reviewed Oct 13, 2022

View reviewed changes

doc/release/release_0.20.rst Outdated Show resolved Hide resolved

lagru added 2 commits October 15, 2022 17:31

Continue work on 0.20 release notes

41b84f0

Continue work on 0.20 release notes

4c598ce

lagru commented Oct 15, 2022

View reviewed changes

lagru and others added 8 commits December 5, 2022 17:25

Apply modified suggestions from @mkcor

6dad067

Co-authored-by: Marianne Corvellec <marianne.corvellec@ens-lyon.org>

Add recent merged PRs to 0.20 release notes

5789ba4

as of 2022-12-05.

Continue work on release notes

7ba3c14

Fix contributor list

7a2ade5

Continue work on release notes

f98fb54

Only PR left is the one with the long list of completed deprecations.

Apply suggestions from @mkcor

c5564e5

Co-authored-by: Marianne Corvellec <marianne.corvellec@ens-lyon.org>

Remove unnecessary "the" in a few places

4007a76

Co-authored-by: Marianne Corvellec <marianne.corvellec@ens-lyon.org>

Continue work on release notes

c097eff

Add recently merged PR 6581

660f408

Add recently merged PR 6644

291a7ca

Add recently merged PR 6650

c1e6d34

mkcor reviewed Dec 16, 2022

View reviewed changes

doc/release/release_0.20.rst Outdated Show resolved Hide resolved

Don't use ambiguous "dep"

2ece78e

Co-authored-by: Marianne Corvellec <marianne.corvellec@ens-lyon.org>

mkcor reviewed Dec 16, 2022

View reviewed changes

doc/release/release_0.20.rst Outdated Show resolved Hide resolved

lagru and others added 4 commits December 17, 2022 12:56

Add recently merged PR 6652

08950e8

Co-authored-by: Marianne Corvellec <marianne.corvellec@ens-lyon.org>

Add recently merged PR 6655

0868bdf

Add draft of the highlights section

09c68f7

See https://github.com/scikit-image/scikit-image/releases/tag/v0.19.0 for an example from an earlier release.

Mark as prerelease

b088844

jarrodmillman approved these changes Jan 9, 2023

View reviewed changes

stefanv merged commit 28721f4 into scikit-image:main Jan 9, 2023

lagru deleted the prep-v0.20-notes branch January 13, 2023 12:05

jarrodmillman mentioned this pull request Feb 22, 2023

Release notes 0.20.0 #6766

Merged

Uh oh!

Conversation

lagru commented Oct 3, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Uh oh!

mkcor left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

stefanv left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

jarrodmillman commented Oct 3, 2022

Uh oh!

lagru commented Oct 4, 2022

Uh oh!

jni commented Oct 11, 2022

Uh oh!

Uh oh!

lagru Oct 15, 2022

Choose a reason for hiding this comment

Uh oh!

grlee77 Oct 17, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

lagru Oct 21, 2022

Choose a reason for hiding this comment

Uh oh!

mkcor Oct 31, 2022

Choose a reason for hiding this comment

Uh oh!

lagru commented Dec 7, 2022

Uh oh!

mkcor commented Dec 8, 2022

Uh oh!

grlee77 commented Dec 8, 2022

Uh oh!

grlee77 commented Dec 8, 2022

Uh oh!

lagru commented Dec 8, 2022

Uh oh!

mkcor commented Dec 15, 2022

Uh oh!

lagru commented Dec 16, 2022

Uh oh!

Uh oh!

Uh oh!

jarrodmillman left a comment

Choose a reason for hiding this comment

Uh oh!

stefanv commented Jan 9, 2023

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

lagru commented Oct 3, 2022 •

edited

Loading

grlee77 Oct 17, 2022 •

edited

Loading