BUILD: Release facet 1.1.0rc0

README.rst

@@ -340,7 +340,7 @@ quantify the uncertainty by using bootstrap confidence intervals.
     from facet.validation import BootstrapCV
     from facet.crossfit import LearnerCrossfit
     from facet.simulation import UnivariateUpliftSimulator
-    from facet.simulation.partition import ContinuousRangePartitioner
+    from facet.data.partition import ContinuousRangePartitioner
     from facet.simulation.viz import SimulationDrawer
 
     # create bootstrap CV iterator

RELEASE_NOTES.rst

@@ -1,6 +1,28 @@
 Release Notes
 =============
 
+FACET 1.1
+---------
+
+FACET 1.1 refines and enhances the association/synergy/redundancy calculations provided
+by the :class:`.LearnerInspector`.
+
+1.1.0
+~~~~~
+
+- API: SHAP interaction vectors can (in part) also be influenced by redundancy among
+  features. FACET now corrects interaction vectors for redundancy prior to calculating
+  synergy. Technically we ensure that the interaction vector is orthogonal w.r.t the
+  main effect vectors of both associated features.
+- API: FACET now calculates synergy, redundancy, and association separately for each
+  model in a crossfit, then returns the mean of all resulting matrices. This leads to a
+  slight increase in accuracy, and also allows us to calculate the standard deviation
+  across matrices as an indication of confidence for each calculated value.
+- API: Increase efficiency of :class:`.LearnerRanker` parallelization by adopting the
+  new :class:`pytools.parallelization.JobRunner` API provided by :mod:`pytools`
+- BUILD: add support for :mod:`shap` 0.38 and 0.39
+
+
 FACET 1.0
 ---------
 
@@ -13,7 +35,7 @@ fixes.
 - API: add support for :mod:`shap` 0.36 and 0.37 via a new :class:`.BaseExplainer`
   stub class
 - FIX: apply color scheme to the histogram section in :class:`.SimulationMatplotStyle`
-- BUILD: add support for numpy 1.20
+- BUILD: add support for :mod:`numpy` 1.20
 - BUILD: updates and changes to the CI/CD pipeline
 
 

azure-pipelines.yml

@@ -1,10 +1,10 @@
 trigger:
-  - develop
+  - 1.1.x
   - dev/*
   - release/*
 
 pr:
-  - develop
+  - 1.1.x
   - dev/*
   - release/*
 
@@ -17,20 +17,20 @@ schedules:
   displayName: Nightly full build
   branches:
     include:
-    - develop
+    - 1.1.x
 
 resources:
   repositories:
     - repository: sklearndf
       type: github
       endpoint: BCG-Gamma
       name: BCG-Gamma/sklearndf
-      ref: develop # todo - update to stable release
+      ref: 1.1.x # todo - update to stable release
     - repository: pytools
       type: github
       endpoint: BCG-Gamma
       name: BCG-Gamma/pytools
-      ref: develop # todo - update to stable release
+      ref: 1.1.x # todo - update to stable release
 
 variables:
   ${{ if not(startsWith(variables['Build.SourceBranch'], 'refs/pull/')) }}:
@@ -656,6 +656,8 @@ stages:
               cp -r $(Build.ArtifactStagingDirectory)/old_docs/docs .
               echo "Current docs contents:"
               tree docs
+              mkdir -p $(System.DefaultWorkingDirectory)/facet/sphinx/build/
+              cp -R docs/docs-version $(System.DefaultWorkingDirectory)/facet/sphinx/build/
               echo "Building sphinx docs"
               conda activate facet-develop
               cd $(System.DefaultWorkingDirectory)/facet

condabuild/meta.yaml

@@ -41,7 +41,8 @@ test:
     - python -c 'import facet;
                  import os;
                  assert facet.__version__ == os.environ["PKG_VERSION"]'
-    - pytest -vs ${FACET_PATH}/facet/test
+    - cd "${FACET_PATH}/facet"
+    - pytest -vs test
 
 about:
   home: https://github.com/BCG-Gamma/facet

environment.yml

@@ -40,4 +40,4 @@ dependencies:
   - xlrd >= 1.2
   - yaml > 0.2
   - pip:
-      - shap >=0.35,<0.39
+      - shap >=0.34,<0.40

pyproject.toml

@@ -15,20 +15,20 @@ license = "Apache Software License v2.0"
 
 requires = [
     # direct requirements of gamma-facet
-    "gamma-pytools  >=1.0.2,<2",
+    "gamma-pytools  >=1.1,<2",
     "matplotlib     >=3.0,<3.4",
     "numpy          >=1.16,<1.21",
     "packaging      >=20",
     "pandas         >=0.24,<1.3",
     "scipy          >=1.2,<1.6",
-    "shap           >=0.34,<0.39",
-    "sklearndf      >=1.0.2,<2",
+    "shap           >=0.34,<0.40",
+    "sklearndf      >=1.1,<2",
     # additional requirements of sklearndf
     "boruta         >=0.3",
     "lightgbm       >=3.0",
     "scikit-learn   >=0.21,<0.24",
     # additional requirements of gamma-pytools
-    "joblib         >=0.13,<1.1",
+    "joblib         >=0.14,<1.1",
     "typing_inspect >=0.4,<0.7",
     # additional requirements of shap 0.38
     # todo: remove once supported via shap 0.38 requirements
@@ -78,33 +78,33 @@ Repository = "https://github.com/BCG-Gamma/facet"
 
 [build.matrix.min]
 # direct requirements of gamma-facet
-gamma-pytools  = "=1.0.2"
+gamma-pytools  = "=1.1.0"
 matplotlib     = "=3.0.*"
 numpy          = "=1.16.*"
 packaging      = "=20.*"
 pandas         = "=0.24.*"
 python         = "=3.6.*"
 scipy          = "=1.2.*"
 shap           = "=0.34.*"
-sklearndf      = "=1.0.2"
+sklearndf      = "=1.1.0"
 # additional requirements of sklearndf
 boruta         = "=0.3.*"
 lightgbm       = "=3.0.*"
 scikit-learn   = "=0.21.*"
 # additional requirements of gamma-pytools
-joblib         = "=0.13.*"
+joblib         = "=0.14.*"
 typing_inspect = "=0.4"
 
 [build.matrix.max]
-gamma-pytools  = "<2"
-matplotlib     = "=3.3.*"
+gamma-pytools  = ">=1.1,<2"
+matplotlib     = "<3.4"
 numpy          = "<1.21"
 packaging      = ">=20"
 pandas         = "<1.3"
 python         = "=3.8.*"
 scipy          = "<1.6"
-shap           = ">=0.37,<0.39"
-sklearndf      = ">=1.0.2,<2"
+shap           = ">=0.37,<0.40"
+sklearndf      = ">=1.1,<2"
 # additional requirements of sklearndf
 boruta         = ">=0.3"
 lightgbm       = ">=3.0"

sphinx/auxiliary/Diabetes_getting_started_example.ipynb

@@ -482,7 +482,7 @@
     "from facet.validation import BootstrapCV\n",
     "from facet.crossfit import LearnerCrossfit\n",
     "from facet.simulation import UnivariateUpliftSimulator\n",
-    "from facet.simulation.partition import ContinuousRangePartitioner\n",
+    "from facet.data.partition import ContinuousRangePartitioner\n",
     "from facet.simulation.viz import SimulationDrawer\n",
     "\n",
     "# create bootstrap CV iterator\n",

sphinx/source/faqs.rst

@@ -157,5 +157,5 @@ Bibtex entry::
      title={FACET},
      author={FACET Team at BCG GAMMA},
      year={2021},
-     note={Python package version 1.0.2}
+     note={Python package version 1.1.0}
      }

sphinx/source/tutorial/Classification_with_Facet.ipynb

@@ -162,7 +162,7 @@
     "from facet.inspection import LearnerInspector\n",
     "from facet.selection import LearnerRanker, LearnerGrid\n",
     "from facet.validation import BootstrapCV\n",
-    "from facet.simulation.partition import ContinuousRangePartitioner\n",
+    "from facet.data.partition import ContinuousRangePartitioner\n",
     "from facet.simulation import UnivariateProbabilitySimulator\n",
     "from facet.simulation.viz import SimulationDrawer\n",
     "from facet.crossfit import LearnerCrossfit"
@@ -3098,4 +3098,4 @@
  },
  "nbformat": 4,
  "nbformat_minor": 4
-}
+}

sphinx/source/tutorial/Model_simulation_deep_dive.ipynb

@@ -158,7 +158,7 @@
    "source": [
     "from facet.data import Sample\n",
     "from facet.validation import BootstrapCV\n",
-    "from facet.simulation.partition import (\n",
+    "from facet.data.partition import (\n",
     "    ContinuousRangePartitioner,\n",
     "    IntegerRangePartitioner,\n",
     "    CategoryPartitioner,\n",
@@ -1472,4 +1472,4 @@
  },
  "nbformat": 4,
  "nbformat_minor": 4
-}
+}

sphinx/source/tutorial/Predictive_Maintenance_Regression_with_Facet.ipynb

@@ -180,7 +180,7 @@
     "from facet.inspection import LearnerInspector\n",
     "from facet.selection import LearnerRanker, LearnerGrid\n",
     "from facet.validation import BootstrapCV\n",
-    "from facet.simulation.partition import ContinuousRangePartitioner\n",
+    "from facet.data.partition import ContinuousRangePartitioner\n",
     "from facet.simulation import UnivariateUpliftSimulator\n",
     "from facet.simulation.viz import SimulationDrawer"
    ]
@@ -2129,4 +2129,4 @@
  },
  "nbformat": 4,
  "nbformat_minor": 4
-}
+}

sphinx/source/tutorial/Water_Drilling_Incident_Classification_with_Facet.ipynb

@@ -184,7 +184,7 @@
     "from facet.inspection import LearnerInspector\n",
     "from facet.selection import LearnerRanker, LearnerGrid\n",
     "from facet.validation import BootstrapCV\n",
-    "from facet.simulation.partition import ContinuousRangePartitioner\n",
+    "from facet.data.partition import ContinuousRangePartitioner\n",
     "from facet.simulation import UnivariateProbabilitySimulator\n",
     "from facet.simulation.viz import SimulationDrawer\n",
     "from facet.crossfit import LearnerCrossfit"
@@ -1527,4 +1527,4 @@
  },
  "nbformat": 4,
  "nbformat_minor": 2
-}
+}

src/facet/__init__.py

@@ -6,7 +6,7 @@
 """
 
 
-__version__ = "1.0.2"
+__version__ = "1.1.0rc0"
 
 __logo__ = (
     r"""