diff --git a/RELEASE.md b/RELEASE.md index 8194fa05..547654aa 100644 --- a/RELEASE.md +++ b/RELEASE.md @@ -1,3 +1,15 @@ + + +# Current Version (Still in Development) + +## Major Features and Improvements + +## Bug Fixes and Other Changes + +## Breaking Changes + +## Deprecations + # Version 0.41.0 ## Major Features and Improvements @@ -18,3 +30,377 @@ * N/A +# Version 0.40.0 + +## Major Features and Improvements + +* Allow counterfactual metrics to be calculated from predictions instead of + only features. +* Add precision and recall to the set of fairness indicators metrics. + +## Bug Fixes and Other Changes + +* Depends on `tensorflow-data-validation>=1.9.0,<1.10.0`. +* Depends on `tensorflow-model-analysis>=0.40,<0.41`. +* Depends on `tensorflow>=1.15.5,!=2.0.*,!=2.1.*,!=2.2.*,!=2.3.*,!=2.4.*,!=2.5.*,!=2.6.*,!=2.7.*,!=2.8.*,<3`. + +## Breaking Changes + +* N/A + +## Deprecations + +* N/A + +# Version 0.39.0 + +## Major Features and Improvements + +* Allow counterfactual metrics to be calculated from predictions instead of + only features. +* Add precision and recall to the set of fairness indicators metrics. + +## Bug Fixes and Other Changes + +* Depends on `tensorflow-data-validation>=1.8.0,<1.9.0`. +* Depends on `tensorflow-model-analysis>=0.39,<0.40`. +* Depends on `tensorflow>=1.15.5,!=2.0.*,!=2.1.*,!=2.2.*,!=2.3.*,!=2.4.*,!=2.5.*,!=2.6.*,!=2.7.*,<3`. + +## Breaking Changes + +* N/A + +## Deprecations + +* N/A + +# Version 0.38.0 + +## Major Features and Improvements + +* N/A + +## Bug Fixes and Other Changes + +* Depends on `tensorflow-data-validation>=1.7.0,<1.8.0`. +* Depends on `tensorflow-model-analysis>=0.38,<0.39`. +* Depends on `tensorflow>=1.15.5,!=2.0.*,!=2.1.*,!=2.2.*,!=2.3.*,!=2.4.*,!=2.5.*,!=2.6.*,!=2.7.*,<3`. + +## Breaking Changes + +* N/A + +## Deprecations + +* N/A + +# Version 0.37.0 + +## Major Features and Improvements + +* N/A + +## Bug Fixes and Other Changes + +* Fix Fairness Indicators UI bug with overlapping charts when comparing EvalResults +* Depends on `tensorflow-data-validation>=1.6.0,<1.7.0`. +* Depends on `tensorflow-model-analysis>=0.37,<0.38`. +* Depends on `tensorflow>=1.15.5,!=2.0.*,!=2.1.*,!=2.2.*,!=2.3.*,!=2.4.*,!=2.5.*,!=2.6.*,<3`. + +## Breaking Changes + +* N/A + +## Deprecations + +* N/A + +# Version 0.36.0 + +## Major Features and Improvements + +* N/A + +## Bug Fixes and Other Changes + +* Depends on `tensorflow-data-validation>=1.5.0,<1.6.0`. +* Depends on `tensorflow-model-analysis>=0.36,<0.37`. +* Depends on `tensorflow>=1.15.2,!=2.0.*,!=2.1.*,!=2.2.*,!=2.3.*,!=2.4.*,!=2.5.*,!=2.6.*,<3`. + +## Breaking Changes + +* N/A + +## Deprecations + +* N/A + +# Version 0.35.0 + +## Major Features and Improvements + +* N/A + +## Bug Fixes and Other Changes + +* Depends on `tensorflow-data-validation>=1.4.0,<1.5.0`. +* Depends on `tensorflow-model-analysis>=0.35,<0.36`. + +## Breaking Changes + +* N/A + +## Deprecations + +* Deprecating python 3.6 support. + +# Version 0.34.0 + +## Major Features and Improvements + +* N/A + +## Bug Fixes and Other Changes + +* Depends on `tensorflow>=1.15.2,!=2.0.*,!=2.1.*,!=2.2.*,!=2.3.*,!=2.4.*,!=2.5.*,<3`. +* Depends on `tensorflow-data-validation>=1.3.0,<1.4.0`. +* Depends on `tensorflow-model-analysis>=0.34,<0.35`. + +## Breaking Changes + +* Drop Py2 support. + +## Deprecations + +* N/A + +# Version 0.33.0 + +## Major Features and Improvements + +* Porting Counterfactual Fairness metrics into FI UI. + +## Bug Fixes and Other Changes + +* Improve rendering of HTML stubs for Fairness Indicators UI +* Depends on `tensorflow>=1.15.2,!=2.0.*,!=2.1.*,!=2.2.*,!=2.3.*,!=2.4.*,<3`. +* Depends on `protobuf>=3.13,<4`. +* Depends on `tensorflow-data-validation>=1.2.0,<1.3.0`. +* Depends on `tensorflow-model-analysis>=0.33,<0.34`. + +## Breaking Changes + +* N/A + +## Deprecations + +* N/A + +# Version 0.30.0 + +## Major Features and Improvements + +* N/A + +## Bug Fixes and Other Changes + +* Depends on `tensorflow>=1.15.2,!=2.0.*,!=2.1.*,!=2.2.*,!=2.3.*,!=2.5.*,<3`. +* Depends on `tensorflow-data-validation>=0.30,<0.31`. +* Depends on `tensorflow-model-analysis>=0.30,<0.31`. + +## Breaking Changes + +* N/A + +## Deprecations + +* N/A + +# Version 0.29.0 + +## Major Features and Improvements + +* N/A + +## Bug Fixes and Other Changes + +* Depends on `tensorflow-data-validation>=0.29,<0.30`. +* Depends on `tensorflow-model-analysis>=0.29,<0.30`. + +## Breaking Changes + +* N/A + +## Deprecations + +* N/A + +# Version 0.28.0 + +## Major Features and Improvements + +* In Fairness Indicators UI, sort metrics list to show common metrics first +* For lift, support negative values in bar chart. +* Adding two new metrics - Flip Count and Flip Rate to evaluate Counterfactual + Fairness. +* Add Lift metrics under addons/fairness. +* Porting Lift metrics into FI UI. + +## Bug Fixes and Other Changes + +* Depends on `tensorflow-data-validation>=0.28,<0.29`. +* Depends on `tensorflow-model-analysis>=0.28,<0.29`. + +## Breaking Changes + +* N/A + +## Deprecations + +* N/A + +# Version 0.27.0 + +## Major Features and Improvements + +* N/A + +## Bug fixes and other changes + +* Added test cases for DLVM testing. +* Move the util files to a seperate folder. +* Add `tensorflow-hub` as a dependency because it's used inside the + example_model.py. +* Depends on `tensorflow>=1.15.2,!=2.0.*,!=2.1.*,!=2.2.*,!=2.3.*,<3`. +* Depends on `tensorflow-data-validation>=0.27,<0.28`. +* Depends on `tensorflow-model-analysis>=0.27,<0.28`. + +## Breaking changes + +* N/A + +## Deprecations + +* N/A + +# Version 0.26.0 + +## Major Features and Improvements + +* Sorting fairness metrics table rows to keep slices in order with slice drop + down in the UI. + +## Bug fixes and other changes + +* Update fairness_indicators.documentation.examples.util to TensorFlow 2.0. +* Table now displays 3 decimal places instead of 2. +* Fix the bug that metric list won't refresh if the input eval result changed. +* Remove d3-tip dependency. +* Depends on `tensorflow>=1.15.2,!=2.0.*,!=2.1.*,!=2.2.*,!=2.4.*,<3`. +* Depends on `tensorflow-data-validation>=0.26,<0.27`. +* Depends on `tensorflow-model-analysis>=0.26,<0.27`. + +## Breaking changes + +* N/A + +## Deprecations + +* N/A + +# Version 0.25.0 + +## Major Features and Improvements + +* Add workflow buttons to Fairness Indicators UI, providing tutorial on how to + configure metrics and parameters, and how to interpret the results. +* Add metric definitions as tooltips in the metric selector UI +* Removing prefix from metric names in graph titles in UI. +* From this release Fairness Indicators will also be hosting nightly packages + on https://pypi-nightly.tensorflow.org. To install the nightly package use + the following command: + + ``` + pip install --extra-index-url https://pypi-nightly.tensorflow.org/simple fairness-indicators + ``` + + Note: These nightly packages are unstable and breakages are likely to + happen. The fix could often take a week or more depending on the complexity + involved for the wheels to be available on the PyPI cloud service. You can + always use the stable version of Fairness Indicators available on PyPI by + running the command `pip install fairness-indicators` . + +## Bug fixes and other changes + +* Update table colors. +* Modify privacy note in Fairness Indicators UI. +* Depends on `tensorflow-data-validation>=0.25,<0.26`. +* Depends on `tensorflow-model-analysis>=0.25,<0.26`. + +## Breaking changes + +* N/A + +## Deprecations + +* N/A + +# Version 0.24.0 + +## Major Features and Improvements + +* Made the Fairness Indicators UI thresholds drop down list sorted. + +## Bug fixes and other changes + +* Fix in the issue where the Sort menu is not hidden when there is no model + comparison. +* Depends on `tensorflow-data-validation>=0.24,<0.25`. +* Depends on `tensorflow-model-analysis>=0.24,<0.25`. + +## Breaking changes + +* N/A + +## Deprecations + +* Deprecated Py3.5 support. + +# Version 0.23.1 + +## Major Features and Improvements + +* N/A + +## Bug fixes and other changes + +* Fix broken import path in Fairness_Indicators_Example_Colab and Fairness_Indicators_on_TF_Hub_Text_Embeddings. + +## Breaking changes + +* N/A + +## Deprecations + +* N/A + +# Version 0.23.0 + +## Major Features and Improvements + +* N/A + +## Bug fixes and other changes + +* Depends on `tensorflow>=1.15.2,!=2.0.*,!=2.1.*,!=2.2.*,<3`. +* Depends on `tensorflow-data-validation>=0.23,<0.24`. +* Depends on `tensorflow-model-analysis>=0.23,<0.24`. + +## Breaking changes + +* N/A + +## Deprecations + +* Deprecating Py2 support. +* Note: We plan to drop py3.5 support in the next release. diff --git a/fairness_indicators/version.py b/fairness_indicators/version.py index 09995072..32dd808f 100644 --- a/fairness_indicators/version.py +++ b/fairness_indicators/version.py @@ -14,4 +14,4 @@ """Contains the version string of Fairness Indicators.""" # Note that setup.py uses this version. -__version__ = '0.41.0' +__version__ = '0.42.0.dev' diff --git a/tensorboard_plugin/tensorboard_plugin_fairness_indicators/RELEASE.md b/tensorboard_plugin/tensorboard_plugin_fairness_indicators/RELEASE.md index 1b172548..e0760f3e 100644 --- a/tensorboard_plugin/tensorboard_plugin_fairness_indicators/RELEASE.md +++ b/tensorboard_plugin/tensorboard_plugin_fairness_indicators/RELEASE.md @@ -1,3 +1,15 @@ + + +# Current Version (Still in Development) + +## Major Features and Improvements + +## Bug Fixes and Other Changes + +## Breaking Changes + +## Deprecations + # Version 0.41.0 ## Major Features and Improvements @@ -11,8 +23,333 @@ ## Breaking Changes +* N/A +## Deprecations + +* N/A + +# Version 0.40.0 + +## Major Features and Improvements + +* N/A + +## Bug Fixes and Other Changes + +* Depends on tensorflow>=2.8.0,<3. +* Depends on tensorflow-model-analysis>=0.40,<0.41. + +## Breaking Changes + +* N/A + +## Deprecations + +* N/A + +# Version 0.39.0 + +## Major Features and Improvements + +* N/A + +## Bug Fixes and Other Changes + +* Depends on `Werkzeug<2`. +* Depends on `tensorflow>=2.8.0,<3`. +* Depends on `tensorboard>=2.8.0,<3`. +* Depends on `tensorflow-model-analysis>=0.38,<0.39`. + +## Breaking Changes + +* N/A + +## Deprecations + +* N/A + +# Version 0.38.0 + +## Major Features and Improvements + +* N/A + +## Bug Fixes and Other Changes + +* Depends on `tensorflow>=2.8.0,<3`. +* Depends on `tensorboard>=2.8.0,<3`. +* Depends on `tensorflow-model-analysis>=0.38,<0.39`. + +## Breaking Changes + +* N/A + +## Deprecations + +* N/A + +# Version 0.37.0 + +## Major Features and Improvements + +* N/A + +## Bug Fixes and Other Changes + +* N/A + +## Breaking Changes + +* Depends on `tensorflow-model-analysis>=0.37,<0.38`. + +## Deprecations + +* N/A + +# Version 0.36.0 + +## Major Features and Improvements + +* N/A + +## Bug Fixes and Other Changes + +* Depends on `tensorflow>=2.7.0,<3`. +* Depends on `tensorboard>=2.7.0,<3`. +* Depends on `tensorflow-model-analysis>=0.36,<0.37`. + +## Breaking Changes + +* N/A + +## Deprecations + +* N/A + +# Version 0.35.0 + +## Major Features and Improvements + +* N/A + +## Bug Fixes and Other Changes + +* N/A + +## Breaking Changes + +* Depends on `tensorflow-model-analysis>=0.35,<0.36`. + +## Deprecations + +* Deprecating python3.6 support. + +# Version 0.34.0 + +## Major Features and Improvements + +* N/A + +## Bug Fixes and Other Changes + +* Depends on `tensorboard>=2.5.0,<3`. +* Depends on `tensorflow>=2.6.0,<3`. +* Depends on `tensorflow-model-analysis>=0.34,<0.35`. + +## Breaking Changes + * N/A ## Deprecations * N/A + +# Version 0.33.0 + +## Major Features and Improvements + +* N/A + +## Bug Fixes and Other Changes + +* Depends on `tensorboard>=2.5.0,<3`. +* Depends on `tensorflow>=2.5.0,<3`. +* Depends on `protobuf>=3.13,<4`. +* Depends on `tensorflow-model-analysis>=0.33,<0.34`. + +## Breaking Changes + +* N/A + +## Deprecations + +* N/A + +# Version 0.30.0 + +## Major Features and Improvements + +* N/A + +## Bug Fixes and Other Changes + +* Depends on `tensorboard>=2.4.0,!=2.5.*,<3`. +* Depends on `tensorflow>=2.4.0,!=2.5.*,<3`. +* Depends on `tensorflow-model-analysis>=0.30,<0.31`. + +## Breaking Changes + +* N/A + +## Deprecations + +* N/A + +# Version 0.29.0 + +## Major Features and Improvements + +* N/A + +## Bug Fixes and Other Changes + +* Depends on `tensorflow-model-analysis>=0.29,<0.30`. + +## Breaking Changes + +* N/A + +## Deprecations + +* N/A + +# Version 0.28.0 + +## Major Features and Improvements + +* N/A + +## Bug Fixes and Other Changes + +* Depends on `tensorflow-model-analysis>=0.28,<0.29`. + +## Breaking Changes + +* N/A + +## Deprecations + +* N/A + +# Version 0.27.0 + +## Major Features and Improvements + +* N/A + +## Bug fixes and other changes + +* Depends on `tensorboard>=2.4.0,<3`. +* Depends on `tensorflow>=2.4.0,<3`. +* Depends on `tensorflow-model-analysis>=0.27,<0.28`. + +## Breaking changes + +* N/A + +## Deprecations + +* N/A + +# Version 0.26.0 + +## Major Features and Improvements + +* N/A + +## Bug fixes and other changes + +* Depends on `tensorboard>=2.3.0,!=2.4.*,<3`. +* Depends on `tensorflow>=2.3.0,!=2.4.*,<3`. +* Depends on `tensorflow-model-analysis>=0.26,<0.27`. + +## Breaking changes + +* N/A + +## Deprecations + +* N/A + +# Version 0.25.0 + +## Major Features and Improvements + +* From this release Tensorboard Plugin will also be hosting nightly packages + on https://pypi-nightly.tensorflow.org. To install the nightly package use + the following command: + + ``` + pip install --extra-index-url https://pypi-nightly.tensorflow.org/simple tensorboard-plugin-fairness-indicators + ``` + + Note: These nightly packages are unstable and breakages are likely to + happen. The fix could often take a week or more depending on the complexity + involved for the wheels to be available on the PyPI cloud service. You can + always use the stable version of Tensorboard Plugin available on PyPI by + running the command `pip install tensorboard-plugin-fairness-indicators` . + +## Bug fixes and other changes + +* Adding support for model comparison using dynamic URL in TensorBoard plugin. +* Depends on `tensorflow-model-analysis>=0.25,<0.26`. + +## Breaking changes + +* N/A + +## Deprecations + +* N/A + +# Version 0.24.0 + +## Major Features and Improvements + +* N/A + +## Bug fixes and other changes + +* Fix in the error message while rendering evaluation results in + TensorBoard plugin from evaluation output path provided in the URL. +* Depends on `tensorflow-model-analysis>=0.24,<0.25`. + +## Breaking changes + +* N/A + +## Deprecations + +* Deprecating Py3.5 support. + +# Version 0.23.0 + +## Major Features and Improvements + +* N/A + +## Bug fixes and other changes + +* Depends on `tensorboard>=2.3.0,<3`. +* Depends on `tensorflow>=2.3.0,<3`. +* Depends on `tensorflow-model-analysis>=0.23,<0.24`. +* Adding model comparison support in TensorBoard Plugin. + +## Breaking changes + +* N/A + +## Deprecations + +* Deprecating Py2 support. +* Note: We plan to drop py3.5 support in the next release. diff --git a/tensorboard_plugin/tensorboard_plugin_fairness_indicators/version.py b/tensorboard_plugin/tensorboard_plugin_fairness_indicators/version.py index 5c5dc03e..729c0d7e 100644 --- a/tensorboard_plugin/tensorboard_plugin_fairness_indicators/version.py +++ b/tensorboard_plugin/tensorboard_plugin_fairness_indicators/version.py @@ -15,4 +15,4 @@ """Contains the version string of Fairness Indicators Tensorboard Plugin.""" # Note that setup.py uses this version. -__version__ = '0.41.0' +__version__ = '0.42.0.dev'