Skip to content

Commit bfa230a

Browse files
committed
docs: rename the custom-functions page title to include classes
Rename the page heading to "Use Functions, Methods, and Classes to Build Fitness and Callbacks" so the title reflects the new class option. Repoint the two release-note links to the updated anchor and update the matching card on the More About PyGAD landing page.
1 parent e6940a9 commit bfa230a

3 files changed

Lines changed: 5 additions & 5 deletions

File tree

‎docs/source/custom_functions.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Use Functions and Methods to Build Fitness and Callbacks
1+
# Use Functions, Methods, and Classes to Build Fitness and Callbacks
22

33
In PyGAD 2.19.0, it is possible to pass user-defined functions or methods to the following parameters:
44

‎docs/source/pygad_more.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -40,11 +40,11 @@ Parallel processing, batch fitness, reusing fitness, and non-deterministic probl
4040
Print a Keras-like summary and log the outputs.
4141
:::
4242

43-
:::{grid-item-card} User-Defined Functions and Callbacks
43+
:::{grid-item-card} User-Defined Functions, Methods, and Classes
4444
:link: custom_functions
4545
:link-type: doc
4646

47-
Pass your own functions or methods for the fitness and callbacks.
47+
Pass your own functions, methods, or classes for the fitness and callbacks.
4848
:::
4949

5050
::::

‎docs/source/releases.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -470,8 +470,8 @@ Release Date 8 April 2023
470470
6. The `pygad.visualize.plot` module has a class named `Plot` where all the methods that create plots exist. The `pygad.GA` class extends this class.
471471
7. Support of using the `logging` module to log the outputs to both the console and text file instead of using the `print()` function. This is by assigning the `logging.Logger` to the new `logger` parameter. Check the [Logging Outputs](https://pygad.readthedocs.io/en/latest/logging.html#logging-outputs) for more information.
472472
8. A new instance attribute called `logger` to save the logger.
473-
9. The function/method passed to the `fitness_func` parameter accepts a new parameter that refers to the instance of the `pygad.GA` class. Check this for an example: [Use Functions and Methods to Build Fitness Function and Callbacks](https://pygad.readthedocs.io/en/latest/custom_functions.html#use-functions-and-methods-to-build-fitness-and-callbacks). https://github.com/ahmedfgad/GeneticAlgorithmPython/issues/163
474-
10. Update the documentation to include an example of using functions and methods to calculate the fitness and build callbacks. Check this for more details: [Use Functions and Methods to Build Fitness Function and Callbacks](https://pygad.readthedocs.io/en/latest/custom_functions.html#use-functions-and-methods-to-build-fitness-and-callbacks). https://github.com/ahmedfgad/GeneticAlgorithmPython/pull/92#issuecomment-1443635003
473+
9. The function/method passed to the `fitness_func` parameter accepts a new parameter that refers to the instance of the `pygad.GA` class. Check this for an example: [Use Functions and Methods to Build Fitness Function and Callbacks](https://pygad.readthedocs.io/en/latest/custom_functions.html#use-functions-methods-and-classes-to-build-fitness-and-callbacks). https://github.com/ahmedfgad/GeneticAlgorithmPython/issues/163
474+
10. Update the documentation to include an example of using functions and methods to calculate the fitness and build callbacks. Check this for more details: [Use Functions and Methods to Build Fitness Function and Callbacks](https://pygad.readthedocs.io/en/latest/custom_functions.html#use-functions-methods-and-classes-to-build-fitness-and-callbacks). https://github.com/ahmedfgad/GeneticAlgorithmPython/pull/92#issuecomment-1443635003
475475
11. Validate the value passed to the `initial_population` parameter.
476476
12. Validate the type and length of the `pop_fitness` parameter of the `best_solution()` method.
477477
13. Some edits in the documentation. https://github.com/ahmedfgad/GeneticAlgorithmPython/issues/106

0 commit comments

Comments
 (0)