Debug machine learning classifiers and explain their predictions
ELI5 is a Python package which helps to debug machine learning classifiers and explain their predictions.
It provides support for the following machine learning frameworks and packages:
- scikit-learn. Currently ELI5 allows to explain weights and predictions of scikit-learn linear classifiers and regressors, print decision trees as text or as SVG, show feature importances and explain predictions of decision trees and tree-based ensembles. ELI5 understands text processing utilities from scikit-learn and can highlight text data accordingly. Pipeline and FeatureUnion are supported. It also allows to debug scikit-learn pipelines which contain HashingVectorizer, by undoing hashing.
- xgboost - show feature importances and explain predictions of XGBClassifier, XGBRegressor and xgboost.Booster.
- LightGBM - show feature importances and explain predictions of LGBMClassifier and LGBMRegressor.
- lightning - explain weights and predictions of lightning classifiers and regressors.
- sklearn-crfsuite. ELI5 allows to check weights of sklearn_crfsuite.CRF models.
ELI5 also implements several algorithms for inspecting black-box models (see Inspecting Black-Box Estimators):
- TextExplainer allows to explain predictions of any text classifier using LIME algorithm (Ribeiro et al., 2016). There are utilities for using LIME with non-text data and arbitrary black-box classifiers as well, but this feature is currently experimental.
- Permutation importance method can be used to compute feature importances for black box estimators.
Explanation and formatting are separated; you can get text-based explanation to display in console, HTML version embeddable in an IPython notebook or web dashboards, a pandas.DataFrame object if you want to process results further, or JSON version which allows to implement custom rendering and formatting on a client.
License is MIT.
Check docs for more.
- backwards incompatible: DataFrame objects with explanations no longer use indexes and pivot tables, they are now just plain DataFrames;
- new method for inspection black-box models is added
- transfor_feature_names is implemented for sklearn’s MinMaxScaler, StandardScaler, MaxAbsScaler and RobustScaler;
- zero and negative feature importances are no longer hidden;
- fixed compatibility with scikit-learn 0.19;
- fixed compatibility with LightGBM master (2.0.5 and 2.0.6 are still unsupported - there are bugs in LightGBM);
- documentation, testing and type annotation improvements.
- better pandas.DataFrame integration:
eli5.format_as_dataframes <eli5.formatters.as_dataframe.format_as_dataframes>functions allow to export explanations to pandas.DataFrames;
eli5.explain_predictionnow shows predicted class for binary classifiers (previously it was always showing positive class);
eli5.explain_predictionsupports targets=[<class>] now for binary classifiers; e.g. to show result as seen for negative class, you can use eli5.explain_prediction(..., targets=[False]);
eli5.explain_weightsfor libsvm-based linear estimators from sklearn.svm: SVC(kernel='linear') (only binary classification), NuSVC(kernel='linear') (only binary classification), SVR(kernel='linear'), NuSVR(kernel='linear'), OneClassSVM(kernel='linear');
eli5.explain_weightsfor LightGBM estimators in Python 2 when importance_type is ‘split’ or ‘weight’;
- testing improvements.
eli5.explain_predictionfor recent LightGBM versions;
- fixed Python 3 deprecation warning in formatters.html;
- testing improvements.
eli5.explain_predictionworks with xgboost.Booster, not only with sklearn-like APIs;
eli5.formatters.as_dict.format_as_dictis now available as eli5.format_as_dict;
- testing and documentation fixes.
eli5.explain_weightsfor XGBoost models trained on pandas.DataFrame;
eli5.explain_weightsfor LightGBM models trained on pandas.DataFrame;
- fixed an issue with
eli5.explain_predictionfor XGBoost models trained on pandas.DataFrame when feature names contain dots;
- testing improvements.
- Better pandas support in
eli5.explain_predictionfor xgboost, sklearn, LightGBM and lightning.
- Better scikit-learn Pipeline support in
eli5.explain_weights: it is now possible to pass a Pipeline object directly. Curently only SelectorMixin-based transformers, FeatureUnion and transformers with get_feature_names are supported, but users can register other transformers; built-in list of supported transformers will be expanded in future. See
- Inverting of HashingVectorizer is now supported inside FeatureUnion
- Fixed compatibility with Jupyter Notebook >= 5.0.0.
eli5.explain_weightsfor Lasso regression with a single feature and no intercept.
- Fixed unhashing support in Python 2.x.
- Documentation and testing improvements.
- LightGBM support:
eli5.explain_weightsare now supported for LGBMClassifier and LGBMRegressor (see
eli5 LightGBM support <library-lightgbm>).
- fixed text formatting if all weights are zero;
- type checks now use latest mypy;
- testing setup improvements: Travis CI now uses Ubuntu 14.04.
- bug fix: eli5 should remain importable if xgboost is available, but not installed correctly.
- feature contribution calculation fixed
eli5.explain_prediction: new ‘top_targets’ argument allows to display only predictions with highest or lowest scores;
eli5.explain_weightsallows to customize the way feature importances are computed for XGBClassifier and XGBRegressor using importance_type argument (see docs for the
eli5 XGBoost support <library-xgboost>);
eli5.explain_weightsuses gain for XGBClassifier and XGBRegressor feature importances by default; this method is a better indication of what’s going, and it makes results more compatible with feature importances displayed for scikit-learn gradient boosting methods.
- packaging fix: scikit-learn is added to install_requires in setup.py.
eli5.explain_predictionworks for XGBClassifier, XGBRegressor from XGBoost and for ExtraTreesClassifier, ExtraTreesRegressor, GradientBoostingClassifier, GradientBoostingRegressor, RandomForestClassifier, RandomForestRegressor, DecisionTreeClassifier and DecisionTreeRegressor from scikit-learn. Explanation method is based on http://blog.datadive.net/interpreting-random-forests/ .
eli5.explain_weightsnow supports tree-based regressors from scikit-learn: DecisionTreeRegressor, AdaBoostRegressor, GradientBoostingRegressor, RandomForestRegressor and ExtraTreesRegressor.
eli5.explain_weightsworks for XGBRegressor;
TextExplainer <lime-tutorial>class allows to explain predictions of black-box text classification pipelines using LIME algorithm; many improvements in
- better sklearn.pipeline.FeatureUnion support in
- rendering performance is improved;
- a number of remaining feature importances is shown when the feature importance table is truncated;
- styling of feature importances tables is fixed;
eli5.explain_predictionsupport more linear estimators from scikit-learn: HuberRegressor, LarsCV, LassoCV, LassoLars, LassoLarsCV, LassoLarsIC, OrthogonalMatchingPursuit, OrthogonalMatchingPursuitCV, PassiveAggressiveRegressor, RidgeClassifier, RidgeClassifierCV, TheilSenRegressor.
- text-based formatting of decision trees is changed: for binary classification trees only a probability of “true” class is printed, not both probabilities as it was before.
eli5.explain_weightssupports feature_filter in addition to feature_re for filtering features, and
eli5.explain_predictionnow also supports both of these arguments;
- ‘Weight’ column is renamed to ‘Contribution’ in the output of
- new show_feature_values=True formatter argument allows to display input feature values;
- fixed an issue with analyzer=’char_wb’ highlighting at the start of the text.
- XGBClassifier support (from XGBoost package);
eli5.explain_weightssupport for sklearn OneVsRestClassifier;
- std deviation of feature importances is no longer printed as zero if it is not available.
- packaging fixes: require attrs > 16.0.0, fixed README rendering
- HTML output;
- IPython integration;
- JSON output;
- visualization of scikit-learn text vectorizers;
- sklearn-crfsuite support;
- lightning support;
eli5.lime <eli5-lime>improvements: samplers for non-text data, bug fixes, docs;
- HashingVectorizer is supported for regression tasks;
- performance improvements - feature names are lazy;
- sklearn ElasticNetCV and RidgeCV support;
- it is now possible to customize formatting output - show/hide sections, change layout;
- sklearn OneVsRestClassifier support;
- sklearn DecisionTreeClassifier visualization (text-based or svg-based);
- dropped support for scikit-learn < 0.18;
- basic mypy type annotations;
- feature_re argument allows to show only a subset of features;
- target_names argument allows to change display names of targets/classes;
- targets argument allows to show a subset of targets/classes and change their display order;
- documentation, more examples.
- Candidate features in eli5.sklearn.InvertableHashingVectorizer are ordered by their frequency, first candidate is always positive.
- HashingVectorizer support in explain_prediction;
- add an option to pass coefficient scaling array; it is useful if you want to compare coefficients for features which scale or sign is different in the input;
- bug fix: classifier weights are no longer changed by eli5 functions.
- eli5.sklearn.InvertableHashingVectorizer and eli5.sklearn.FeatureUnhasher allow to recover feature names for pipelines which use HashingVectorizer or FeatureHasher;
- added support for scikit-learn linear regression models (ElasticNet, Lars, Lasso, LinearRegression, LinearSVR, Ridge, SGDRegressor);
- doc and vec arguments are swapped in explain_prediction function; vec can now be omitted if an example is already vectorized;
- fixed issue with dense feature vectors;
- all class_names arguments are renamed to target_names;
- feature name guessing is fixed for scikit-learn ensemble estimators;
- testing improvements.
- support any black-box classifier using LIME (http://arxiv.org/abs/1602.04938) algorithm; text data support is built-in;
- “vectorized” argument for sklearn.explain_prediction; it allows to pass example which is already vectorized;
- allow to pass feature_names explicitly;
- support classifiers without get_feature_names method using auto-generated feature names.
- ‘top’ argument of explain_prediction can be a tuple (num_positive, num_negative);
- classifier name is no longer printed by default;
- added eli5.sklearn.explain_prediction to explain individual examples;
- fixed numpy warning.
Release history Release notifications
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
|Filename, size & hash SHA256 hash help||File type||Python version||Upload date|
|eli5-0.8-py2.py3-none-any.whl (97.3 kB) Copy SHA256 hash SHA256||Wheel||3.6||Aug 25, 2017|
|eli5-0.8.tar.gz (185.9 kB) Copy SHA256 hash SHA256||Source||None||Aug 25, 2017|