Update docs (#22)

kyosek · Jul 29, 2023 · debbad2 · debbad2
1 parent 6c75aa9
commit debbad2
Show file tree

Hide file tree

Showing 3 changed files with 8 additions and 7 deletions.
diff --git 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
@@ -1,5 +1,5 @@
 ================================
-Welcome to cfepy's documentation
+Welcome to CFXplorer's documentation
 ================================
 
 Contents
@@ -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
diff --git 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)