Skip to main content

IOHinspector banner


Tests Codacy Badge Codacy Badge PyPI - Version PyPI - Downloads

IOHinspector is a Python package designed for processing, analyzing, and visualizing benchmark data from iterative optimization heuristics (IOHs). Whether you're working with single-objective or multi-objective optimization problems, IOHinspector provides a collection of tools to gain insights into algorithm performance.

IOHinspector is a work-in-progress, and as such some features might be incomplete or have their call signatures changed or expanded when new updates release. As part of the IOHprofiler framework, our aim is to achieve feature parity with the IOHanalyzer web-version. Additionally, this package serves as the basis for large-scale data processing, which is currently unspported on the web version.

Features

  • Data Processing: Efficient import and processing of benchmark data from IOHexperimenter, COCO, Nevergrad and CSV files (with a column mapping). Data is read into one model of four tables (runs, descriptors, trace and positions), which can also be stored as Parquet with iohinspector convert. By utilizing polars and this split, large sets of data can be handled efficiently.
  • Analysis: Perform in-depth analyses of single- and multi-objective optimization results. For the multi-objective scenario, a variety of performance indicators are supported (hypervolume, igd+, R2, epsilon), each with the option to flexibly change reference points/set as required.
  • Visualization: Create informative plots to better understand the optimization process. This included standard fixed-budget and fixed-target plots, EAF and ECDF visualization and more.

Installation

The minamal suported Python version is 3.10. Install IOHinspector via pip:

pip install iohinspector

Basic usage

The basic usage of the framework is through the data manager object. A simple example is given below. This assumes that a folder created via the IOHexperimenter called test_data exists and contains profiling data. This can be generated via the file generate_test_data.py in the tests folder.

import os
from iohinspector import DataManager, plot_ecdf

# Creating a data manager
manager = DataManager()
data_folders = [os.path.join('test_data', x) for x in os.listdir('test_data')]
manager.add_folders(data_folders)

# Loading & selecting data 
selection = manager.select(function_ids=[1], algorithms=['algorithm_A', 'algorithm_B'])
df = selection.load(monotonic=True, include_meta_data=True)

# Creating an ECDF plot, one line per algorithm
plot_ecdf(df, by=["algorithm_name"])

add_folder takes a file, a folder or an archive in any supported format. Your own CSV files work too, with a column mapping: manager.add_folder("results.csv", mapping="mapping.json"); see the CSV example. Every metric and plot groups its results with by, a list of columns: any column of manager.overview, such as algorithm_name, function_id or a descriptor of the runs. Results are polars DataFrames; call .to_pandas() if you prefer pandas.

Upgrading from 0.0.x? See CHANGELOG.md: free_vars is now by, return_as_pandas is gone, and runs are identified by run_id.

ecdf

Tutorials

To highlight the usage of IOHinspector, we have created two tutorials in the form of jupyter notebooks:

License

This project is licensed under a standard BSD-3 clause License. See the LICENSE file for details.

Acknowledgments

This work has been estabilished as a collaboration between:

  • Diederick Vermetten
  • Jeroen Rook
  • Oliver L. Preuß
  • Jacob de Nobel
  • Carola Doerr
  • Manuel López-Ibañez
  • Heike Trautmann
  • Thomas Bäck

Cite us

Citation information coming soon!

Metadata

Release files for iohinspector 0.2.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 iohinspector 0.2.0
File Size Uploaded Provenance Actions
iohinspector-0.2.0.tar.gz 148.7 kB With provenance Details for iohinspector-0.2.0.tar.gz

Built distribution (wheel)

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

Total release size: 314.6 kB

Release files / iohinspector-0.2.0.tar.gz

Download URL iohinspector-0.2.0.tar.gz
Size 148.7 kB
Tags Source
SHA-256 checksum
How to use checksums
ddc4fcf39a4cc650b385ead1ad7a76ec492f36178879d107a8910e615d5bbb57
BLAKE2b-256 checksum
How to use checksums
4ce10f19f0aa1f6a74c0f47ad1fd0f91a6549ec0728fd73f069bdf882d68f2cf
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.16

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.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Nov 12, 2026.

Transparency log

Release files / iohinspector-0.2.0-py3-none-any.whl

Download URL iohinspector-0.2.0-py3-none-any.whl
Size 165.9 kB
Tags Python 3
SHA-256 checksum
How to use checksums
1002e7105da94d44458be1467f74def6faadf5623469adea9d903c1adbf29348
BLAKE2b-256 checksum
How to use checksums
b69bd460795b867a02e485cf2b1fed5f433d99ff39211977ff467690b24623b0
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.16

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.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Nov 12, 2026.

Transparency log

Security for iohinspector 0.2.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.

Full provenance

Both files in this release have been uploaded with provenance metadata.

Select from 2 files

Attestation for iohinspector-0.2.0.tar.gz

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Nov 12, 2026.

Transparency log

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