Skip to main content

jMetalPy

Lint Test Build Docs Python Version PyPI Version DOI PyPI License

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

Agents

If you use AI assistants (e.g., Copilot, Codex) while working on this project, please follow the guidelines in AGENTS.md.

Features

The current release of jMetalPy (v1.10.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, MOCell. 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-7, WFG1-9, ZCAT1-20, eqDTLZ, FDA, LZ09, UF (CEC'09), LIR-CMOP, RWA, RE, a multi-objective TSP, unconstrained (Kursawe, Fonseca, Schaffer, Viennet2, and the CONV/DENT/SYM-PART/SSW/TWO-ON-ONE/OMNI-TEST family in misc.py), constrained (Srinivas, Tanaka, Osyczka2, Binh2).
  • Encodings: real, integer, binary, permutations.
  • Operators: selection (binary tournament, ranking and crowding distance, random, nary random, best solution), crossover (single-point, SBX, PMX, CX, BLX-Alpha, BLX-Alpha-Beta, arithmetic, UNDX, differential evolution), mutation (bit-flip, polynomial, uniform, random, non-uniform, Levy flight, power-law).
  • Quality indicators: hypervolume, normalized hypervolume, additive epsilon, GD, IGD, IGD+, average Hausdorff distance.
  • 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

See CHANGELOG.md.

License

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

Metadata

Release files for jmetalpy 1.10.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.10.0
File Size Uploaded Provenance Actions
jmetalpy-1.10.0.tar.gz 194.6 kB Without provenance Details for jmetalpy-1.10.0.tar.gz

Built distribution (wheel)

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

Total release size: 434.8 kB

Release files / jmetalpy-1.10.0.tar.gz

Download URL jmetalpy-1.10.0.tar.gz
Size 194.6 kB
Tags Source
SHA-256 checksum
How to use checksums
00d4abcf3df6d00ffd323385bea624d93cf9b15bf9a1f01efbf4752309700242
BLAKE2b-256 checksum
How to use checksums
827b54f37bf7d2b97184c6756f3e813b189dd88b984093f596a2897692c1641c
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.12.13

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

Download URL jmetalpy-1.10.0-py3-none-any.whl
Size 240.2 kB
Tags Python 3
SHA-256 checksum
How to use checksums
8023d22038de8aa3e3b410e9e14d5fefa4d43c6c7b7d0048425a6df6627ecf76
BLAKE2b-256 checksum
How to use checksums
14fc923c0a35a84df77d80b6e919d10f6ccdfabee2673741c14fc680c3aa74e9
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.12.13

Security for jmetalpy 1.10.0

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

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