Skip to content

Commit 5b579f1

Browse files
authored
Update README.md
1 parent e9717f0 commit 5b579f1

File tree

1 file changed

+3
-1
lines changed

1 file changed

+3
-1
lines changed

README.md

+3-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# GeneticAlgorithmPython
22

3-
As part of a series of 3 projects that uses Python 3 (with the user of NumPy) to build and train artificial neural networks using the genetic algorithm, **GeneticAlgorithmPython** is the first project which is an open-source Python 3 project for implementing the genetic algorithm based on NumPy.
3+
As part of a series of 3 projects that uses Python 3 (with the user of NumPy) to build and train artificial neural networks (ANNs) using the genetic algorithm (GA), **GeneticAlgorithmPython** is the first project which is an open-source Python 3 project for implementing the genetic algorithm based on NumPy.
44

55
Based on this project, a Python library named [`PyGAD`](https://pypi.org/project/pygad) is available at PyPI: https://pypi.org/project/pygad. To install PyGAD using pip, just issue this command:
66

@@ -12,6 +12,8 @@ The project has a single module named `pygad.py` which contains a class named `G
1212

1313
Simply, to run the genetic algorithm all you need to do is to create an instance of the `GA` class and pass the appropriate parameters to its constructor. The `GA` class has all the required parameters and methods for implementing the genetic algorithm.
1414

15+
**IMPORTANT** *If you are coming for the tutorial code of [GeneticAlgorithmPython](https://github.com/ahmedfgad/GeneticAlgorithmPython), then it has been moved to the [Tutorial Project](https://github.com/ahmedfgad/GeneticAlgorithmPython/tree/master/Tutorial Project) directory on 06 May 2020.*
16+
1517
The documentation starts by discussing the available parameters in addition to the steps of using the library. Note that the [PyGAD library](https://pypi.org/project/pygad) is a reflection to the **GeneticAlgorithmPython** GitHub project. As a result, the documentation can either use **project** or **library** interchangeably.
1618

1719
## The Projects in the Series

0 commit comments

Comments
 (0)