Skip to main content

jMetalPy

CI Python Version PyPI Version DOI PyPI License Code style: black

A paper introducing jMetalPy is available at: https://doi.org/10.1016/j.swevo.2019.100598

Table of Contents

Installation

You can install the latest version of jMetalPy with pip,

pip install jmetalpy  # or "jmetalpy[distributed]"
Notes on installing with pip

jMetalPy includes features for parallel and distributed computing based on pySpark and Dask.

These (extra) dependencies are not automatically installed when running pip, which only comprises the core functionality of the framework (enough for most users):

pip install jmetalpy

This is the equivalent of running:

pip install "jmetalpy[core]"

Other supported commands are listed next:

pip install "jmetalpy[dev]"  # Install requirements for development
pip install "jmetalpy[distributed]"  # Install requirements for parallel/distributed computing
pip install "jmetalpy[complete]"  # Install all requirements

Hello, world! 👋

Examples of configuring and running all the included algorithms are located in the documentation.

from jmetal.algorithm.multiobjective import NSGAII
from jmetal.operator.crossover import SBXCrossover
from jmetal.operator.mutation import PolynomialMutation
from jmetal.problem import ZDT1
from jmetal.util.termination_criterion import StoppingByEvaluations

problem = ZDT1()

algorithm = NSGAII(
    problem=problem,
    population_size=100,
    offspring_population_size=100,
    mutation=PolynomialMutation(probability=1.0 / problem.number_of_variables(), distribution_index=20),
    crossover=SBXCrossover(probability=1.0, distribution_index=20),
    termination_criterion=StoppingByEvaluations(max_evaluations=25000)
)

algorithm.run()

We can then proceed to explore the results:

from jmetal.util.solution import get_non_dominated_solutions, print_function_values_to_file, print_variables_to_file

front = get_non_dominated_solutions(algorithm.result())

# save to files
print_function_values_to_file(front, 'FUN.NSGAII.ZDT1')
print_variables_to_file(front, 'VAR.NSGAII.ZDT1')

Or visualize the Pareto front approximation produced by the algorithm:

from jmetal.lab.visualization import Plot

plot_front = Plot(title='Pareto front approximation', axis_labels=['x', 'y'])
plot_front.plot(front, label='NSGAII-ZDT1', filename='NSGAII-ZDT1', format='png')
Pareto front approximation

Features

The current release of jMetalPy (v1.9.0) contains the following components:

  • Algorithms: local search, genetic algorithm, evolution strategy, simulated annealing, random search, NSGA-II, NSGA-III, SMPSO, OMOPSO, MOEA/D, SMS-EMOA, MOEA/D-DRA, MOEA/D-IEpsilon, GDE3, SPEA2, HYPE, IBEA. Preference articulation-based algorithms (G-NSGA-II, G-GDE3, G-SPEA2, SMPSO/RP); Dynamic versions of NSGA-II, SMPSO, and GDE3.
  • Parallel computing based on Apache Spark and Dask.
  • Benchmark problems: ZDT1-6, DTLZ1-2, FDA, LZ09, LIR-CMOP, RWA, RE, unconstrained (Kursawe, Fonseca, Schaffer, Viennet2), constrained (Srinivas, Tanaka).
  • Encodings: real, integer, binary, permutations.
  • Operators: selection (binary tournament, ranking and crowding distance, random, nary random, best solution), crossover (single-point, SBX), mutation (bit-blip, polynomial, uniform, random).
  • Quality indicators: hypervolume, additive epsilon, GD, IGD, IGD+.
  • Pareto front approximation plotting in real-time, static or interactive.
  • Experiment class for performing studies either alone or alongside jMetal.
  • Pairwise and multiple hypothesis testing for statistical analysis, including several frequentist and Bayesian testing methods, critical distance plots and posterior diagrams.
Scatter plot 2D Scatter plot 3D
Parallel coordinates Interactive chord plot

Changelog

  • [1.9.0]
    • Add RE benchmark
    • Refactor algorithm SPEA2
    • Refactor classes Solution, BinarySolution, and FloatSolution
    • Added Unimodal Normal Distribution Crossover (UNDX), BLX-Alpha, BLX-Alpha-Beta and Arithmetic crossover operators.
    • Added Levy flight and power-law mutation operators.
  • [v.1.8.0]
  • [v1.7.0] Add RWA benchmark, refactor classes BinarySolution and BinaryProblem.
  • [v1.6.0] Refactor class Problem, the single-objective genetic algorithm can solve constrained problems, performance improvements in NSGA-II, generation of Latex tables summarizing the results of the Wilcoxon rank sum test, added a notebook folder with examples.
  • [v1.5.7] Use of linters for catching errors and formatters to fix style, minor bug fixes.
  • [v1.5.6] Removed warnings when using Python 3.8.
  • [v1.5.5] Minor bug fixes.
  • [v1.5.4] Refactored quality indicators to accept numpy array as input parameter.
  • [v1.5.4] Added CompositeSolution class to support mixed combinatorial problems. #69

License

This project is licensed under the terms of the MIT - see the LICENSE file for details.

Release files for jmetalpy 1.9.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for jmetalpy 1.9.0
File Size Uploaded
jmetalpy-1.9.0.tar.gz 136.3 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for jmetalpy 1.9.0
File Interpreter ABI Platform
jmetalpy-1.9.0-py3-none-any.whl Python 3 none any Details

Total release size: 308.0 kB

Release files / jmetalpy-1.9.0.tar.gz

Download URL jmetalpy-1.9.0.tar.gz
Size 136.3 kB
Tags Source
SHA-256 checksum
How to use checksums
34a38b502f76edc783f79b99687cf01946136c54260914590c8a25a8f4df2fb6
BLAKE2b-256 checksum
How to use checksums
d91db100280039d2799992b92514d0e2d10d7571548337405af0f5c2c7b50c6f
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via python-httpx/0.28.1

Release files / jmetalpy-1.9.0-py3-none-any.whl

Download URL jmetalpy-1.9.0-py3-none-any.whl
Size 171.7 kB
Tags Python 3
SHA-256 checksum
How to use checksums
ae8d9463d5b32d2f1ca36d17be12de9e8224f49f4acf07e884fa28a9af95bc55
BLAKE2b-256 checksum
How to use checksums
f27493e0625a5fbe8c087a64ab9fe950721b61b7b38befa1672d632553631712
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via python-httpx/0.28.1

Release history Release notifications | RSS feed

This release

1.9.0 This release

2 release files

1.8.0

2 release files

1.7.0

2 release files

1.6.0

2 release files

1.5.5

1 release file

1.5.4

2 release files

1.5.3

2 release files

1.5.2

1 release file

1.5.1

1 release file

1.5.0

2 release files

0.9.0

3 release files

0.5.1

2 release files

0.2

1 release file

0.1

1 release file

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page