ommx_quantum_benchmarks.qoblib

ommx_quantum_benchmarks.qoblib#

OMMX Quantum Benchmarks - QOBLIB dataset collection.

Submodules#

Classes#

BaseDataset

Base class for datasets.

Marketsplit

Class representing a market split dataset.

Labs

Class representing a labs dataset.

Birkhoff

Class representing a Birkhoff dataset.

Steiner

Class representing a Steiner dataset.

Sports

Class representing a Sports dataset.

Portfolio

Class representing a Portfolio dataset.

IndependentSet

Class representing an Independent Set dataset.

Network

Class representing a Network dataset.

Routing

Class representing a Routing dataset.

Topology

Class representing a Topology dataset.

Package Contents#

class BaseDataset#

Bases: abc.ABC

Base class for datasets.

name: str#
description: str#
model_names: list[str] = []#
available_instances: dict[str, list[str]]#
__post_init__() → None#

Assert the member variables.

get_instance_url(model_name: str, instance_name: str) → str#

Get the URL of the instance data specified by the given model and instance names.

Parameters:

  • model_name (str) – a model name.

  • instance_name (str) – an instance name.

Raises:

ValueError – if the given model name is not valid.

Returns:

the URL of the instance data.

Return type:

str

get_experiment(model_name: str, instance_name: str) → minto.Experiment#

Get OMMX data for a specific dataset from the Github Packages.

Parameters:

  • model_name (str) – The name of the model.

  • instance_name (str) – The name of the instance.

Returns:

The Minto experiment containing OMMX data.

Return type:

minto.Experiment

__call__(model_name: str, instance_name: str) → tuple[ommx.v1.Instance, ommx.v1.Solution]#

Get the OMMX instance and solution for a specific Labs dataset.

Parameters:

  • instance_name (str) – The name of the instance.

  • model (str) – The model to use.

Returns:

The OMMX instance and solution.

Return type:

tuple[ommx.v1.Instance, ommx.v1.Solution]

class Marketsplit#

Bases: BaseDataset

Class representing a market split dataset.

name: str = '01_marketsplit'#
description: str = 'Marketsplit dataset in ommx format, originally provided by...#
model_names: list[str] = ['binary_linear', 'binary_unconstrained']#
available_instances: dict[str, list[str]]#
class Labs#

Bases: BaseDataset

Class representing a labs dataset.

name: str = '02_labs'#
description: str = 'Labs dataset in ommx format, originally provided by...#
model_names: list[str] = ['integer', 'quadratic_unconstrained']#
available_instances: Final[dict[str, list[str]]]#
class Birkhoff#

Bases: BaseDataset

Class representing a Birkhoff dataset.

name: str = '03_birkhoff'#
description: str = 'Birkhoff dataset in ommx format, originally provided by...#
model_names: list[str] = ['integer_linear']#
available_instances: Final[dict[str, list[str]]]#
class Steiner#

Bases: BaseDataset

Class representing a Steiner dataset.

name: str = '04_steiner'#
description: str = 'Steiner dataset in ommx format, originally provided by...#
model_names: list[str] = ['integer_linear']#
available_instances: Final[dict[str, list[str]]]#
class Sports#

Bases: BaseDataset

Class representing a Sports dataset.

name: str = '05_sports'#
description: str = 'Sports dataset in ommx format, originally provided by...#
model_names: list[str] = ['mixed_integer_linear']#
available_instances: dict[str, list[str]]#
class Portfolio#

Bases: BaseDataset

Class representing a Portfolio dataset.

name: str = '06_portfolio'#
description: str = 'Portfolio dataset in ommx format, originally provided by...#
model_names: list[str] = ['binary_quadratic_programming', 'unconstrained_quadratic_optimization']#
available_instances: dict[str, list[str]]#
class IndependentSet#

Bases: BaseDataset

Class representing an Independent Set dataset.

name: str = '07_independentset'#
description: str = 'Independent Set dataset in ommx format, originally provided by...#
model_names: list[str] = ['binary_linear', 'binary_unconstrained']#
available_instances: dict[str, list[str]]#
class Network#

Bases: BaseDataset

Class representing a Network dataset.

name: str = '08_network'#
description: str = 'Network dataset in ommx format, originally provided by...#
model_names: list[str] = ['integer_lp']#
available_instances: dict[str, list[str]]#
class Routing#

Bases: BaseDataset

Class representing a Routing dataset.

name: str = '09_routing'#
description: str = 'Routing dataset in ommx format, originally provided by...#
model_names: list[str] = ['integer_linear']#
available_instances: dict[str, list[str]]#
class Topology#

Bases: BaseDataset

Class representing a Topology dataset.

name: str = '10_topology'#
description: str = 'Topology dataset in ommx format, originally provided by...#
model_names: list[str] = ['flow_mip', 'seidel_linear', 'seidel_quadratic']#
available_instances: Final[dict[str, list[str]]]#
Contents