Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

update docs #22

Merged
merged 1 commit into from
Jul 29, 2023
Merged

update docs #22

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@

# -- Project information -----------------------------------------------------

project = "cfxplorer"
project = "CFXplorer"
copyright = "2023, Kyosuke Morita"
author = "Kyosuke Morita"

Expand Down
6 changes: 3 additions & 3 deletions docs/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
================================
Welcome to cfepy's documentation
Welcome to CFXplorer's documentation
================================

Contents
Expand All @@ -13,7 +13,7 @@ Contents
api

**Links**: |
`GitHub repository <https://github.com/kyosek/focus>`__ |
`PyPI <https://pypi.org/project/focus-cfe/>`__ |
`GitHub repository <https://github.com/kyosek/CFXplorer>`__ |
`PyPI <https://pypi.org/project/CFXplorer/>`__ |

.. include:: ../README.rst
7 changes: 4 additions & 3 deletions docs/usage.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,19 +11,20 @@ Installation using pip:

.. code-block:: console

(.venv) $ pip install focus-cfe
(.venv) $ pip install CFXplorer


Example
-------
For given tree-based model - `tree_model` and feature set - `X`, `Focus` generates perturbed feature set - `X'`.
``Focus`` can generates perturbed feature set ``X'`` given tree-based model - ``tree_model`` and feature set - ``X``.

.. code-block:: python

from focus import Focus
from cfxplorer 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)
Loading