Update & Revise documentation

andreArtelt · May 13, 2020 · 3954671 · 3954671
1 parent b6bce97
commit 3954671
Show file tree

Hide file tree

Showing 7 changed files with 26 additions and 27 deletions.
diff --git a/README.rst b/README.rst
@@ -1,19 +1,19 @@
 ****
-ceml
+CEML
 ****
 --------------------------------------------------------
 Counterfactuals for Explaining Machine Learning models
 --------------------------------------------------------
 
-ceml is a Python toolbox for computing counterfactuals. Counterfactuals can be use to explain the predictions of machine learing models.
+CEML is a Python toolbox for computing counterfactuals. Counterfactuals can be use to explain the predictions of machine learing models.
 
 It supports many common machine learning frameworks:
 
     - scikit-learn (0.22.2)
     - PyTorch (1.5.0)
     - Keras & Tensorflow (2.2.0)
 
-Furthermore, ceml is easy to use and can be extended very easily. See the following user guide for more information on how to use and extend ceml.
+Furthermore, CEML is easy to use and can be extended very easily. See the following user guide for more information on how to use and extend CEML.
 
 Installation
 ------------
@@ -27,9 +27,9 @@ PyPI
 
     pip install ceml
 
-**Note**: The package hosted on PyPI uses the cpu only. If you want to use the gpu, you have to install ceml manually - see next section.
+**Note**: The package hosted on PyPI uses the cpu only. If you want to use the gpu, you have to install CEML manually - see next section.
 
-**ATTENTION**: It can happen that the installation of sklearn-lvq fails with the message "numpy is required during installation". In this case you either have to install numpy and scipy first (before running *pip install ceml*), or install ceml manually as described in the next section. 
+**ATTENTION**: It can happen that the installation of sklearn-lvq fails with the message "numpy is required during installation". In this case you either have to install numpy and scipy first (before running *pip install ceml*), or install CEML manually as described in the next section. 
 
 Git
 +++
@@ -102,7 +102,7 @@ MIT license - See `LICENSE <LICENSE>`_
 
 How to cite?
 ------------
-    You can cite ceml by using the following BibTeX entry:
+    You can cite CEML by using the following BibTeX entry:
 
     .. code-block::
 

diff --git a/docs/advanced.rst b/docs/advanced.rst
@@ -2,7 +2,7 @@
 Advanced
 *********
 
-ceml can be easily extended and all major components can be customized to fit the users needs.
+CEML can be easily extended and all major components can be customized to fit the users needs.
 
 Below is a (non-exhaustive) list of some (common) use cases:
 

diff --git a/docs/conf.py b/docs/conf.py
@@ -18,7 +18,7 @@
 # -- Project information -----------------------------------------------------
 
 project = 'ceml'
-copyright = '2019, André Artelt'
+copyright = '2019 - 2020, André Artelt'
 author = 'André Artelt'
 
 

diff --git a/docs/faq.rst b/docs/faq.rst
@@ -2,7 +2,7 @@
 FAQ
 ===
 
-How can I install ceml?
+How can I install CEML?
     .. code:: bash
         
         pip install ceml
@@ -12,23 +12,23 @@ How can I install ceml?
 Under which license is ceml released?
     MIT license - See License_.
 
-How can I cite ceml?
-    You can cite ceml by using the following BibTeX entry:
+How can I cite CEML?
+    You can cite CEML by using the following BibTeX entry:
 
     .. code-block::
 
         @misc{ceml,
                 author = {André Artelt},
                 title = {CEML: Counterfactuals for Explaining Machine Learning models - A Python toolbox},
-                year = {2019},
+                year = {2019 - 2020},
                 publisher = {GitHub},
                 journal = {GitHub repository},
                 howpublished = {\url{https://www.github.com/andreArtelt/ceml}}
             }
 
-    *Please consider citing ceml if it helps you in your research.*
+    *Please consider citing CEML if it helps you in your research.*
 
-Is citing ceml mandatory?
+Is citing CEML mandatory?
     No, of course not. But it is best practice to cite everything you have used (literature as well as software).
 
 How can I submit a bug report?

diff --git a/docs/index.rst b/docs/index.rst
@@ -1,19 +1,18 @@
-Welcome to ceml's documentation!
+Welcome to CEML's documentation!
 ================================
 
-Counterfactuals for Explaining Machine Learning models - ceml
+Counterfactuals for Explaining Machine Learning models - CEML
 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
 
-ceml is a Python toolbox for computing counterfactuals. Counterfactuals can be used to explain the predictions of machine learing models.
+CEML is a Python toolbox for computing counterfactuals. Counterfactuals can be used to explain the predictions of machine learing models.
 
 It supports many common machine learning frameworks:
 
-    - scikit-learn
-    - PyTorch
-    - Keras
-    - Tensorflow
+    - scikit-learn (0.22.2)
+    - PyTorch (1.5.0)
+    - Keras & Tensorflow (2.2.0)
 
-Furthermore, ceml is easy to use and can be extended very easily. See the following user guide for more information on how to use and extend ceml.
+Furthermore, CEML is easy to use and can be extended very easily. See the following user guide for more information on how to use and extend ceml.
 
 
 .. toctree::

diff --git a/docs/installation.rst b/docs/installation.rst
@@ -16,7 +16,7 @@ PyPi
     pip install ceml
 
 .. note::
-    The package hosted on PyPi uses the cpu only. If you want to use the gpu, you have to install ceml manually - see next section.
+    The package hosted on PyPI uses the cpu only. If you want to use the gpu, you have to install CEML manually - see next section.
 
 
 Git
@@ -35,7 +35,7 @@ Install all requirements (listed in ``requirements.txt``):
     pip install -r requirements.txt
 
 .. note::
-    If you want to use a gpu/tpu, you have to install the gpu version of jax, tensorflow and pytorch manually.
+    If you want to use a gpu/tpu, you have to install the gpu version of jax, tensorflow and PyTorch manually.
 
     Do not use ``pip install -r requirements.txt``
 

diff --git a/docs/tutorial.rst b/docs/tutorial.rst
@@ -2,13 +2,13 @@
 Tutorial
 *********
 
-ceml was designed with usability in mind.
+CEML was designed with usability in mind.
 
-In the subsequent paragraphs, we demonstrate how to use ceml with models from different machine learning libraries.
+In the subsequent paragraphs, we demonstrate how to use CEML with models from different machine learning libraries.
 
 .. toctree::
     :maxdepth: 2
-    :caption: Machine Learning libraries
+    :caption: Machine Learning frameworks
 
     tut_sklearn
     tut_pytorch