Minor documentation changes

rodrigo-arenas · Jun 22, 2021 · 253db88 · 253db88
1 parent 4493a72
commit 253db88
Show file tree

Hide file tree

Showing 4 changed files with 8 additions and 8 deletions.
diff --git a/README.rst b/README.rst
@@ -32,21 +32,21 @@ Documentation is available `here <https://sklearn-genetic-opt.readthedocs.io/>`_
 
 Sampled distribution of hyperparameters:
 
-.. image:: https://github.com/rodrigo-arenas/Sklearn-genetic-opt/blob/master/demo/images/density.png?raw=true
+.. image:: https://github.com/rodrigo-arenas/Sklearn-genetic-opt/blob/master/docs/images/density.png?raw=true
 
 Optimization progress in a regression problem:
 
-.. image:: https://github.com/rodrigo-arenas/Sklearn-genetic-opt/blob/master/demo/images/fitness.png?raw=true
+.. image:: https://github.com/rodrigo-arenas/Sklearn-genetic-opt/blob/master/docs/images/fitness.png?raw=true
 
 
 Main Features:
 ##############
 
-* **GASearchCV**: Principal class of the package, holds the evolutionary cross validation optimization routine
-* **Algorithms**: Set of different evolutionary algorithms to use as optimization procedure
-* **Callbacks**: Custom evaluation strategies to generate Early Stopping rules
-* **Plots**: Generate pre-define plots to understand the optimization process
-* **MLflow**: Build-in integration with mlflow to log all the hyperparameters and their cv-score
+* **GASearchCV**: Principal class of the package, holds the evolutionary cross validation optimization routine.
+* **Algorithms**: Set of different evolutionary algorithms to use as optimization procedure.
+* **Callbacks**: Custom evaluation strategies to generate early stopping rules, logging or custom logic.
+* **Plots**: Generate pre-define plots to understand the optimization process.
+* **MLflow**: Build-in integration with mlflow to log all the hyperparameters, cv-scores and the fitted models.
 
 Usage:
 ######
@@ -114,7 +114,7 @@ Results
 
 Log controlled by verbosity
 
-.. image:: https://github.com/rodrigo-arenas/Sklearn-genetic-opt/blob/master/demo/images/log.JPG?raw=true
+.. image:: https://github.com/rodrigo-arenas/Sklearn-genetic-opt/blob/master/docs/images/log.JPG?raw=true
 
 Changelog
 #########

diff --git a/demo/images/density.png → docs/images/density.png b/demo/images/density.png → docs/images/density.png
diff --git a/demo/images/fitness.png → docs/images/fitness.png b/demo/images/fitness.png → docs/images/fitness.png
diff --git a/demo/images/log.JPG → docs/images/log.JPG b/demo/images/log.JPG → docs/images/log.JPG