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

Uploading to the website

Create a personal upload token on the website's account page, then:

export IOH_TOKEN=ioh_...        # or pass --token
iohinspector upload my_experiment/ --title "My experiment" --tag budget=1000

The data is converted and verified locally first, and nothing is sent when verification fails (--no-check skips this). The original files are then sent in chunks (a folder is zipped to my_experiment.zip first), and the server converts them again. If the upload is interrupted, run the same command to continue. The website is https://coaxium.liacs.nl unless --url or IOH_URL says otherwise.

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.1

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.1
File Size Uploaded Provenance Actions
iohinspector-0.2.1.tar.gz 155.1 kB With provenance Details for iohinspector-0.2.1.tar.gz

Built distribution (wheel)

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

Total release size: 325.4 kB

Release files / iohinspector-0.2.1.tar.gz

Download URL iohinspector-0.2.1.tar.gz
Size 155.1 kB
Tags Source
SHA-256 checksum
How to use checksums
89851ed625b4e56252a6b75993ac05f1c05cf6402eeff466acba8469accce2a1
BLAKE2b-256 checksum
How to use checksums
7f85d77e08fc6351753d7e84ddba400737f675753816788f9b3409cff5bdc029
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 13, 2026.

Transparency log

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

Download URL iohinspector-0.2.1-py3-none-any.whl
Size 170.2 kB
Tags Python 3
SHA-256 checksum
How to use checksums
57c20c0a8eb5c82ade9a064ea8eb7e353d2beb78eaec6dd8ee721b48a40be592
BLAKE2b-256 checksum
How to use checksums
66b8634c5cacfccdaaa0ff615da175c10c2518d730d17c985712f9771b37fe8e
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 13, 2026.

Transparency log

Security for iohinspector 0.2.1

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.1.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 13, 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