Fix CHANGELOG.md

trustyai-explainability · Jan 15, 2024 · bfd3e5a · bfd3e5a
1 parent 34b3bd8
commit bfd3e5a
Showing 1 changed file with 144 additions and 66 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -2,149 +2,219 @@
 
 All notable changes to this project will be documented in this file.
 
-## [unreleased]
+## [0.4.0] - 2024-01-15
 
-### Bug Fixes
+- feat: Publish using PyPi Trusted Providers (#[183]((https://github.com/trustyai-explainability/trustyai-explainability-python/pull/183))) 
+- Update README.md ([#184]((https://github.com/trustyai-explainability/trustyai-explainability-python/pull/184))) 
+- Update pyarrow and pillow dependencies ([#187]((https://github.com/trustyai-explainability/trustyai-explainability-python/pull/187))) 
+- Add WER metric ([#189]((https://github.com/trustyai-explainability/trustyai-explainability-python/pull/189)))
+- Change WER signature ([#190]((https://github.com/trustyai-explainability/trustyai-explainability-python/pull/190))) 
+- Add Levenshtein distance ([#191]((https://github.com/trustyai-explainability/trustyai-explainability-python/pull/191)))
+- fix typo in tutorial.rst ([#193]((https://github.com/trustyai-explainability/trustyai-explainability-python/pull/193))) 
 
-- Fix typo in tutorial.rst (#193)
+## [0.3.0] - 2023-08-01
 
+This is the first version of Python TrustyAI to include support for external explainability algorithms.
 
+In this release we've included AIX360's `TSICE`, `TSLime` and `TSSaliency` time-series explainers.
+To use these explainers TrustyAI's extra dependencies must be installed with `pip install trustyai[extras]`.
 
-### Features
+- Refactor TrustyAI fairness metrics namespaces ([#156](https://github.com/trustyai-explainability/trustyai-explainability-python/pull/156))
+- Upgrade pyarrow dependency ([#159](https://github.com/trustyai-explainability/trustyai-explainability-python/pull/159))
+- Initial support for external algorithms ([#160]((https://github.com/trustyai-explainability/trustyai-explainability-python/pull/160)))
+- Replace deprecated requirements file ([#166]((https://github.com/trustyai-explainability/trustyai-explainability-python/pull/166)))
+- Update date, logo and favicon ([#168]((https://github.com/trustyai-explainability/trustyai-explainability-python/pull/168)))
+- Support TSICE explanations as plots ([#169]((https://github.com/trustyai-explainability/trustyai-explainability-python/pull/169)))
+- Add TSSaliency to Python TrustyAI ([#172]((https://github.com/trustyai-explainability/trustyai-explainability-python/pull/172)))
+- Add TSLime explainer by ([#174]((https://github.com/trustyai-explainability/trustyai-explainability-python/pull/174)))
+- Update TSSaliency plots to include smoothing ([#176]((https://github.com/trustyai-explainability/trustyai-explainability-python/pull/176)))
+- Fix invalid Development Status ([#178]((https://github.com/trustyai-explainability/trustyai-explainability-python/pull/178)))
+- Update direct dependency to released dependency ([#179]((https://github.com/trustyai-explainability/trustyai-explainability-python/pull/179)))
 
-- Publish using PyPi Trusted Providers (#183)
 
-## [0.3.0] - 2023-08-01
+## [0.2.12] - 2023-04-24
 
-## [sprint-1.28] - 2023-05-22
-
-## [0.2.12] - 2023-04-25
 
 ### Bug Fixes
 
-- Fixed broken gridding after bokeh 3.0.x update (#153)
+
+- Fixed broken gridding after bokeh 3.0.x update ([#153](https://github.com/trustyai-explainability/trustyai-explainability-python/pull/153))
 
 ## [0.2.11] - 2023-04-24
 
+
 ### Bug Fixes
 
-- Fixed null pointer error for Numpy inputs to Tyrus (#149)
+
+- Fixed null pointer error for Numpy inputs to Tyrus ([#149](https://github.com/trustyai-explainability/trustyai-explainability-python/pull/149))
 
 ## [0.2.10] - 2023-04-13
 
 ## [0.2.9] - 2023-02-23
 
-### FAI-825
 
-- Add feature and output name specification to models (#130)
+### [FAI-825](https://issues.redhat.com/browse/FAI-825)
+
+
+- Add feature and output name specification to models ([#130](https://github.com/trustyai-explainability/trustyai-explainability-python/pull/130))
+
+
+### [FAI-841](https://issues.redhat.com/browse/FAI-841)
+
+
+- Python benchmarks failing since namespace migration ([#82](https://github.com/trustyai-explainability/trustyai-explainability-python/pull/82))
+
+
+### [FAI-849](https://issues.redhat.com/browse/FAI-849)
+
+
+- Tyrus dashboard ([#97](https://github.com/trustyai-explainability/trustyai-explainability-python/pull/97))
+
+
+### [FAI-855](https://issues.redhat.com/browse/FAI-855)
+
+
+- Move arrow converters into exp-core ([#101](https://github.com/trustyai-explainability/trustyai-explainability-python/pull/101))
+
+
+### [FAI-863](https://issues.redhat.com/browse/FAI-863)
+
+
+- XAI-Bench ([#109](https://github.com/trustyai-explainability/trustyai-explainability-python/pull/109))
+- XAIbench submodule tracking main branch, fork of xai-bench ([#111](https://github.com/trustyai-explainability/trustyai-explainability-python/pull/111))
+
+
+### [FAI-864](https://issues.redhat.com/browse/FAI-864)
+
+
+- Fix failing RtD build after to pip migration ([#100](https://github.com/trustyai-explainability/trustyai-explainability-python/pull/100))
+
+
+### [FAI-867](https://issues.redhat.com/browse/FAI-867)
+
+
+- Add Java 9+ Arrow compatibility flags ([#103](https://github.com/trustyai-explainability/trustyai-explainability-python/pull/103))
+
 
-### FAI-841
+### [FAI-879](https://issues.redhat.com/browse/FAI-879)
 
-- Python benchmarks failing since namespace migration (#82)
 
-### FAI-849
+- Sync version with exp-core ([#107](https://github.com/trustyai-explainability/trustyai-explainability-python/pull/107))
 
-- Tyrus dashboard (#97)
 
-### FAI-855
+### [FAI-880](https://issues.redhat.com/browse/FAI-880)
 
-- Move arrow converters into exp-core (#101)
 
-### FAI-863
+- Move explainers into separate files ([#110](https://github.com/trustyai-explainability/trustyai-explainability-python/pull/110))
 
-- XAI-Bench (#109)
-- XAIbench submodule tracking main branch, fork of xai-bench (#111)
 
-### FAI-864
+### [FAI-881](https://issues.redhat.com/browse/FAI-881)
 
-- Fix failing RtD build after to pip migration (#100)
 
-### FAI-867
+- Upgrade Pylint version ([#112](https://github.com/trustyai-explainability/trustyai-explainability-python/pull/112))
 
-- Add Java 9+ Arrow compatibility flags (#103)
 
-### FAI-879
+### [FAI-882](https://issues.redhat.com/browse/FAI-882)
 
-- Sync version with exp-core (#107)
 
-### FAI-880
+- Add kwargs to explainers ([#113](https://github.com/trustyai-explainability/trustyai-explainability-python/pull/113))
 
-- Move explainers into separate files (#110)
 
-### FAI-881
+### [FAI-884](https://issues.redhat.com/browse/FAI-884)
 
-- Upgrade Pylint version (#112)
 
-### FAI-882
+- Add SHAP background generators to bindings ([#117](https://github.com/trustyai-explainability/trustyai-explainability-python/pull/117))
 
-- Add kwargs to explainers (#113)
 
-### FAI-884
+### [FAI-886](https://issues.redhat.com/browse/FAI-886)
 
-- Add SHAP background generators to bindings (#117)
 
-### FAI-886
+- Unified input/output types, conversion functions, and docstrings ([#116](https://github.com/trustyai-explainability/trustyai-explainability-python/pull/116))
 
-- Unified input/output types, conversion functions, and docstrings (#116)
 
-### FAI-887
+### [FAI-887](https://issues.redhat.com/browse/FAI-887)
 
-- Generalize ExplanationResults (#115)
 
-### FAI-889
+- Generalize ExplanationResults ([#115](https://github.com/trustyai-explainability/trustyai-explainability-python/pull/115))
 
-- Allow non-string categorical feature domains (#118)
 
-### FAI-892
+### [FAI-889](https://issues.redhat.com/browse/FAI-889)
 
-- Tyrus TempDirectory (#121)
 
-### FAI-893
+- Allow non-string categorical feature domains ([#118](https://github.com/trustyai-explainability/trustyai-explainability-python/pull/118))
 
-- Make test plots non-blocking by default (#120)
 
-### FAI-896
+### [FAI-892](https://issues.redhat.com/browse/FAI-892)
 
-- Doc standardization and cleanup (#126)
 
-### FAI-897
+- Tyrus TempDirectory ([#121](https://github.com/trustyai-explainability/trustyai-explainability-python/pull/121))
 
-- Add bokeh dependency (#123)
 
-### FAI-900
+### [FAI-893](https://issues.redhat.com/browse/FAI-893)
 
-- Added feature domain argument to counterfactuals (#128)
 
-### FAI-901
+- Make test plots non-blocking by default ([#120](https://github.com/trustyai-explainability/trustyai-explainability-python/pull/120))
 
-- Increased input/ouput conversion flexibility (#127)
 
-### FAI-903
+### [FAI-896](https://issues.redhat.com/browse/FAI-896)
 
-- Add group fairness Python bindings (#129)
 
-### FAI-911
+- Doc standardization and cleanup ([#126](https://github.com/trustyai-explainability/trustyai-explainability-python/pull/126))
 
-- Improve API to declare selections in Python fairness (#132)
 
-### FAI-917
+### [FAI-897](https://issues.redhat.com/browse/FAI-897)
 
-- Add error message capturing within Python models (#137)
 
-### FAI-926
+- Add bokeh dependency ([#123](https://github.com/trustyai-explainability/trustyai-explainability-python/pull/123))
 
-- Implement custom counterfactual goal criteria (#140)
 
-### FAI-952
+### [FAI-900](https://issues.redhat.com/browse/FAI-900)
 
-- Change dependencies to align with ODH workbench images (#143)
 
-## [test-pipeline-1] - 2022-10-12
+- Added feature domain argument to counterfactuals ([#128](https://github.com/trustyai-explainability/trustyai-explainability-python/pull/128))
+
+
+### [FAI-901](https://issues.redhat.com/browse/FAI-901)
+
+
+- Increased input/ouput conversion flexibility ([#127](https://github.com/trustyai-explainability/trustyai-explainability-python/pull/127))
+
+
+### [FAI-903](https://issues.redhat.com/browse/FAI-903)
+
+
+- Add group fairness Python bindings ([#129](https://github.com/trustyai-explainability/trustyai-explainability-python/pull/129))
+
+
+### [FAI-911](https://issues.redhat.com/browse/FAI-911)
+
+
+- Improve API to declare selections in Python fairness ([#132](https://github.com/trustyai-explainability/trustyai-explainability-python/pull/132))
+
+
+### [FAI-917](https://issues.redhat.com/browse/FAI-917)
+
+
+- Add error message capturing within Python models ([#137](https://github.com/trustyai-explainability/trustyai-explainability-python/pull/137))
+
+
+### [FAI-926](https://issues.redhat.com/browse/FAI-926)
+
+
+- Implement custom counterfactual goal criteria ([#140](https://github.com/trustyai-explainability/trustyai-explainability-python/pull/140))
+
+
+### [FAI-952](https://issues.redhat.com/browse/FAI-952)
+
+
+- Change dependencies to align with ODH workbench images ([#143](https://github.com/trustyai-explainability/trustyai-explainability-python/pull/143))
 
 ## [0.2.5] - 2022-09-14
 
+
 ### Bug Fixes
 
+
 - Fixed linting, adding doc build reqs to requirements-dev
 
 - Fixed line-too-long linting errors
@@ -192,16 +262,20 @@ All notable changes to this project will be documented in this file.
 - Fixed broken output casting for 1d output arrays
 
 
-### FAI-797b
+
+### [FAI-797b](https://issues.redhat.com/browse/FAI-797b)
+
 
 - Include doc link in README
 
 ## [0.2.4] - 2022-06-16
 
 ## [0.2.3] - 2022-05-12
 
+
 ### Bug Fixes
 
+
 - Fixed missing final newline
 
 
@@ -211,17 +285,21 @@ All notable changes to this project will be documented in this file.
 
 ## [0.2.0] - 2022-04-22
 
+
 ### Bug Fixes
 
+
 - Fixed linting issues
 
 - Fixed linting issues re. the glob checker for wildcard paths
 
 - Fixed line-too-long linting issue in model/__init__
 
 
+
 ### Refactor
 
+
 - Refactored arrow inclusion; mvn pulls dependencies, then includes precompiled arrowconverters jar