10000 Update README.md · imjoy/GeneticAlgorithmPython@e9717f0 · GitHub
[go: up one dir, main page]

Skip to content

Commit e9717f0

Browse files
authored
Update README.md
1 parent bec8b70 commit e9717f0

File tree

1 file changed

+13
-1
lines changed

1 file changed

+13
-1
lines changed

README.md

Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
# GeneticAlgorithmPython
22

3-
**GeneticAlgorithmPython** is an open source Python project for implementing the genetic algorithm based on NumPy. 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:
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.
4+
5+
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:
46

57
```python
68
pip install pygad
@@ -12,6 +14,16 @@ Simply, to run the genetic algorithm all you need to do is to create an instance
1214

1315
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.
1416

17+
## The Projects in the Series
18+
19+
The 3 projects in the series of building and training neural networks using the genetic algorithm are as follows:
20+
21+
1. [GeneticAlgorithmPython](https://github.com/ahmedfgad/GeneticAlgorithmPython): Implements the genetic algorithm.
22+
2. [NumPyANN](https://github.com/ahmedfgad/NumPyANN): Implements neural networks without being trained (i.e. only the forward pass).
23+
3. [NeuralGenetic](https://github.com/ahmedfgad/NeuralGenetic/): Trains neural networks implemented in [NumPyANN](https://github.com/ahmedfgad/NumPyANN) using the genetic algorithm implemented in [GeneticAlgorithmPython](https://github.com/ahmedfgad/GeneticAlgorithmPython).
24+
25+
Feel free to leave an issue in this project (https://github.com/ahmedfgad/GeneticAlgorithmPython) in case something is not working properly or to ask for questions. I am also available for e-mails at ahmed.f.gad@gmail.com
26+
1527
## Supported Parameters
1628

1729
The single module available in the `PyGAD` library is named `pygad.py` and contains a class named `GA`. For creating an instance of this class, there are a number of parameters that allows the user to customize the genetic algorithm. Before running the GA, the parameters must be prepared. The list of all supported parameters is as follows:

0 commit comments

Comments
 (0)
0