v0.10.0

v0.10.0

Massive overhaul to improve typing and linting to support the CDAO JATIC program,
as well as adding a new saliency algorithm called MC-RISE to the repertoire.

Updates / New Features

Code

• Updated hundreds of typing and linting needs.

• Added MC-RISE classification saliency algorithm.

Documentation

• Removed a deprecated badge from the README.

• Updated linting for documents.

• Added Maintainer_Guide_GitLab_to_GitHub.md to provide detailed guidelines.
  for synchronizing GitHub and GitLab repositories.

Dependencies

• Updated the minimum supported scipy to address vulnerability.

CI/CD

• Added check for release notes on GitLab.

• Added numerous GitLab yml files required.

Fixes

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.