Merge pull request #272 from ahmedfgad/github-actions

Cite journal paper
ahmedfgad · Feb 2, 2024 · 98b187b · 98b187b
2 parents d76c60f + 30de970
commit 98b187b
Show file tree

Hide file tree

Showing 3 changed files with 19 additions and 20 deletions.
diff --git a/README.md b/README.md
@@ -311,13 +311,13 @@ Find the book at these links:
 If you used PyGAD, please consider adding a citation to the following paper about PyGAD:
 
 ```
-@misc{gad2021pygad,
-      title={PyGAD: An Intuitive Genetic Algorithm Python Library}, 
-      author={Ahmed Fawzy Gad},
-      year={2021},
-      eprint={2106.06158},
-      archivePrefix={arXiv},
-      primaryClass={cs.NE}
+@article{gad2023pygad,
+  title={Pygad: An intuitive genetic algorithm python library},
+  author={Gad, Ahmed Fawzy},
+  journal={Multimedia Tools and Applications},
+  pages={1--14},
+  year={2023},
+  publisher={Springer}
 }
 ```
 

diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -228,13 +228,13 @@ details:
 
 .. code:: 
 
-   @misc{gad2021pygad,
-         title={PyGAD: An Intuitive Genetic Algorithm Python Library}, 
-         author={Ahmed Fawzy Gad},
-         year={2021},
-         eprint={2106.06158},
-         archivePrefix={arXiv},
-         primaryClass={cs.NE}
+   @article{gad2023pygad,
+     title={Pygad: An intuitive genetic algorithm python library},
+     author={Gad, Ahmed Fawzy},
+     journal={Multimedia Tools and Applications},
+     pages={1--14},
+     year={2023},
+     publisher={Springer}
    }
 
 

diff --git a/docs/source/pygad.rst b/docs/source/pygad.rst
@@ -119,7 +119,7 @@ The ``pygad.GA`` class constructor supports the following parameters:
    function can be passed starting from `PyGAD
    2.16.0 <https://pygad.readthedocs.io/en/latest/releases.html#pygad-2-16-0>`__.
    Check the `User-Defined Crossover, Mutation, and Parent Selection
-   Operators <https://pygad.readthedocs.io/en/latest/pygad_more.html#user-defined-crossover-mutation-and-parent-selection-operators>`__
+   Operators <https://pygad.readthedocs.io/en/latest/utils.html#user-defined-crossover-mutation-and-parent-selection-operators>`__
    section for more details about building a user-defined parent
    selection function.
 
@@ -1037,11 +1037,10 @@ Let's discuss how to do each of these steps.
 Preparing the ``fitness_func`` Parameter 
 -----------------------------------------
 
-Even though some steps in the genetic algorithm pipeline can
-work the same regardless of the problem being solved, one critical step
-is the calculation of the fitness value. There is no unique way of
-calculating the fitness value and it changes from one problem to
-another.
+Even though some steps in the genetic algorithm pipeline can work the
+same regardless of the problem being solved, one critical step is the
+calculation of the fitness value. There is no unique way of calculating
+the fitness value and it changes from one problem to another.
 
 PyGAD has a parameter called ``fitness_func`` that allows the user to
 specify a custom function/method to use when calculating the fitness.