Changelog¶

All notable changes to this project will be documented in this file.

The format is inspired by Keep a Changelog,
and Element
and this project adheres to Semantic Versioning.

Unreleased¶

API changes warning ⚠️:¶

• Drop support for Python 3.8 and 3.9

Added Features and Improvements 🙌:¶

• Add support for Python 3.13 and 3.14
• Add volume_stable invariant measure to NormalizedMI
• Add radius_median and volume_median invariant measures, which are robust
  against outliers, e.g. from log-distributed data on a linear scale (#6)
• Add tutorial notebook explaining invariant measures, normalization methods,
  and the local-uniformity assumption

Bugfix 🐛:¶

• Fix error introduced in #8 by not supporting lists as arguments
• Fix beartype error when the estimated mutual information is exactly zero (#7)

Other changes:¶

• Migrate tech stack to use uv and ruff
• Upgrade gh actions to latest version
• Fix mkdocs documentation build on Python 3.14 and newer mkdocstrings
• Render docstring line breaks correctly via the nl2br Markdown extension
• Migrate documentation from mkdocs-material to Zensical
  and deploy it via GitHub Pages actions instead of the gh-pages branch

0.2.1 - 2024-10-08¶

Added Features and Improvements 🙌:¶

• Allowing to use features of different dimensions by @marko-tuononen

Other changes:¶

• Upgrade gh actions to latest version

0.2.0 - 2024-03-11¶

API changes warning ⚠️:¶

• Changed default for invariant measure to volume
• Changed default for normalization method to geometric

Added Features and Improvements 🙌:¶

• Added an icon, thx to @gegabo

Bugfix 🐛:¶

• Fix beartype warning for small number of samples

0.1.1 - 2023-11-07¶

Added Features and Improvements 🙌¶

• Add python 3.12 support

Other changes:¶

• Slightly improved Readme and docs

0.1.0 - 2023-09-13¶

• Initial release 🎉