|
| 1 | +<!-- mdlint off(HEADERS_TOO_MANY_H1) --> |
| 2 | + |
| 3 | +# Current Version (Still in Development) |
| 4 | + |
| 5 | +## Major Features and Improvements |
| 6 | + |
| 7 | +## Bug Fixes and Other Changes |
| 8 | + |
| 9 | +## Breaking Changes |
| 10 | + |
| 11 | +## Deprecations |
| 12 | + |
1 | 13 | # Version 0.41.0
|
2 | 14 |
|
3 | 15 | ## Major Features and Improvements
|
|
18 | 30 |
|
19 | 31 | * N/A
|
20 | 32 |
|
| 33 | +# Version 0.40.0 |
| 34 | + |
| 35 | +## Major Features and Improvements |
| 36 | + |
| 37 | +* Allow counterfactual metrics to be calculated from predictions instead of |
| 38 | + only features. |
| 39 | +* Add precision and recall to the set of fairness indicators metrics. |
| 40 | + |
| 41 | +## Bug Fixes and Other Changes |
| 42 | + |
| 43 | +* Depends on `tensorflow-data-validation>=1.9.0,<1.10.0`. |
| 44 | +* Depends on `tensorflow-model-analysis>=0.40,<0.41`. |
| 45 | +* 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`. |
| 46 | + |
| 47 | +## Breaking Changes |
| 48 | + |
| 49 | +* N/A |
| 50 | + |
| 51 | +## Deprecations |
| 52 | + |
| 53 | +* N/A |
| 54 | + |
| 55 | +# Version 0.39.0 |
| 56 | + |
| 57 | +## Major Features and Improvements |
| 58 | + |
| 59 | +* Allow counterfactual metrics to be calculated from predictions instead of |
| 60 | + only features. |
| 61 | +* Add precision and recall to the set of fairness indicators metrics. |
| 62 | + |
| 63 | +## Bug Fixes and Other Changes |
| 64 | + |
| 65 | +* Depends on `tensorflow-data-validation>=1.8.0,<1.9.0`. |
| 66 | +* Depends on `tensorflow-model-analysis>=0.39,<0.40`. |
| 67 | +* Depends on `tensorflow>=1.15.5,!=2.0.*,!=2.1.*,!=2.2.*,!=2.3.*,!=2.4.*,!=2.5.*,!=2.6.*,!=2.7.*,<3`. |
| 68 | + |
| 69 | +## Breaking Changes |
| 70 | + |
| 71 | +* N/A |
| 72 | + |
| 73 | +## Deprecations |
| 74 | + |
| 75 | +* N/A |
| 76 | + |
| 77 | +# Version 0.38.0 |
| 78 | + |
| 79 | +## Major Features and Improvements |
| 80 | + |
| 81 | +* N/A |
| 82 | + |
| 83 | +## Bug Fixes and Other Changes |
| 84 | + |
| 85 | +* Depends on `tensorflow-data-validation>=1.7.0,<1.8.0`. |
| 86 | +* Depends on `tensorflow-model-analysis>=0.38,<0.39`. |
| 87 | +* Depends on `tensorflow>=1.15.5,!=2.0.*,!=2.1.*,!=2.2.*,!=2.3.*,!=2.4.*,!=2.5.*,!=2.6.*,!=2.7.*,<3`. |
| 88 | + |
| 89 | +## Breaking Changes |
| 90 | + |
| 91 | +* N/A |
| 92 | + |
| 93 | +## Deprecations |
| 94 | + |
| 95 | +* N/A |
| 96 | + |
| 97 | +# Version 0.37.0 |
| 98 | + |
| 99 | +## Major Features and Improvements |
| 100 | + |
| 101 | +* N/A |
| 102 | + |
| 103 | +## Bug Fixes and Other Changes |
| 104 | + |
| 105 | +* Fix Fairness Indicators UI bug with overlapping charts when comparing EvalResults |
| 106 | +* Depends on `tensorflow-data-validation>=1.6.0,<1.7.0`. |
| 107 | +* Depends on `tensorflow-model-analysis>=0.37,<0.38`. |
| 108 | +* Depends on `tensorflow>=1.15.5,!=2.0.*,!=2.1.*,!=2.2.*,!=2.3.*,!=2.4.*,!=2.5.*,!=2.6.*,<3`. |
| 109 | + |
| 110 | +## Breaking Changes |
| 111 | + |
| 112 | +* N/A |
| 113 | + |
| 114 | +## Deprecations |
| 115 | + |
| 116 | +* N/A |
| 117 | + |
| 118 | +# Version 0.36.0 |
| 119 | + |
| 120 | +## Major Features and Improvements |
| 121 | + |
| 122 | +* N/A |
| 123 | + |
| 124 | +## Bug Fixes and Other Changes |
| 125 | + |
| 126 | +* Depends on `tensorflow-data-validation>=1.5.0,<1.6.0`. |
| 127 | +* Depends on `tensorflow-model-analysis>=0.36,<0.37`. |
| 128 | +* Depends on `tensorflow>=1.15.2,!=2.0.*,!=2.1.*,!=2.2.*,!=2.3.*,!=2.4.*,!=2.5.*,!=2.6.*,<3`. |
| 129 | + |
| 130 | +## Breaking Changes |
| 131 | + |
| 132 | +* N/A |
| 133 | + |
| 134 | +## Deprecations |
| 135 | + |
| 136 | +* N/A |
| 137 | + |
| 138 | +# Version 0.35.0 |
| 139 | + |
| 140 | +## Major Features and Improvements |
| 141 | + |
| 142 | +* N/A |
| 143 | + |
| 144 | +## Bug Fixes and Other Changes |
| 145 | + |
| 146 | +* Depends on `tensorflow-data-validation>=1.4.0,<1.5.0`. |
| 147 | +* Depends on `tensorflow-model-analysis>=0.35,<0.36`. |
| 148 | + |
| 149 | +## Breaking Changes |
| 150 | + |
| 151 | +* N/A |
| 152 | + |
| 153 | +## Deprecations |
| 154 | + |
| 155 | +* Deprecating python 3.6 support. |
| 156 | + |
| 157 | +# Version 0.34.0 |
| 158 | + |
| 159 | +## Major Features and Improvements |
| 160 | + |
| 161 | +* N/A |
| 162 | + |
| 163 | +## Bug Fixes and Other Changes |
| 164 | + |
| 165 | +* Depends on `tensorflow>=1.15.2,!=2.0.*,!=2.1.*,!=2.2.*,!=2.3.*,!=2.4.*,!=2.5.*,<3`. |
| 166 | +* Depends on `tensorflow-data-validation>=1.3.0,<1.4.0`. |
| 167 | +* Depends on `tensorflow-model-analysis>=0.34,<0.35`. |
| 168 | + |
| 169 | +## Breaking Changes |
| 170 | + |
| 171 | +* Drop Py2 support. |
| 172 | + |
| 173 | +## Deprecations |
| 174 | + |
| 175 | +* N/A |
| 176 | + |
| 177 | +# Version 0.33.0 |
| 178 | + |
| 179 | +## Major Features and Improvements |
| 180 | + |
| 181 | +* Porting Counterfactual Fairness metrics into FI UI. |
| 182 | + |
| 183 | +## Bug Fixes and Other Changes |
| 184 | + |
| 185 | +* Improve rendering of HTML stubs for Fairness Indicators UI |
| 186 | +* Depends on `tensorflow>=1.15.2,!=2.0.*,!=2.1.*,!=2.2.*,!=2.3.*,!=2.4.*,<3`. |
| 187 | +* Depends on `protobuf>=3.13,<4`. |
| 188 | +* Depends on `tensorflow-data-validation>=1.2.0,<1.3.0`. |
| 189 | +* Depends on `tensorflow-model-analysis>=0.33,<0.34`. |
| 190 | + |
| 191 | +## Breaking Changes |
| 192 | + |
| 193 | +* N/A |
| 194 | + |
| 195 | +## Deprecations |
| 196 | + |
| 197 | +* N/A |
| 198 | + |
| 199 | +# Version 0.30.0 |
| 200 | + |
| 201 | +## Major Features and Improvements |
| 202 | + |
| 203 | +* N/A |
| 204 | + |
| 205 | +## Bug Fixes and Other Changes |
| 206 | + |
| 207 | +* Depends on `tensorflow>=1.15.2,!=2.0.*,!=2.1.*,!=2.2.*,!=2.3.*,!=2.5.*,<3`. |
| 208 | +* Depends on `tensorflow-data-validation>=0.30,<0.31`. |
| 209 | +* Depends on `tensorflow-model-analysis>=0.30,<0.31`. |
| 210 | + |
| 211 | +## Breaking Changes |
| 212 | + |
| 213 | +* N/A |
| 214 | + |
| 215 | +## Deprecations |
| 216 | + |
| 217 | +* N/A |
| 218 | + |
| 219 | +# Version 0.29.0 |
| 220 | + |
| 221 | +## Major Features and Improvements |
| 222 | + |
| 223 | +* N/A |
| 224 | + |
| 225 | +## Bug Fixes and Other Changes |
| 226 | + |
| 227 | +* Depends on `tensorflow-data-validation>=0.29,<0.30`. |
| 228 | +* Depends on `tensorflow-model-analysis>=0.29,<0.30`. |
| 229 | + |
| 230 | +## Breaking Changes |
| 231 | + |
| 232 | +* N/A |
| 233 | + |
| 234 | +## Deprecations |
| 235 | + |
| 236 | +* N/A |
| 237 | + |
| 238 | +# Version 0.28.0 |
| 239 | + |
| 240 | +## Major Features and Improvements |
| 241 | + |
| 242 | +* In Fairness Indicators UI, sort metrics list to show common metrics first |
| 243 | +* For lift, support negative values in bar chart. |
| 244 | +* Adding two new metrics - Flip Count and Flip Rate to evaluate Counterfactual |
| 245 | + Fairness. |
| 246 | +* Add Lift metrics under addons/fairness. |
| 247 | +* Porting Lift metrics into FI UI. |
| 248 | + |
| 249 | +## Bug Fixes and Other Changes |
| 250 | + |
| 251 | +* Depends on `tensorflow-data-validation>=0.28,<0.29`. |
| 252 | +* Depends on `tensorflow-model-analysis>=0.28,<0.29`. |
| 253 | + |
| 254 | +## Breaking Changes |
| 255 | + |
| 256 | +* N/A |
| 257 | + |
| 258 | +## Deprecations |
| 259 | + |
| 260 | +* N/A |
| 261 | + |
| 262 | +# Version 0.27.0 |
| 263 | + |
| 264 | +## Major Features and Improvements |
| 265 | + |
| 266 | +* N/A |
| 267 | + |
| 268 | +## Bug fixes and other changes |
| 269 | + |
| 270 | +* Added test cases for DLVM testing. |
| 271 | +* Move the util files to a seperate folder. |
| 272 | +* Add `tensorflow-hub` as a dependency because it's used inside the |
| 273 | + example_model.py. |
| 274 | +* Depends on `tensorflow>=1.15.2,!=2.0.*,!=2.1.*,!=2.2.*,!=2.3.*,<3`. |
| 275 | +* Depends on `tensorflow-data-validation>=0.27,<0.28`. |
| 276 | +* Depends on `tensorflow-model-analysis>=0.27,<0.28`. |
| 277 | + |
| 278 | +## Breaking changes |
| 279 | + |
| 280 | +* N/A |
| 281 | + |
| 282 | +## Deprecations |
| 283 | + |
| 284 | +* N/A |
| 285 | + |
| 286 | +# Version 0.26.0 |
| 287 | + |
| 288 | +## Major Features and Improvements |
| 289 | + |
| 290 | +* Sorting fairness metrics table rows to keep slices in order with slice drop |
| 291 | + down in the UI. |
| 292 | + |
| 293 | +## Bug fixes and other changes |
| 294 | + |
| 295 | +* Update fairness_indicators.documentation.examples.util to TensorFlow 2.0. |
| 296 | +* Table now displays 3 decimal places instead of 2. |
| 297 | +* Fix the bug that metric list won't refresh if the input eval result changed. |
| 298 | +* Remove d3-tip dependency. |
| 299 | +* Depends on `tensorflow>=1.15.2,!=2.0.*,!=2.1.*,!=2.2.*,!=2.4.*,<3`. |
| 300 | +* Depends on `tensorflow-data-validation>=0.26,<0.27`. |
| 301 | +* Depends on `tensorflow-model-analysis>=0.26,<0.27`. |
| 302 | + |
| 303 | +## Breaking changes |
| 304 | + |
| 305 | +* N/A |
| 306 | + |
| 307 | +## Deprecations |
| 308 | + |
| 309 | +* N/A |
| 310 | + |
| 311 | +# Version 0.25.0 |
| 312 | + |
| 313 | +## Major Features and Improvements |
| 314 | + |
| 315 | +* Add workflow buttons to Fairness Indicators UI, providing tutorial on how to |
| 316 | + configure metrics and parameters, and how to interpret the results. |
| 317 | +* Add metric definitions as tooltips in the metric selector UI |
| 318 | +* Removing prefix from metric names in graph titles in UI. |
| 319 | +* From this release Fairness Indicators will also be hosting nightly packages |
| 320 | + on https://pypi-nightly.tensorflow.org. To install the nightly package use |
| 321 | + the following command: |
| 322 | + |
| 323 | + ``` |
| 324 | + pip install --extra-index-url https://pypi-nightly.tensorflow.org/simple fairness-indicators |
| 325 | + ``` |
| 326 | +
|
| 327 | + Note: These nightly packages are unstable and breakages are likely to |
| 328 | + happen. The fix could often take a week or more depending on the complexity |
| 329 | + involved for the wheels to be available on the PyPI cloud service. You can |
| 330 | + always use the stable version of Fairness Indicators available on PyPI by |
| 331 | + running the command `pip install fairness-indicators` . |
| 332 | +
|
| 333 | +## Bug fixes and other changes |
| 334 | +
|
| 335 | +* Update table colors. |
| 336 | +* Modify privacy note in Fairness Indicators UI. |
| 337 | +* Depends on `tensorflow-data-validation>=0.25,<0.26`. |
| 338 | +* Depends on `tensorflow-model-analysis>=0.25,<0.26`. |
| 339 | +
|
| 340 | +## Breaking changes |
| 341 | +
|
| 342 | +* N/A |
| 343 | +
|
| 344 | +## Deprecations |
| 345 | +
|
| 346 | +* N/A |
| 347 | +
|
| 348 | +# Version 0.24.0 |
| 349 | +
|
| 350 | +## Major Features and Improvements |
| 351 | +
|
| 352 | +* Made the Fairness Indicators UI thresholds drop down list sorted. |
| 353 | +
|
| 354 | +## Bug fixes and other changes |
| 355 | +
|
| 356 | +* Fix in the issue where the Sort menu is not hidden when there is no model |
| 357 | + comparison. |
| 358 | +* Depends on `tensorflow-data-validation>=0.24,<0.25`. |
| 359 | +* Depends on `tensorflow-model-analysis>=0.24,<0.25`. |
| 360 | +
|
| 361 | +## Breaking changes |
| 362 | +
|
| 363 | +* N/A |
| 364 | +
|
| 365 | +## Deprecations |
| 366 | +
|
| 367 | +* Deprecated Py3.5 support. |
| 368 | +
|
| 369 | +# Version 0.23.1 |
| 370 | +
|
| 371 | +## Major Features and Improvements |
| 372 | +
|
| 373 | +* N/A |
| 374 | +
|
| 375 | +## Bug fixes and other changes |
| 376 | +
|
| 377 | +* Fix broken import path in Fairness_Indicators_Example_Colab and Fairness_Indicators_on_TF_Hub_Text_Embeddings. |
| 378 | +
|
| 379 | +## Breaking changes |
| 380 | +
|
| 381 | +* N/A |
| 382 | +
|
| 383 | +## Deprecations |
| 384 | +
|
| 385 | +* N/A |
| 386 | +
|
| 387 | +# Version 0.23.0 |
| 388 | +
|
| 389 | +## Major Features and Improvements |
| 390 | +
|
| 391 | +* N/A |
| 392 | +
|
| 393 | +## Bug fixes and other changes |
| 394 | +
|
| 395 | +* Depends on `tensorflow>=1.15.2,!=2.0.*,!=2.1.*,!=2.2.*,<3`. |
| 396 | +* Depends on `tensorflow-data-validation>=0.23,<0.24`. |
| 397 | +* Depends on `tensorflow-model-analysis>=0.23,<0.24`. |
| 398 | +
|
| 399 | +## Breaking changes |
| 400 | +
|
| 401 | +* N/A |
| 402 | +
|
| 403 | +## Deprecations |
| 404 | +
|
| 405 | +* Deprecating Py2 support. |
| 406 | +* Note: We plan to drop py3.5 support in the next release. |
0 commit comments