Merge pull request #304 from BCG-Gamma/dev/1.1.1

BUILD: release FACET 1.1.1

README.rst

@@ -168,8 +168,10 @@ Model Inspection
 FACET implements several model inspection methods for
 `scikit-learn <https://scikit-learn.org/stable/index.html>`__ estimators.
 FACET enhances model inspection by providing global metrics that complement
-the local perspective of SHAP. The key global metrics for each pair of
-features in a model are:
+the local perspective of SHAP (see
+`[arXiv:2107.12436] <https://arxiv.org/abs/2107.12436>`__ for a formal description).
+
+The key global metrics for each pair of features in a model are:
 
 - **Synergy**
 
@@ -192,7 +194,6 @@ features in a model are:
   features contribute to the model predictions.* Synergy is expressed as a
   percentage ranging from 0% (full autonomy) to 100% (full synergy).
 
-
 - **Redundancy**
 
   The degree to which a feature in a model duplicates the information of a

RELEASE_NOTES.rst

@@ -7,6 +7,13 @@ FACET 1.1
 FACET 1.1 refines and enhances the association/synergy/redundancy calculations provided
 by the :class:`.LearnerInspector`.
 
+1.1.1
+~~~~~
+
+- DOC: add reference to FACET research paper on the project landing page
+- FIX: correctly count positive class frequency in UnivariateProbabilitySimulator
+
+
 1.1.0
 ~~~~~
 
@@ -29,6 +36,11 @@ by the :class:`.LearnerInspector`.
 FACET 1.0
 ---------
 
+1.0.3
+~~~~~
+
+- FIX: restrict package requirements to *gamma-pytools* 1.0.* and *sklearndf* 1.0.x, since FACET 1.0 is not compatible with *gamma-pytools* 1.1.* 
+
 1.0.2
 ~~~~~