Skip to content

Commit

Permalink
Merge pull request #293 from BCG-Gamma/dev/1.2.0
Browse files Browse the repository at this point in the history
BUILD: Release facet 1.2.0
  • Loading branch information
j-ittner authored Sep 8, 2021
2 parents 472daf9 + 33eabfe commit ff0c006
Show file tree
Hide file tree
Showing 17 changed files with 553 additions and 1,354 deletions.
7 changes: 4 additions & 3 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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**

Expand All @@ -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
Expand Down
10 changes: 9 additions & 1 deletion RELEASE_NOTES.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,14 +4,16 @@ Release Notes
FACET 1.2
---------

FACET 1.2 introduces the ability to run simulations on a subsample of the data used to
FACET 1.2 adds support for *sklearndf* 1.2 and *scikit-learn* 0.24.
It also introduces the ability to run simulations on a subsample of the data used to
fit the underlying crossfit.
One example where this can be useful is to use only a recent period of a time series as
the baseline of a simulation.

1.2.0
~~~~~

- BUILD: added support for *sklearndf* 1.2 and *scikit-learn* 0.24
- API: new optional parameter `subsample` in method
:meth:`.BaseUnivariateSimulator.simulate_feature` can be used to specify a subsample
to be used in the simulation (but simulating using a crossfit based on the full
Expand All @@ -24,6 +26,12 @@ 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


1.1.0
~~~~~

Expand Down
Loading

0 comments on commit ff0c006

Please sign in to comment.