Skip to content

Commit 21f4788

Browse files
committed
Update docs
1 parent 5122c64 commit 21f4788

File tree

7 files changed

+3550
-3222
lines changed

7 files changed

+3550
-3222
lines changed

docs/source/helper.rst

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
.. _pygadhelper-module:
2+
3+
``pygad.helper`` Module
4+
=======================
5+
6+
This section of the PyGAD's library documentation discusses the
7+
**pygad.helper** module.
8+
9+
Yet, this module has a submodule called ``unique`` that has a class
10+
named ``Unique`` with some helper methods. Such methods help to check
11+
and fix duplicate values in the genes of a solution.

docs/source/index.rst

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -19,9 +19,10 @@ optimizing machine learning algorithms. It works with
1919
different types of crossover, mutation, and parent selection operators.
2020
`PyGAD <https://github.com/ahmedfgad/GeneticAlgorithmPython>`__ allows
2121
different types of problems to be optimized using the genetic algorithm
22-
by customizing the fitness function.
22+
by customizing the fitness function. It works with both single-objective
23+
and multi-objective optimization problems.
2324

24-
.. figure:: https://user-images.githubusercontent.com/16560492/101267295-c74c0180-375f-11eb-9ad0-f8e37bd796ce.png
25+
.. image:: https://user-images.githubusercontent.com/16560492/101267295-c74c0180-375f-11eb-9ad0-f8e37bd796ce.png
2526
:alt:
2627

2728
*Logo designed by* `Asmaa
@@ -108,6 +109,11 @@ equation.
108109
A very important step is to implement the fitness function that will be
109110
used for calculating the fitness value for each solution. Here is one.
110111

112+
If the fitness function returns a number, then the problem is
113+
single-objective. If a ``list``, ``tuple``, or ``numpy.ndarray`` is
114+
returned, then it is a multi-objective problem (applicable even if a
115+
single element exists).
116+
111117
.. code:: python
112118
113119
def fitness_func(ga_instance, solution, solution_idx):
@@ -213,7 +219,7 @@ PyGAD's Modules
213219
8. The ``visualize`` module to visualize the results.
214220

215221
9. The ``utils`` module contains the operators (crossover, mutation,
216-
and parent selection).
222+
and parent selection) and the NSGA-II code.
217223

218224
10. The ``helper`` module has some helper functions.
219225

docs/source/pygad.rst

Lines changed: 142 additions & 3219 deletions
Large diffs are not rendered by default.

0 commit comments

Comments
 (0)