Please consider improving the visibility of breaking API changes (perform_everything_on_gpu
-> _device
)
#1972
joshuacwnewton
started this conversation in
General
Replies: 0 comments
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
-
Commit 1315d2f renamed the
perform_everything_on_gpu
parameter toperform_everything_on_device
.This is a breaking API change, meaning that any downstream projects based on the
nnunetv2
package that used this parameter will fail when updating tonnunetv2==2.3.x
. When such failures happen, developers will come to thennunetv2
repository to look for explanations (e.g. changelog entries, relevant issues/PRs, etc.)But, this breaking API change was made in a commit containing several other changes, and with a commit message that does not highlight the breaking change. This means that, when searching the repository for 'perform_everything_on_gpu', there will be no relevant results that explain the API change. (I had to dig into the
git blame
to find the relevant commit.)It would be very helpful if, in the future, when such a change is made, that the changes are effectively communicated to the community (e.g. via a deprecation warning, via an announcement, via a changelog entry, etc.). Or, alternatively, consider not making such changes in the first place if they are not absolutely critical.
Thank you kindly for your time and support in maintaining this package.♥️
Beta Was this translation helpful? Give feedback.
All reactions