https://github.com/moead-framework/framework
MOEA/D is a general-purpose algorithm framework. It decomposes a multi-objective optimization problem into a number of single-objective optimization sub-problems and then uses a search heuristic to optimize these sub-problems simultaneously and cooperatively.
https://github.com/moead-framework/framework
framework modular-framework moea moead multi-objective multi-objective-optimization operations-research pypi python
Last synced: 2 months ago
JSON representation
MOEA/D is a general-purpose algorithm framework. It decomposes a multi-objective optimization problem into a number of single-objective optimization sub-problems and then uses a search heuristic to optimize these sub-problems simultaneously and cooperatively.
- Host: GitHub
- URL: https://github.com/moead-framework/framework
- Owner: moead-framework
- License: gpl-3.0
- Created: 2020-06-06T13:06:49.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2022-10-17T12:18:58.000Z (over 3 years ago)
- Last Synced: 2026-01-08T09:57:22.806Z (2 months ago)
- Topics: framework, modular-framework, moea, moead, multi-objective, multi-objective-optimization, operations-research, pypi, python
- Language: Python
- Homepage: https://moead-framework.github.io/framework/
- Size: 11.2 MB
- Stars: 30
- Watchers: 1
- Forks: 8
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# MOEA/D Framework
[](https://joss.theoj.org/papers/a81ea21d0358e013000b0b3b926bd4ba)
[](https://github.com/moead-framework/framework/actions?query=workflow%3A%22Python+application%22)
[](https://codecov.io/gh/moead-framework/framework)
[](https://pypi.org/project/moead-framework/)
[](https://github.com/moead-framework/framework/blob/master/LICENCE)
[](https://moead-framework.github.io/framework/html/index.html)
This python package *moead-framework* is a modular framework for multi-objective evolutionary algorithms by decomposition.
The goal is to provide a modular framework for scientists and researchers interested in
experimenting with MOEA/D and its numerous variants.
The documentation is available here: [https://moead-framework.github.io/framework/](https://moead-framework.github.io/framework/html/index.html) and can be edited in the folder docs of this repository.
# Installation instructions
Create a virtual environment with [conda](https://docs.conda.io/en/latest/miniconda.html) or [virtualenv](https://packaging.python.org/guides/installing-using-pip-and-virtual-environments/#creating-a-virtual-environment)
The package is available in pypi with a linux environment for python 3.6, 3.7, 3.8 and 3.9, you can install it with:
pip install moead-framework
# Example
The example requires two files :
- ```instance_file``` is required by the [problem](https://moead-framework.github.io/framework/html/moead_framework/moead_framework.problem.combinatorial.rmnk.Rmnk.html#moead_framework.problem.combinatorial.rmnk.Rmnk). The file is available in the framework
in "moead_framework/test/data/instances/" or can be downloaded
from [https://github.com/moead-framework/data/tree/master/problem/RMNK/Instances](https://github.com/moead-framework/data/tree/master/problem/RMNK/Instances)
- ```weight_file``` is required by the [algorithm](https://moead-framework.github.io/framework/html/moead_framework/moead_framework.algorithm.combinatorial.moead.Moead.html#moead_framework.algorithm.combinatorial.moead.Moead). The file is available in the framework
in "moead_framework/test/data/weights/" or can be downloaded
from [https://github.com/moead-framework/data/tree/master/weights](https://github.com/moead-framework/data/tree/master/weights)
```python
from moead_framework.aggregation import Tchebycheff
from moead_framework.algorithm.combinatorial import Moead
from moead_framework.problem.combinatorial import Rmnk
from moead_framework.tool.result import save_population
###############################
# Initialize the problem #
###############################
# The file is available here : https://github.com/moead-framework/data/blob/master/problem/RMNK/Instances/rmnk_0_2_100_1_0.dat
# Others instances are available here : https://github.com/moead-framework/data/tree/master/problem/RMNK/Instances
instance_file = "rmnk_0_2_100_1_0.dat"
rmnk = Rmnk(instance_file=instance_file)
#####################################
# Initialize the algorithm #
#####################################
number_of_weight = 10
number_of_weight_neighborhood = 2
number_of_evaluations = 1000
# The file is available here : https://github.com/moead-framework/data/blob/master/weights/SOBOL-2objs-10wei.ws
# Others weights files are available here : https://github.com/moead-framework/data/tree/master/weights
weight_file = "SOBOL-" + str(rmnk.number_of_objective) + "objs-" + str(number_of_weight) + "wei.ws"
###############################
# Execute the algorithm #
###############################
moead = Moead(problem=rmnk,
max_evaluation=number_of_evaluations,
number_of_weight_neighborhood=number_of_weight_neighborhood,
weight_file=weight_file,
aggregation_function=Tchebycheff,
)
population = moead.run()
###############################
# Save the result #
###############################
save_file = "moead-rmnk" + str(rmnk.number_of_objective) \
+ "-N" + str(number_of_weight) \
+ "-T" + str(number_of_weight_neighborhood) \
+ "-iter" + str(number_of_evaluations) \
+ ".txt"
save_population(save_file, population)
```
# How to contribute
[A guide is available](https://github.com/moead-framework/framework/blob/master/CONTRIBUTING.md) to explain the
process of contributing to the project. The contribution can be the report of a bug, the request for a new feature or
modifying the code of the framework to improve it.
We have [a code of conduct](https://github.com/moead-framework/framework/blob/master/CODE_OF_CONDUCT.md), please follow it in all your interactions with the project.
# Support
If you have any questions about the project, don't hesitate to create a [new discussion](https://github.com/moead-framework/framework/discussions/new)
with [GitHub Discussions](https://github.com/moead-framework/framework/discussions). It is the space for our community to have conversations,
ask questions and post answers without opening issues.
# For developers
## Requirements for developers
These requirements must be installed to use the commands in the following sections (unit test, documentation, package) :
pip install -r requirements.txt
pip install -r requirements-dev.txt
## Tests:
You can execute unit tests with the following command in the git repository:
python3 -m unittest
## Generate the documentation locally
The documentation can be generated locally if you want check changes. The documentation is generated with sphinx 2.4.4 (see the section 'Requirements for developers').
You can generate the documentation with the following commands :
cd docs/
make html
## Build the package
The package is built with a github action. If you want to create manually a new package:
python3 setup.py sdist bdist_wheel
python3 -m twine upload dist/*