Skip to content

Commit

Permalink
update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
kyosek committed Jul 28, 2023
1 parent 6c75aa9 commit 653395f
Show file tree
Hide file tree
Showing 3 changed files with 8 additions and 7 deletions.
2 changes: 1 addition & 1 deletion docs/conf.py
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
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
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)

0 comments on commit 653395f

Please sign in to comment.