v0.9.2

v0.9.2

This is a quick hotfix to remove a pinned version of tqdm.

Updates / New Features

Fixes

• Removed an accidental tqdm pin and put it as a lower-bound.

v0.9.1

v0.9.1

Fixed a bug where if no detections were found in an image, then the generator would fail.

Updates / New Features

Documentation

• Removed a deprecated badge from the README.

Implementations

• Added a check to exit early if no detections were found in PerturbationOcclusion

• Added a check to exit early if no saliency maps were generated in GenerateObjectDetectorBlackboxSaliency

Fixes

v0.9.0

v0.9.0

Dropped support for Python 3.8 and addressed dependency vulnerabilities.

Updates / New Features

Python

• Dropped support for Python 3.8.

CI/CD

• Dropped scanning for Python 3.8 and changed default to Python 3.9.

Documentation

• ReadTheDocs now uses Python 3.9.

• ReadTheDocs now uses poetry install.

Fixes

Notebooks

• Added pandas to examples/MNIST_scikit_saliency.ipynb.

v0.8.3

v0.8.3

A quick hotfix to address scikit-learn compatability issues.

Updates / New Features

Fixes

• Increased scikit-learn lower bound to address CVE-2024-5206

v0.8.2

v0.8.2

A quick hotfix to resolve Python 3.12 numpy dependencies.

Updates / New Features

Fixes

• Added numpy pin ^1.26 for Python 3.12.

v0.8.1

v0.8.1

Addressed a few dependency vulnerabilities and updated the CI/CD to current versions.

Updates / New Features

CI/CD

• Updated to use checkout@v4 and cache@v4 instead of *@v2.

Fixes

Dependencies

• Fixed numpy dependency versions for downstream resolution.

• Jupyter notebooks now installed with notebook instead of jupyter.

• Increased the lower bound of tqdm to 4.66.3 to address CVE-2024-34062.

• Ran poetry update to update poetry.lock for vulnerability scanning.

v0.8.0

v0.8.0

Updated dependencies to support Python 3.12 along with a few other smaller bug fixes.

Updates / New Features

CI/CD

• Changed CodeCov version from v3 to v4.

• Add python 3.12 to test matrix

Docker

• Update Dockerfile install of poetry, and make separate & specific directory
  copies.

Utils

• Updated logging format of occlusion masking benchmark utility.

Fixes

Tests

• Fix various floating point equality comparisons to not use exact match.

• Fix random number usage from numpy to use np.random.default_rng.

• Fix error being masked in test_sal_on_coco_dets

v0.7.0

v0.7.0

This minor release updates the mimumum supported python to python = "^3.8", addresses dependency vulnerabilities, and updates typing to conform with current mypy and pytest standards.

Updates / New Features

Build

• New minimum supported python changed to python = "^3.8".

CI

• Updated codecov action version to 3.

• Added explicit use of codecov token to facilitate successful coverage
  submission.

• Updated publish/release CI workflow.

Dependencies

• Updated notebook dependency due to a vulnerability alert.

• Periodic update of locked dep versions within abstract version constraints.

• Updated sphinx versions to fix local documentation building issue.

• Updated python minimum requirement to 3.8 (up from 3.6). This involved a
  number of updates and bifurcations of abstract requirements, an update to
  pinned versions for development/CI, and expansion of CI to cover python
  versions 3.10 and 3.11 (latest current release).

Fixes

Docs

• Added missing step to the release process about creating the release on
  GitHub's Releases section.

Examples

• Added a note to each example about restarting the runtime for compatibility
  with Colab, as well as a step to create a data directory if necessary.

v0.6.1

v0.6.1

This patch specializes the release CI workflow for this organization and
repository as opposed to previously relying on the remote workflow.

Fixes

CI

• Fix the publish workflow to use appropriate values and version for the
  containing org and this repository.

• Update CI workflows to also run for update-to-v* branches.

v0.6.0

v0.6.0

This minor release notably adds new high-level interfaces for black-box object
detector and image similarity saliency generation.
We provide some reference implementations for these interfaces, notably the
D-RISE and SBSM algorithms, respectively.

Other improvements include the addition of more examples notebooks,
improvements/fixes to existing implementations and a revision to the CLI object
detection saliency generation tool.

See below for more details.

Updates / New Features

CI

• Added the ATARI example notebook to the list of notebooks to run during CI.

Documentation

• Update saliency algorithms table with perturbation-based saliency for reinforcement learning
  and add corresponding section to README.

• Added a lighter color version of the logo that will appear better is both
  light- and dark-theme contexts. The main README file has been updated to refer
  to this image.

• Added introductory sentence to the style sheet document.

• Updated the release process to be incrementally more comprehensive and now
  includes the specification of a release branch with better patch release
  instructions. This also now includes a step to update the version referenced
  in the xaitk.org source.

Examples

• Updated demo resource download links from Google Drive to data.kitware.com

• Added example using saliency to qualitatively compare two object detection
  models.

• Updated SimilarityScoring example to use new high-level image similarity
  saliency interface and follow new similarity interface inputs.

Interfaces

• Added new high-level interface for black-box object detector saliency,
  GenerateObjectDetectorBlackboxSaliency.

• Updated image similarity interface GenerateDescriptorSimilaritySaliency to
  accept multiple query images and compute a saliency map for each one, relative
  to the reference image.

• Added new high-level interface for image similarity saliency,
  GenerateImageSimilarityBlackboxSaliency.

Implementations

• Added three GenerateObjectDetectorBlackboxSaliency implementations: the
  generic PerturbationOcclusion, and two usable classes DRISEStack
  and RandomGridStack.

• Updated behavior of the SlidingWindow PerturbImage implementation. For
  a given stride, the number of masks generated is now agnostic to the window
  size.

• Updated SimilarityScoring to return [N x H x W] instead of [1 x H x W]
  saliency heatmaps matrix. This is inline with the similarity interface update.

• Added two implementations of GenerateImageSimilarityBlackboxSaliency:
  PerturbationOcclusion and SBSMStack.

Misc.

• Updated poetry-core build backend to version 1.0.8, which now supports
  pip editable installs (pip install -e .).

Utils

• Updated COCO utility functions to use new high-level detector interface.
  gen_coco_sal() is now deprecated in exchange for parse_coco_dset() which
  parses a kwcoco.CocoDataset object into the inputs used with an
  implementation of GenerateObjectDetectorBlackboxSaliency.

Fixes

Dependency Versions

• Update pinned jupyter notebook transitive dependency version due to
  vulnerability warning.

Examples

• Fixed inconsistency of dependency package installs at the head of the
  examples/SerializedDetectionSaliency.ipynb notebook.