Skip to content

Commit 8ef24c1

Browse files
committed
Update release 3.0.0 notes
1 parent a62ca2b commit 8ef24c1

File tree

1 file changed

+30
-40
lines changed

1 file changed

+30
-40
lines changed

docs/source/Footer.rst

Lines changed: 30 additions & 40 deletions
Original file line numberDiff line numberDiff line change
@@ -1198,84 +1198,74 @@ PyGAD 3.0.0
11981198

11991199
Release Date 8 April 2023
12001200

1201-
1. The structure of the library is changed and some methods defined in
1202-
the ``pygad.py`` module are moved to the ``pygad.utils``,
1203-
``pygad.helper``, and ``pygad.visualize`` submodules.
1201+
1. The structure of the library is changed and some methods defined in
1202+
the ``pygad.py`` module are moved to the ``pygad.utils``,
1203+
``pygad.helper``, and ``pygad.visualize`` submodules.
12041204

1205-
2. The ``pygad.utils.parent_selection`` module has a class named
1206-
``ParentSelection`` where all the parent selection operators exist.
1207-
The ``pygad.GA`` class extends this class.
1205+
2. The ``pygad.utils.parent_selection`` module has a class named
1206+
``ParentSelection`` where all the parent selection operators exist.
1207+
The ``pygad.GA`` class extends this class.
12081208

1209-
3. The ``pygad.utils.crossover`` module has a class named ``Crossover``
1210-
where all the crossover operators exist. The ``pygad.GA`` class
1211-
extends this class.
1209+
3. The ``pygad.utils.crossover`` module has a class named ``Crossover``
1210+
where all the crossover operators exist. The ``pygad.GA`` class
1211+
extends this class.
12121212

1213-
4. The ``pygad.utils.mutation`` module has a class named ``Mutation``
1214-
where all the mutation operators exist. The ``pygad.GA`` class
1215-
extends this class.
1213+
4. The ``pygad.utils.mutation`` module has a class named ``Mutation``
1214+
where all the mutation operators exist. The ``pygad.GA`` class
1215+
extends this class.
12161216

1217-
5. The ``pygad.helper.unique`` module has a class named ``Unique`` some
1218-
helper methods exist to solve duplicate genes and make sure every
1219-
gene is unique. The ``pygad.GA`` class extends this class.
1217+
5. The ``pygad.helper.unique`` module has a class named ``Unique`` some
1218+
helper methods exist to solve duplicate genes and make sure every
1219+
gene is unique. The ``pygad.GA`` class extends this class.
12201220

1221-
6. The ``pygad.visualize.plot`` module has a class named ``Plot`` where
1222-
all the methods that create plots exist. The ``pygad.GA`` class
1223-
extends this class.
1221+
6. The ``pygad.visualize.plot`` module has a class named ``Plot`` where
1222+
all the methods that create plots exist. The ``pygad.GA`` class
1223+
extends this class.
12241224

1225-
.. code:: python
1226-
1227-
...
1228-
class GA(utils.parent_selection.ParentSelection,
1229-
utils.crossover.Crossover,
1230-
utils.mutation.Mutation,
1231-
helper.unique.Unique,
1232-
visualize.plot.Plot):
1233-
...
1234-
1235-
1. Support of using the ``logging`` module to log the outputs to both
1225+
7. Support of using the ``logging`` module to log the outputs to both
12361226
the console and text file instead of using the ``print()`` function.
12371227
This is by assigning the ``logging.Logger`` to the new ``logger``
12381228
parameter. Check the `Logging
12391229
Outputs <https://pygad.readthedocs.io/en/latest/README_pygad_ReadTheDocs.html#logging-outputs>`__
12401230
for more information.
12411231

1242-
2. A new instance attribute called ``logger`` to save the logger.
1232+
8. A new instance attribute called ``logger`` to save the logger.
12431233

1244-
3. The function/method passed to the ``fitness_func`` parameter accepts
1234+
9. The function/method passed to the ``fitness_func`` parameter accepts
12451235
a new parameter that refers to the instance of the ``pygad.GA``
12461236
class. Check this for an example: `Use Functions and Methods to
12471237
Build Fitness Function and
12481238
Callbacks <https://pygad.readthedocs.io/en/latest/README_pygad_ReadTheDocs.html#use-functions-and-methods-to-build-fitness-and-callbacks>`__.
12491239
https://github.com/ahmedfgad/GeneticAlgorithmPython/issues/163
12501240

1251-
4. Update the documentation to include an example of using functions
1241+
10. Update the documentation to include an example of using functions
12521242
and methods to calculate the fitness and build callbacks. Check this
12531243
for more details: `Use Functions and Methods to Build Fitness
12541244
Function and
12551245
Callbacks <https://pygad.readthedocs.io/en/latest/README_pygad_ReadTheDocs.html#use-functions-and-methods-to-build-fitness-and-callbacks>`__.
12561246
https://github.com/ahmedfgad/GeneticAlgorithmPython/pull/92#issuecomment-1443635003
12571247

1258-
5. Validate the value passed to the ``initial_population`` parameter.
1248+
11. Validate the value passed to the ``initial_population`` parameter.
12591249

1260-
6. Validate the type and length of the ``pop_fitness`` parameter of the
1250+
12. Validate the type and length of the ``pop_fitness`` parameter of the
12611251
``best_solution()`` method.
12621252

1263-
7. Some edits in the documentation.
1253+
13. Some edits in the documentation.
12641254
https://github.com/ahmedfgad/GeneticAlgorithmPython/issues/106
12651255

1266-
8. Fix an issue when building the initial population as (some) genes
1256+
14. Fix an issue when building the initial population as (some) genes
12671257
have their value taken from the mutation range (defined by the
12681258
parameters ``random_mutation_min_val`` and
12691259
``random_mutation_max_val``) instead of using the parameters
12701260
``init_range_low`` and ``init_range_high``.
12711261

1272-
9. The ``summary()`` method returns the summary as a single-line
1262+
15. The ``summary()`` method returns the summary as a single-line
12731263
string. Just log/print the returned string it to see it properly.
12741264

1275-
10. The ``callback_generation`` parameter is removed. Use the
1265+
16. The ``callback_generation`` parameter is removed. Use the
12761266
``on_generation`` parameter instead.
12771267

1278-
11. There was an issue when using the ``parallel_processing`` parameter
1268+
17. There was an issue when using the ``parallel_processing`` parameter
12791269
with Keras and PyTorch. As Keras/PyTorch are not thread-safe, the
12801270
``predict()`` method gives incorrect and weird results when more
12811271
than 1 thread is used.
@@ -1285,7 +1275,7 @@ Release Date 8 April 2023
12851275
`StackOverflow
12861276
answer <https://stackoverflow.com/a/75606666/5426539>`__.
12871277

1288-
12. Replace ``numpy.float`` by ``float`` in the 2 parent selection
1278+
18. Replace ``numpy.float`` by ``float`` in the 2 parent selection
12891279
operators roulette wheel and stochastic universal.
12901280
https://github.com/ahmedfgad/GeneticAlgorithmPython/pull/168
12911281

0 commit comments

Comments
 (0)