1.4.0

• Metamer and MADCompetition initialization API change: replaces allowed_range and range_penalty_lambda keyword arguments with penalty_function and penalty_lambda.
  • Default behavior (using a penalty to encourage the synthesized image pixel values to lie between 0 and 1) is unchanged, but this will be a breaking change for you if you set the allowed_range or range_penalty_lambda arguments.
  • This change allows for the initial and target images' range of pixel values to differ.
  • This change also allows for a wider variety of penalty functions.
  • See documentation for more details.
• Major documentation improvements! This release changes our sphinx theme, reorganizes content, restructures the API docs, and continues to add examples to docstrings.
• Improves efficiency for SteerablePyramidFreq and PortillaSimoncelli models.
  • Relatedly, updates documentation for PortillaSimoncelli, including new recommendations for how to synthesize metamers.
• Removes deprecated NLP and gaussian1d objects.

Warning

The next release will be version 2.0.0, which will feature a breaking change restructuring plenoptic's API. See #418 for more details. A migration guide will be added in that release.

What's Changed

• Change Jenkins docker base image to pytorch, to reduce cache size by @billbrod in #380
• Speed up Steerable Pyramid, Portilla-Simoncelli by @billbrod in #377
• Corrects zenodo doi by @billbrod in #382
• Updates Portilla-Simoncelli synthesis in docs/tests by @billbrod in #381
• Updates jenkins torch version 2.9.0 -> 2.9.1 by @billbrod in #389
• Fix sphinx warnings and restructure API docs by @billbrod in #386
• Adds doctests to metamer.py, portilla_simoncelli.py; make pooch required by @billbrod in #392
• Docstring examples for tools/signal.py by @wulfdewolf in #408
• Changes theme to pydata-sphinx-theme by @billbrod in #410
• Replace os.path with pathlib by @billbrod in #414
• Adds version switcher, ability to skip matplotlib plot directive by @billbrod in #415
• Docstring examples for tools/conv.py, adds Wolf to CITATION.cff by @wulfdewolf in #412
• Remove matplotlib inline backend by @billbrod in #416
• Updates API docs by @billbrod in #413
• Add zizmor, replace fetch-ffmpeg action by @billbrod in #419
• Remove deprecated NLP, gaussian1d by @billbrod in #420
• Adds notes about other packages by @billbrod in #421
• Updates quickstart, model requirements pages by @billbrod in #422
• Update supported python versions to match that of pytorch by @billbrod in #423
• Small fixes to contributing rendering by @billbrod in #424
• Add regularization to synthesis methods via penalty_function by @dherrera1911 in #411
• Updates jenkins torch version 2.9.1 -> 2.10.0 by @billbrod in #405
• Store penalties over synthesis by @billbrod in #425
• increase precision for flaky test by @billbrod in #426
• Fix binder by @billbrod in #427
• add 1.4.0 to version_switcher by @billbrod in #429

Full Changelog: 1.3.1...1.4.0