https://github.com/pratikpakhale/meta-heuristic-optimization-engine

https://github.com/pratikpakhale/meta-heuristic-optimization-engine

Last synced: about 1 month ago
JSON representation

• Host: GitHub
• URL: https://github.com/pratikpakhale/meta-heuristic-optimization-engine
• Owner: pratikpakhale
• License: mit
• Created: 2024-09-28T17:54:20.000Z (3 months ago)
• Default Branch: main
• Last Pushed: 2024-11-12T19:22:39.000Z (about 1 month ago)
• Last Synced: 2024-11-12T19:26:47.439Z (about 1 month ago)
• Language: Python
• Size: 4.83 MB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# SELO + NPO

## Install

```bash

git clone https://github.com/pratikpakhale/selo-npo

cd selo-npo

python3 -m venv venv

source venv/bin/activate

pip install -r requirements.txt

```

## Run

```bash

python3 main.py

```

This should run the algorithms from `main.py` and generate the logs of the run in the `logs` directory.

## Check Logs

The logs are stored in the `logs` directory. The entry file is `results.csv`. Each entry has timestamp, metrics and filename of the log file of each run.

## Modify

### Change Algorithm of Optimization Engine

To change the algorithm, modify the main function to call the desired algorithm. The algorithms are defined in the `algorithms` directory.

### Change/Add Algorithm

To add a new algorithm, create a new folder in the `algorithms` directory with the name of the algorithm. The folder should contain the following files: `hyperparameters.json` and `__init__.py`. The `hyperparameters.json` file should contain the hyperparameters for the algorithm. The `__init__.py` file should contain the function (imported from another file is also fine, just the function must be available here).




Then import that function in `algorithms/__init__.py` file.

### Update Benchmark Functions

To update the benchmark functions, modify the `benchmark_functions.py` file. The functions should be defined in the same format as the existing functions.