Skip to content

Commit

Permalink
update setup.py and README.rst
Browse files Browse the repository at this point in the history
  • Loading branch information
kyosek committed Jul 26, 2023
1 parent 36c129e commit 1124779
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 5 deletions.
6 changes: 3 additions & 3 deletions README.rst
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
CFXplorer
==========================================================================
=========

**Deployment & Documentation & Stats & License**

Expand Down Expand Up @@ -81,7 +81,7 @@ Examples
--------

- Comprehensive examples can be found in the `examples folder <https://github.com/kyosek/CFXplorer/blob/master/examples/focus_example.py>`_.
- Kaggle notebook example can be found `here <https://www.kaggle.com/code/kyosukemorita/CFXplorer-example>`_.
- Kaggle notebook example can be found `here <https://www.kaggle.com/code/kyosukemorita/focus-example>`__.
- Below is demonstrated a comparison of before and after Focus is applied to feature set from the example given above.

.. image:: https://raw.githubusercontent.com/kyosek/focus/master/docs/plot.png
Expand All @@ -100,7 +100,7 @@ Limitations of Focus class
Documentation
-------------

The documentation can be found `here <https://cfxplorer.readthedocs.io/en/latest/>`_.
The documentation can be found `here <https://cfxplorer.readthedocs.io/en/latest/>`__.

Contributing
------------
Expand Down
3 changes: 1 addition & 2 deletions setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,7 @@

from setuptools import find_packages, setup

DESCRIPTION = "CFXplorer is a python package for generating counterfactual explanations"

DESCRIPTION = "CFXplorer is a python package for generating counterfactual explanations for given model and feature set"

# get __version__ from _version.py
ver_file = path.join("cfxplorer", "version.py")
Expand Down

0 comments on commit 1124779

Please sign in to comment.