Optimisation modules built for optimization problem during thesis

Jérôme BUISINE 287df287e2 update math syntax on paper 3 years ago
.github 6612bb6381 github ci push event for pypi updated 3 years ago
docs 287df287e2 update math syntax on paper 3 years ago
examples 8adb876ae9 update macop paper for JOSS 3 years ago
macop 287df287e2 update math syntax on paper 3 years ago
.gitignore feb1e4263c enable solutions dynamic imports using python package 3 years ago
CONTRIBUTING.md 287df287e2 update math syntax on paper 3 years ago
LICENSE 3589fb944b Initial commit 4 years ago
README.md 287df287e2 update math syntax on paper 3 years ago
__init__.py 0a1b108095 First version of OR framework 4 years ago
build.sh 389c2124c7 add test when building package 3 years ago
logo_macop.png df8251b5ac new package name : macop; use of new policy for operators 3 years ago
paper.bib 0e743faba7 Prepare to major version 3 years ago
paper.md 287df287e2 update math syntax on paper 3 years ago
requirements.txt 4fbbbf39d3 documentation updates for algorithms 3 years ago
setup.py 287df287e2 update math syntax on paper 3 years ago

README.md

Minimalist And Customisable Optimisation Package

Description

macop is an optimisation Python package which not implement the whole available algorithms in the literature but let you the possibility to quickly develop and test your own algorithm and strategies. The main objective of this package is to be the most flexible as possible and hence, to offer a maximum of implementation possibilities.

Modules

  • algorithms: generic and implemented OR algorithms
  • evaluator: example of an evaluation function to use (you have to implement your own evaluation function)
  • solutions: solutions used to represent problem data
  • operators: mutators, crossovers update of solution. This folder also has policies folder to manage the way of update and use solution.
  • callbacks: callbacks folder where Callback class is available for making callback instructions every number of evaluations.

Note: you can pass a custom validator function to the algorithm in order to check if a solution is always correct for your needs after an update.

How to use ?

Fully documentation of package with examples is available.

You can also see examples of use:

Add as dependency

git submodule add https://github.com/jbuisine/macop.git

License

The MIT License