Merge pull request #306 from ahmedfgad/github-actions

GitHub actions
ahmedfgad · Dec 10, 2024 · 1b52346 · 1b52346
2 parents 9910cbd + a9d09b4
commit 1b52346
Show file tree

Hide file tree

Showing 8 changed files with 41 additions and 6 deletions.
diff --git a/.github/workflows/main_py310.yml b/.github/workflows/main_py310.yml
@@ -20,6 +20,11 @@ jobs:
         with:
           python-version: '3.10' 
 
+      - name: Install Dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install -r requirements.txt
+
       - name: Build PyGAD from the Repository
         run: |
           python3 -m pip install --upgrade build

diff --git a/.github/workflows/main_py311.yml b/.github/workflows/main_py311.yml
@@ -20,6 +20,11 @@ jobs:
         with:
           python-version: '3.11' 
 
+      - name: Install Dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install -r requirements.txt
+
       - name: Build PyGAD from the Repository
         run: |
           python3 -m pip install --upgrade build

diff --git a/.github/workflows/main_py312.yml b/.github/workflows/main_py312.yml
@@ -28,6 +28,11 @@ jobs:
         with:
           python-version: '3.12.0-beta.2' 
 
+      - name: Install Dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install -r requirements.txt
+
       - name: Build PyGAD from the Repository
         run: |
           python3 -m pip install --upgrade build

diff --git a/.github/workflows/main_py37.yml b/.github/workflows/main_py37.yml
@@ -20,6 +20,11 @@ jobs:
         with:
           python-version: '3.7'
 
+      - name: Install Dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install -r requirements.txt
+
       - name: Build PyGAD from the Repository
         run: |
           python3 -m pip install --upgrade build

diff --git a/.github/workflows/main_py38.yml b/.github/workflows/main_py38.yml
@@ -20,6 +20,11 @@ jobs:
         with:
           python-version: '3.8'
 
+      - name: Install Dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install -r requirements.txt
+
       - name: Build PyGAD from the Repository
         run: |
           python3 -m pip install --upgrade build

diff --git a/.github/workflows/main_py39.yml b/.github/workflows/main_py39.yml
@@ -20,6 +20,11 @@ jobs:
         with:
           python-version: '3.9'
 
+      - name: Install Dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install -r requirements.txt
+
       - name: Build PyGAD from the Repository
         run: |
           python3 -m pip install --upgrade build

diff --git a/README.md b/README.md
@@ -4,7 +4,8 @@
 
 Check documentation of the [PyGAD](https://pygad.readthedocs.io/en/latest).
 
-[![Downloads](https://pepy.tech/badge/pygad)](https://pepy.tech/project/pygad) [![PyPI version](https://badge.fury.io/py/pygad.svg)](https://badge.fury.io/py/pygad) ![Docs](https://readthedocs.org/projects/pygad/badge) [![PyGAD PyTest / Python 3.11](https://github.com/ahmedfgad/GeneticAlgorithmPython/actions/workflows/main_py311.yml/badge.svg)](https://github.com/ahmedfgad/GeneticAlgorithmPython/actions/workflows/main_py311.yml) [![PyGAD PyTest / Python 3.10](https://github.com/ahmedfgad/GeneticAlgorithmPython/actions/workflows/main_py310.yml/badge.svg)](https://github.com/ahmedfgad/GeneticAlgorithmPython/actions/workflows/main_py310.yml) [![PyGAD PyTest / Python 3.9](https://github.com/ahmedfgad/GeneticAlgorithmPython/actions/workflows/main_py39.yml/badge.svg)](https://github.com/ahmedfgad/GeneticAlgorithmPython/actions/workflows/main_py39.yml) [![PyGAD PyTest / Python 3.8](https://github.com/ahmedfgad/GeneticAlgorithmPython/actions/workflows/main_py38.yml/badge.svg)](https://github.com/ahmedfgad/GeneticAlgorithmPython/actions/workflows/main_py38.yml) [![PyGAD PyTest / Python 3.7](https://github.com/ahmedfgad/GeneticAlgorithmPython/actions/workflows/main_py37.yml/badge.svg)](https://github.com/ahmedfgad/GeneticAlgorithmPython/actions/workflows/main_py37.yml) [![License](https://img.shields.io/badge/License-BSD_3--Clause-blue.svg)](https://opensource.org/licenses/BSD-3-Clause) [![Translation](https://hosted.weblate.org/widgets/weblate/-/svg-badge.svg)](https://hosted.weblate.org/engage/weblate/) [![REUSE](https://api.reuse.software/badge/github.com/WeblateOrg/weblate)](https://api.reuse.software/info/github.com/WeblateOrg/weblate)
+[![Downloads](https://pepy.tech/badge/pygad)](https://pepy.tech/project/pygad) [![PyPI version](https://badge.fury.io/py/pygad.svg)](https://badge.fury.io/py/pygad) ![Docs](https://readthedocs.org/projects/pygad/badge) [![PyGAD PyTest / Python 3.11](https://github.com/ahmedfgad/GeneticAlgorithmPython/actions/workflows/main_py311.yml/badge.svg)](https://github.com/ahmedfgad/GeneticAlgorithmPython/actions/workflows/main_py311.yml) [![PyGAD PyTest / Python 3.10](https://github.com/ahmedfgad/GeneticAlgorithmPython/actions/workflows/main_py310.yml/badge.svg)](https://github.com/ahmedfgad/GeneticAlgorithmPython/actions/workflows/main_py310.yml) [![PyGAD PyTest / Python 3.9](https://github.com/ahmedfgad/GeneticAlgorithmPython/actions/workflows/main_py39.yml/badge.svg)](https://github.com/ahmedfgad/GeneticAlgorithmPython/actions/workflows/main_py39.yml) [![PyGAD PyTest / Python 3.8](https://github.com/ahmedfgad/GeneticAlgorithmPython/actions/workflows/main_py38.yml/badge.svg)](https://github.com/ahmedfgad/GeneticAlgorithmPython/actions/workflows/main_py38.yml) [![PyGAD PyTest / Python 3.7](https://github.com/ahmedfgad/GeneticAlgorithmPython/actions/workflows/main_py37.yml/badge.svg)](https://github.com/ahmedfgad/GeneticAlgorithmPython/actions/workflows/main_py37.yml) [![License](https://img.shields.io/badge/License-BSD_3--Clause-blue.svg)](https://opensource.org/licenses/BSD-3-Clause) [![Translation](https://hosted.weblate.org/widgets/weblate/-/svg-badge.svg)](https://hosted.weblate.org/engage/weblate/) [![REUSE](https://api.reuse.software/badge/github.com/WeblateOrg/weblate)](https://api.reuse.software/info/github.com/WeblateOrg/weblate)[![Stack Overflow](https://img.shields.io/badge/stackoverflow-Ask%20questions-blue.svg)](
+https://stackoverflow.com/questions/tagged/pygad)[![OpenSSF Scorecard](https://api.securityscorecards.dev/projects/github.com/ahmedfgad/GeneticAlgorithmPython/badge)](https://securityscorecards.dev/viewer/?uri=github.com/ahmedfgad/GeneticAlgorithmPython)
 
 ![PYGAD-LOGO](https://user-images.githubusercontent.com/16560492/101267295-c74c0180-375f-11eb-9ad0-f8e37bd796ce.png)
 

diff --git a/pygad/utils/crossover.py b/pygad/utils/crossover.py
@@ -13,11 +13,15 @@ def __init__():
     def single_point_crossover(self, parents, offspring_size):
 
         """
-        Applies the single-point crossover. It selects a point randomly at which crossover takes place between the pairs of parents.
-        It accepts 2 parameters:
-            -parents: The parents to mate for producing the offspring.
-            -offspring_size: The size of the offspring to produce.
-        It returns an array the produced offspring.
+        Applies single-point crossover between pairs of parents.
+        This function selects a random point at which crossover occurs between the parents, generating offspring.
+
+        Parameters:
+            parents (array-like): The parents to mate for producing the offspring.
+            offspring_size (int): The number of offspring to produce.
+
+        Returns:
+            array-like: An array containing the produced offspring.
         """
 
         if self.gene_type_single == True: