Change in behaviour of PDHG about cil HOT 4 OPEN

I've switched to doing the progress bar updates from a callback:
mantidproject/mantidimaging@5006fd3

It would be good if there was a mention in the release notes about the change.

from cil.

So far algo.max_iteration is used, although we would like to discourage it in favour of the algo.run method with callbacks.
Also, next has been removed (it was there for compatibility with Python2) but __next__ is still there.

from cil.

For now you could use:

algo = PDGH(...)
algo.max_iterations = 1000000
for i in iter(algo):
    ...  # do something with algo

but it might stop working in a future release.

Best is:

from cil.optimisation.utilities.callbacks import Callback, ProgressCallback

class EachIterCallback(Callback):
    def __call__(self, algo):
        ...  # do something with algo

algo = PDHG(...)
algo.run(1000000, callbacks=[ProgressCallback(), EachIterCallback()])

vis. https://tomographicimaging.github.io/CIL/v24.0.0/optimisation/#callbacks

If you've made any custom callbacks you think others will benefit from (e.g. TensorboardCallback or something) please do open a PR adding it to Wrappers/Python/cil/optimisation/utilities/callbacks.py!

from cil.

I've switched to doing the progress bar updates from a callback: mantidproject/mantidimaging@5006fd3

lgtm!

It would be good if there was a mention in the release notes about the change.

Unfortunately it is mentioned in the highly inaccessible CIL@master:/CHANGELOG.md but for some unknown reason @TomographicImaging/cil-developers seem to dislike keeping the more standard CIL/releases readable/helpful/neat/up-to-date/in-sync 😠

from cil.