CHANGELOG.md

CHANGELOG

v1.4.6 (2023-07-18)

Fix

• fix: breaking plot when feature contains extreme values (thanks to @marrrcin for reporting)

Closes #281 (93553b2)

v1.4.5 (2023-07-06)

Fix

• Upgrade to pydantic 2 (6c19baa)
• Jinja safe html (ecfd7c5)

v1.4.4 (2023-05-26)

Fix

• Static listing of extension requirements (1152598)

v1.4.3 (2023-05-25)

Fix

• Semantic-release build command (4ba57e3)

v1.4.2 (2023-05-25)

Fix

• Release version (dba70f2)

v1.4.1 (2023-05-25)

Fix

• Reference type in metric pipeline (99f8687)
• Ci (#269) (f3a34d1)

Documentation

• Update grafana logo link (88bd19d)
• readme: Article by Pradyot Patil (5496f8e)

v1.4.0 (2022-10-19)

Feature

• report: Summary table (a5b9a30)

v1.3.0 (2022-09-09)

Feature

• Remove skip_empty_plots (bd3ea29)

Fix

• comparisons: Unknown labels correct label axis (e0bbf04)
• report: Show zero value in bar plots (6a350d4)

Documentation

• readme: Fix table formatting (d6958c6)
• readme: Include scipy presentation (695ee17)

v1.2.0 (2022-09-01)

Feature

• report: Histogram inspector (5e78f98)
• Remove time of day from label when midnight or noon (1615bed)
• config: Deprecate skip_empty_plots (#249) (372ef85)

Fix

• Show heatmap descriptions (64a4952)

Documentation

• readme: Include histogram inspector in readme (3e68508)

v1.1.0 (2022-08-19)

Feature

• Extension functionality + diptest implementation @RUrlus (8487991)

Documentation

• config: Extend settings documentation (fa4d2fc)
• api: Restructure api documentation for clarity (affdd75)
• profiles: Profile extension (e859530)
• comparisons: Comparison extensions section (581e63c)
• Extensions in index (6c87fcb)
• readme: Add section about profile integrations and diptest (aa860a7)
• readme: Include citation information (#241) (3a29135)

v1.0.0 (2022-07-08)

Feature

• report: Group comparisons by reference key (#237) (e813534)
• Entropy profile (96dd7d1)
• Configurable title and colors (37fcd0e)
• Online report CDN for bootstrap, jquery (72df86d)
• Plotly express (2c2395c)
• Introduce self start reference type (ca22268)
• String representation for base classes (bd480a6)
• Keep section when changing features (7b12d06)
• config: Settings required parameter (47d6b17)
• registry: Generalize registry (d01c68a)
• registry: Add ks, pearson, chi2 to registry (4f8126d)
• config: Structured config using pydantic (bc52aeb)

Fix

• Prevent plot name collision that stops rendering (#238) (32c7ef4)
• Set time_width in synthetic data example (fbf7e41)
• Guaranteed ordering of traffic light metrics (88c3f4a)
• plot: Plot_heatmap_b64 top argument is now supported (8be8115)

Breaking

• matplotlib-related config is removed (2c2395c)
• Configuration of time_axis, features etc. is moved to the Settings class. (ca22268)
• new configuration syntax (bc52aeb)
• the plot_metrics and plot_overview settings are no longer available for Tl/alerts (1c4f072)
• the worst entry will no long be present in the datastore (e2b9ef7)

Documentation

• profiles: Add entropy (8e8ac00)
• Registry snippet to list available profiles/comparisons (7760047)
• comparisons: Overview in table (cde48c4)
• Profiles in table (65459af)
• Description for mean trend score (b5b7626)
• Update api structure (c6c53ba)
• Documentation for reference types (9cf8117)
• Update api documentation (74eb223)
• config: Configuration parameter docstrings (9eec883)
• registry: Instructions on comparison parameter setting (2e3b134)
• config: Update configuration examples (daccc36)

Performance

• Reduce file size of reports (329564f)

v0.10.2 (2022-06-21)

Fix

• Patched histogrammar bin_edges call for Bin histograms (590d266)

v0.10.1 (2022-06-15)

Fix

• Patched histogrammar num_bins call for Bin histograms (b34fe70)

v0.10.0 (2022-06-14)

Feature

• profiles: Custom profiles via registry pattern (d0eb98b)

Fix

• Protection against outliers in sparse histograms (#215) (10c3449)
• report: Traffic light flexbox on small screens (2faa7da)

Documentation

• synthetic: Update synthetic examples (#212) (84a9331)
• readme: Link profiles and comparisons page (17ac6d8)
• profiles: List the available profiles (#173) (15f78ec)

v0.9.0 (2022-05-27)

Feature

• report: Enable the overview section by default (22b9cb6)
• report: Overview section for quickly navigating reports (f5736d4)
• report: Allow section without feature toggle (2484569)

Fix

• report: Consistent use of color red (453f3fe)
• report: Text contrast and consistent yellow traffic light (5d5c43c)

Documentation

• readme: Replace report image (8d363d5)
• synthetic: Add dataset overview table (8654347)
• datasets: Reference implementations for widely-used publicly available synthetic data streams (9988a13)

v0.8.0 (2022-05-20)

Feature

• report: Heatmap time-series for categoricals (#194) (21c4ad1)
• Nd histogram comparisons and profiles (d572f7f)
• Dashboarding integration for Kibana (83b8869)
• Dashboarding integration for Kibana (4a9284f)
• config: Global configuration for ing_matplotlib_theme (c81e28f)

Fix

• Import histogrammar specialized (d70ab80)

Documentation

• config: Global configuration for ing_matplotlib_theme (6f4f20d)

Performance

• Directly use bin keys (9440897)
• Disable parallel processing by default (85d4407)
• Chi2 max residual using numpy (8596387)
• Performant data structure (ff72d6e)
• Short circuit any/all (63c2704)
• Optimize pull computation (ddf2e35)
• Postpone formatting (expensive for DataFrames) (7feaaae)
• Compute metrics without report (254564c)

v0.7.0 (2022-05-09)

Feature

• Global configuration of joblib Parallel backend (3431cad)

Fix

• Prevent numpy warnings (9ec3b66)

Documentation

• config: Document global configuration (e546994)
• readme: Extend articles section (0ec0273)

v0.6.1 (2022-04-29)

Fix

• plot: Fixing memory leak in matplotlib multithreading (cc6c4e1)

Documentation

• Include link to kedro-popmon (aff68b7)

v0.6.0 (2021-12-13)

Feature

• comparisons: Introduce psi and jsd (c6a1ca7)
• comparisons: Introduce comparison registry (031c146)

Documentation

• comparisons: Add comparisons page (60967c9)
• Fix broken link (2b38fc6)
• rtd: Install popmon (e9c4610)

v0.5.0 (2021-11-24)

Feature

• Improve pipeline visualization (bb09d73)

Fix

• Ensure uniqueness of apply_funcs_key (ba98c97)

Documentation

• rtd: Migrate config to v2 (a8d9f76)
• Refresh notebooks (#151) (0bccc7e)
• Pipeline visualizations in docs and notebooks (913bfb0)
• Changelog md syntax (b187d36)
• Specify requirements (e3f6b0a)

v0.4.4 (2021-10-22)

📖 Documentation

• notebook on report interpretation (dd3be73)

🐛 Bug fixes

• distinct incorrect result (constant) (3c47cde)
• prevent division by zero (bacf8dd)
• uu-chi2 incorrect return (e259d3e)

v0.4.3 (2021-10-04)

🐛 Bug fixes

• fix too restrictive numpy integer check in hist_stitcher (c162f11)

v0.4.2 (2021-08-25)

⬆️ Dependencies

• Pin ing-matplotlib-theme dependency to >=0.1.8 (closes #131) (1bca302b20f2434a8ea0dea195e974d3b2ed3da3)

v0.4.1 (2021-06-23)

🎉 Features

• tabular traffic light/alerts overviews (1d31265)

👷‍♂️ Internal improvements

• add utils to prevent code repetition (d4a28cb)
• convert dict constructor to dict literal (331d8b1), (b3d4d88), (9e5188c), (c9518ab)
• directly pass arguments (bf33807)

🐛 Bug fixes

• copyright in license (b16fd99), (60a22dd)
• extend TL config (eba10ed)
• mismatch between stats displayed in the traffic lights section and comparisons due to pattern matching bug. (5ffb0a9)

📖 Documentation

• add explanation for hiding green TLs by default (81095af)
• codemotion article (1e20f30)
• include changelog in docs (a2237d0)

⬆️ Dependencies

• pre-commit updates (6f55155), (8fc5518), (e02adf1)
• histogrammar: popmon working with hgr v1.0.23 (#101) (d4a986e)
• Pin ing-matplotlib-theme dependency to master (closes #131) (1e20f30)

v0.4.0 and before

The release notes for preceding versions are available here.