From 653395f9e64acb2ce7538f4077f52100aa99cbce Mon Sep 17 00:00:00 2001 From: Kyosuke Morita Date: Fri, 28 Jul 2023 23:06:14 +0100 Subject: [PATCH] update docs --- docs/conf.py | 2 +- docs/index.rst | 6 +++--- docs/usage.rst | 7 ++++--- 3 files changed, 8 insertions(+), 7 deletions(-) diff --git a/docs/conf.py b/docs/conf.py index 71d147c..32d0e5c 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -18,7 +18,7 @@ # -- Project information ----------------------------------------------------- -project = "cfxplorer" +project = "CFXplorer" copyright = "2023, Kyosuke Morita" author = "Kyosuke Morita" diff --git a/docs/index.rst b/docs/index.rst index 990af40..3464b71 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -1,5 +1,5 @@ ================================ -Welcome to cfepy's documentation +Welcome to CFXplorer's documentation ================================ Contents @@ -13,7 +13,7 @@ Contents api **Links**: | -`GitHub repository `__ | -`PyPI `__ | +`GitHub repository `__ | +`PyPI `__ | .. include:: ../README.rst diff --git a/docs/usage.rst b/docs/usage.rst index 09f7f68..4b8d238 100644 --- a/docs/usage.rst +++ b/docs/usage.rst @@ -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)