Skip to content

Commit

Permalink
SAIS v0.1.0 released
Browse files Browse the repository at this point in the history
  • Loading branch information
acse-js3623 committed Apr 17, 2024
1 parent bf678bb commit a750efb
Show file tree
Hide file tree
Showing 8 changed files with 778 additions and 5 deletions.
33 changes: 33 additions & 0 deletions .github/workflows/docstring_test.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
name: docstring_test

on:
# Trigger the workflow on push or pull request,
# but only for the master branch
push:
branches:
- master
pull_request:
branches:
- master

jobs:
docstring-test:
name: Run Docstring Tests
runs-on: ubuntu-latest

steps:
- name: Checkout acsefuncitons
uses: actions/checkout@v2

- name: Set up Python 3.10
uses: actions/setup-python@v1
with:
python-version: "3.10"

- name: Install dependencies
run: pip install -r requirements.txt

- name: Run docstring tests
run: |
python -m doctest -v sais/benchmarks.py
python -m doctest -v sais/symbiotic_ais.py
33 changes: 33 additions & 0 deletions .github/workflows/flake8.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
name: flake8

on:
# Trigger the workflow on push or pull request,
# but only for the master branch
push:
branches:
- master
pull_request:
branches:
- master

jobs:
flake8:

runs-on: ubuntu-latest

steps:
- uses: actions/checkout@v2

- name: Set up Python 3.10
uses: actions/setup-python@v1
with:
python-version: "3.10"

- name: Install dependencies
run: |
pip install --upgrade pip
pip install flake8
- name: Lint with flake8
run: |
flake8 .
30 changes: 30 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,36 @@ cd SymbioticAIS
pip install -r requirements.txt
```

## Benchmarks List
```
### Benchmarks
# F1 = Beale [-4.5; 4.5]; 0
# F2 = Easom [-100,100]; -1
# F3 = Matyas [-10,10]; 0
# F4 = Bochachvesky 1 [-100,100]; 0
# F5 = Booth [-10, 10]; 0
# F6 = Michalewicz 2[0,pi]; -1.8013
# F7 = Schaffer [-100; 100]; 0
# F8 = Six Hump Camel Back [-5; 5]; -1.03163
# F9 = Bochachvesky 2 [-100,100]; 0
# F10 = Bochachvesky 3 [-100,100]; 0
# F11 = Shubert [-10,10]; -186.73
# F12 = Colville [-10,10]; 0
# F13 = Michalewicz 5 [0,pi]; -4.6877
# F14 = Zakharov[-5,10]; 0
# F15 = Michalewicz 10 [0,pi]; -4.6877
# F16 = Step [-5.12; 5.12]; 0
# F17 = Sphere [-100,100]; 0
# F18 = SumSquares [-10, 10]; 0
# F19 = Quartic [-1.28,1.28]; 0
# F20 = Schwefel 2.22 [-10,10]; 0
# F21 = Schwefel 1.2 [-10,10]; 0
# F22 = Rosenbrock [-30,30]; 0
# F23 = Dixon-Price [-10, 10]; 0
# F24 = Rastrigin [-5.12; 5.12];
# F25 = Griewank [-600,600]; 0
# F26 = Ackley [-600; 600]; 0
```
## Contact
For any questions or suggestions, please contact us via:
- Email
Expand Down
5 changes: 1 addition & 4 deletions requirements.txt
Original file line number Diff line number Diff line change
@@ -1,4 +1 @@
numpy
matplotlib
flake8
pytest
numpy>=1.23.5
6 changes: 6 additions & 0 deletions sais/__init__.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
# import public functionalities from the SAIS package modules
from .symbiotic_ais import run
from .benchmarks import benchmark_result

# define the public interface of the package
__all__ = ['run', 'benchmark_result']
Loading

0 comments on commit a750efb

Please sign in to comment.