Metadata-Version: 1.1
Name: focus-cfe
Version: 0.0.dev0
Summary: ``FOCUS`` is a python package for generating counterfactual explanations for a tree-based model
Home-page: UNKNOWN
Author: Kyosuke Morita
Author-email: kq441morita@gmail.com
License: UNKNOWN
Description: FOCUS: Flexible Optimizable Counterfactual Explanations for Tree Ensembles
        ==========================================================================
        
        **Deployment & Documentation & Stats & License**
        
        .. image:: https://img.shields.io/pypi/v/pyod.svg?color=brightgreen
           :target: https://pypi.org/project/focus/
           :alt: PyPI version
        
        .. image:: https://coveralls.io/repos/github/kyosek/focus/badge.svg
           :target: https://coveralls.io/github/kyosek/focus
           :alt: Coverage Status
        
        .. image:: https://api.codeclimate.com/v1/badges/bdc3d8d0454274c753c4/maintainability
           :target: https://codeclimate.com/github/kyosek/focus/maintainability
           :alt: Maintainability
        
        -----
        
        This library is an implementation of `FOCUS: Flexible Optimizable Counterfactual Explanations for Tree Ensembles <https://arxiv.org/abs/1911.12199>`_.
        
        FOCUS generates optimal distance counterfactual explanations to the original data for all the instances in tree‐based machine learning models.
        
        **FOCUS counterfactual explanation generation with 3 Lines of Code**\ :
        
        .. code-block:: python
        
            from focus import Focus
            # Initialize Focus instance with default values
            focus = Focus()
            # Generate counterfactual explanations for given tree model and features
            pertubed = focus.generate(tree_model, X)
        
        Installation
        ^^^^^^^^^^^^
        
        It is recommended to use **pip** or **conda** for installation. Please make sure
        **the latest version** is installed:
        
        .. code-block:: bash
        
           pip install focus            # normal install
           pip install --upgrade focus  # or update if needed
        
        .. code-block:: bash
        
           conda install -c conda-forge focus
        
Keywords: python,counterfactual explanation,binary classification,machine learning
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Education
Classifier: Intended Audience :: Science/Research
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Information Technology
Classifier: License :: OSI Approved :: BSD License
Classifier: Programming Language :: Python :: 3
Classifier: Operating System :: MacOS :: MacOS X
Classifier: Operating System :: Microsoft :: Windows
