Merge branch 'master' into gaugup/AddPython3.10

Author: gaugup

.github/workflows/python-linting.yml

@@ -0,0 +1,41 @@
+# This workflow will lint python code with flake8 and flake8-nb.
+# For more information see: https://help.github.com/actions/language-and-framework-guides/using-python-with-github-actions
+
+name: Python linting
+
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    branches: [ master ]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Python 3.7
+      uses: actions/setup-python@v2
+      with:
+        python-version: 3.7
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install -r requirements-linting.txt
+    - name: Check sorted python imports using isort
+      run: |
+        isort . -c
+    - name: Lint code with flake8
+      run: |
+        # stop the build if there are Python syntax errors or undefined names
+        flake8 . --count --select=E9,F63,F7,F82 --show-source --statistics
+        # The GitHub editor is 127 chars wide.
+        flake8 . --count --max-complexity=30 --max-line-length=127 --statistics
+        # Check for cyclometric complexity for specific files where this metric has been 
+        # reduced to ten and below
+        flake8 dice_ml/data_interfaces/ --count --max-complexity=10 --max-line-length=127
+    - name: Lint notebooks with flake8_nb
+      run: |
+        # stop the build if there are flake8 errors in notebooks
+        flake8_nb docs/source/notebooks/ --statistics --max-line-length=127

.github/workflows/python-package-conda.yml

@@ -0,0 +1,31 @@
+name: Python Package using Conda
+
+on: [push]
+
+jobs:
+  build-linux:
+    runs-on: ubuntu-latest
+    strategy:
+      max-parallel: 5
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Python 3.8
+      uses: actions/setup-python@v2
+      with:
+        python-version: 3.8
+    - name: Add conda to system path
+      run: |
+        # $CONDA is an environment variable pointing to the root of the miniconda directory
+        echo $CONDA/bin >> $GITHUB_PATH
+    - name: Install core dependencies
+      run: |
+        conda env update --file environment.yml --name base
+    - name: Install deep learning dependencies
+      run: |
+        conda env update --file environment-deeplearning.yml --name base
+    - name: Test with pytest
+      run: |
+        conda install pytest ipython jupyter nbformat pytest-mock
+
+        pytest

.github/workflows/pythonpackage.yml

@@ -1,7 +1,7 @@
 # This workflow will install Python dependencies, run tests and lint with a variety of Python versions
 # For more information see: https://help.github.com/actions/language-and-framework-guides/using-python-with-github-actions
 
-name: Python package
+name: Python package test
 
 on:
   push:
@@ -24,25 +24,18 @@ jobs:
       uses: actions/setup-python@v1
       with:
         python-version: ${{ matrix.python-version }}
-    - name: Install dependencies
+    - name: Upgrade pip
       run: |
         python -m pip install --upgrade pip
-        pip install -r requirements-test.txt
+    - name: Install core dependencies
+      run: |
         pip install -r requirements.txt
-        pip install -r requirements-deeplearning.txt
-    - name: Lint code with flake8
+    - name: Install deep learning dependencies
       run: |
-        # stop the build if there are Python syntax errors or undefined names
-        flake8 . --count --select=E9,F63,F7,F82 --show-source --statistics
-        # The GitHub editor is 127 chars wide.
-        flake8 . --count --max-complexity=30 --max-line-length=127 --statistics
-        # Check for cyclometric complexity for specific files where this metric has been 
-        # reduced to ten and below
-        flake8 dice_ml/data_interfaces/ --count --max-complexity=10 --max-line-length=127
-    - name: Lint notebooks with flake8_nb
+        pip install -r requirements-deeplearning.txt
+    - name: Install test dependencies
       run: |
-        # stop the build if there are flake8 errors in notebooks
-        flake8_nb docs/source/notebooks/ --statistics --max-line-length=127
+        pip install -r requirements-test.txt
     - name: Test with pytest
       run: |
         # pytest

CODEOWNERS

@@ -0,0 +1,2 @@
+# dice-ml package
+/dice_ml @gaugup @amit-sharma

dice_ml/__init__.py

@@ -1,6 +1,6 @@
 from .data import Data
-from .model import Model
 from .dice import Dice
+from .model import Model
 
 __all__ = ["Data",
            "Model",

dice_ml/counterfactual_explanations.py

@@ -1,11 +1,12 @@
 import json
-import jsonschema
 import os
 
-from dice_ml.diverse_counterfactuals import CounterfactualExamples
-from dice_ml.utils.exception import UserConfigValidationException
-from dice_ml.diverse_counterfactuals import _DiverseCFV2SchemaConstants
+import jsonschema
+
 from dice_ml.constants import _SchemaVersions
+from dice_ml.diverse_counterfactuals import (CounterfactualExamples,
+                                             _DiverseCFV2SchemaConstants)
+from dice_ml.utils.exception import UserConfigValidationException
 
 
 class _CommonSchemaConstants:

dice_ml/data_interfaces/private_data_interface.py

@@ -1,10 +1,11 @@
 """Module containing meta data information about private data."""
 
-import sys
-import pandas as pd
-import numpy as np
 import collections
 import logging
+import sys
+
+import numpy as np
+import pandas as pd
 
 from dice_ml.data_interfaces.base_data_interface import _BaseData
 

dice_ml/data_interfaces/public_data_interface.py

@@ -1,13 +1,15 @@
 """Module containing all required information about the interface between raw (or transformed)
 public data and DiCE explainers."""
 
-import pandas as pd
-import numpy as np
 import logging
 from collections import defaultdict
 
+import numpy as np
+import pandas as pd
+
 from dice_ml.data_interfaces.base_data_interface import _BaseData
-from dice_ml.utils.exception import SystemException, UserConfigValidationException
+from dice_ml.utils.exception import (SystemException,
+                                     UserConfigValidationException)
 
 
 class PublicData(_BaseData):
@@ -258,7 +260,7 @@ def get_valid_feature_range(self, feature_range_input, normalized=True):
         """
         feature_range = {}
 
-        for idx, feature_name in enumerate(self.feature_names):
+        for _, feature_name in enumerate(self.feature_names):
             feature_range[feature_name] = []
             if feature_name in self.continuous_feature_names:
                 max_value = self.data_df[feature_name].max()

dice_ml/dice.py

@@ -3,9 +3,9 @@
    such as RandomSampling, DiCEKD or DiCEGenetic"""
 
 from dice_ml.constants import BackEndTypes, SamplingStrategy
-from dice_ml.utils.exception import UserConfigValidationException
-from dice_ml.explainer_interfaces.explainer_base import ExplainerBase
 from dice_ml.data_interfaces.private_data_interface import PrivateData
+from dice_ml.explainer_interfaces.explainer_base import ExplainerBase
+from dice_ml.utils.exception import UserConfigValidationException
 
 
 class Dice(ExplainerBase):
@@ -67,12 +67,14 @@ def decide(model_interface, method):
 
     elif model_interface.backend == BackEndTypes.Tensorflow1:
         # pretrained Keras Sequential model with Tensorflow 1.x backend
-        from dice_ml.explainer_interfaces.dice_tensorflow1 import DiceTensorFlow1
+        from dice_ml.explainer_interfaces.dice_tensorflow1 import \
+            DiceTensorFlow1
         return DiceTensorFlow1
 
     elif model_interface.backend == BackEndTypes.Tensorflow2:
         # pretrained Keras Sequential model with Tensorflow 2.x backend
-        from dice_ml.explainer_interfaces.dice_tensorflow2 import DiceTensorFlow2
+        from dice_ml.explainer_interfaces.dice_tensorflow2 import \
+            DiceTensorFlow2
         return DiceTensorFlow2
 
     elif model_interface.backend == BackEndTypes.Pytorch:

dice_ml/diverse_counterfactuals.py

@@ -1,8 +1,10 @@
-import pandas as pd
 import copy
 import json
+
+import pandas as pd
+
+from dice_ml.constants import ModelTypes, _SchemaVersions
 from dice_ml.utils.serialize import DummyDataInterface
-from dice_ml.constants import _SchemaVersions, ModelTypes
 
 
 class _DiverseCFV1SchemaConstants:
@@ -115,6 +117,7 @@ def _visualize_internal(self, display_sparse_df=True, show_only_changes=False,
 
     def visualize_as_dataframe(self, display_sparse_df=True, show_only_changes=False):
         from IPython.display import display
+
         # original instance
         print('Query instance (original outcome : %i)' % round(self.test_pred))
         display(self.test_instance_df)  # works only in Jupyter notebook