Using Qiskit Aqua for partition problems

This Qiskit Aqua Optimization notebook demonstrates how to use the VQE algorithm to compute a balanced partition of a set of numbers. This problem is known as "number partitioning" or simply "partition" in computer science.

The problem is defined as follows. We are given a set of numbers $S$, and we want to determine a partition of $S$ into disjoint sets $S_1, S_2$ such that $|\sum_{a \in S_1} - \sum_{a \in S_2}|$ is minimized.

The list of numbers provided as an input is used first to generate an Ising Hamiltonian, which is then passed as an input to VQE. As a reference, this notebook also computes the maximum stable set using the Exact Eigensolver classical algorithm and the solver embedded in the commercial IBM CPLEX product (if it is available in the system and the user has followed the necessary configuration steps in order for Qiskit Aqua to find it). Please refer to the Qiskit Aqua Optimization documentation for installation and configuration details for CPLEX.


In [1]:
from qiskit_aqua import Operator, run_algorithm, get_algorithm_instance
from qiskit_aqua.input import get_input_instance
from qiskit_aqua.translators.ising import partition
import numpy as np

Here an Operator instance is created for our Hamiltonian. In this case the Paulis are from an Ising Hamiltonian of the number partitioning problem (expressed in minimization form). Rather than minimizing the absolute value of the difference of the sum of numbers into two sets, we minimize the difference square.

We load a small instance of the problem.


In [2]:
number_list = partition.read_numbers_from_file('sample.partition')
qubitOp, offset = partition.get_partition_qubitops(number_list)
algo_input = get_input_instance('EnergyInput')
algo_input.qubit_op = qubitOp
print(number_list)


[ 1  3  4  7 10 13 15 16]

We also offer a function to generate a set of numbers as a input.


In [3]:
if True:
    np.random.seed(8123179)
    number_list = partition.random_number_list(5, weight_range=25)
    qubitOp, offset = partition.get_partition_qubitops(number_list)
    algo_input.qubit_op = qubitOp
    print(number_list)


[ 9  8 23  4  2]

Here we test for the presence of algorithms we want to use in this notebook. If Aqua is installed correctly ExactEigensolver and VQE will always be found. CPLEX.Ising is dependent on IBM CPLEX being installed (see introduction above). CPLEX is not required but if installed then this notebook will demonstrate the CPLEX.Ising algorithm , that uses CPLEX, to compute partition as well.


In [4]:
to_be_tested_algos = ['ExactEigensolver', 'CPLEX.Ising', 'VQE']
operational_algos = []
for algo in to_be_tested_algos:
    try:
        get_algorithm_instance(algo)
        operational_algos.append(algo)
    except:
        print("{} is unavailable and will be skipped.".format(algo))
print(operational_algos)


['ExactEigensolver', 'CPLEX.Ising', 'VQE']

We can now use the Operator without regard to how it was created. First we need to prepare the configuration params to invoke the algorithm. Here we will use the ExactEigensolver first to return the smallest eigenvalue. Backend is not required since this is computed classically not using quantum computation. We then add in the qubitOp Operator in dictionary format. Now the complete params can be passed to the algorithm and run. The result is a dictionary.


In [5]:
if 'ExactEigensolver' not in operational_algos:
    print("ExactEigensolver is not in operational algorithms.")
else:
    algorithm_cfg = {
        'name': 'ExactEigensolver',
    }

    params = {
        'problem': {'name': 'ising'},
        'algorithm': algorithm_cfg
    }
    result = run_algorithm(params,algo_input)
 
    x = partition.sample_most_likely(result['eigvecs'][0])
    print('energy:', result['energy'])
    print('partition objective:', result['energy'] + offset)
    print('solution:', x)
    print('solution objective:', partition.partition_value(x, number_list))


energy: -694.0
partition objective: 0.0
solution: [1. 1. 0. 1. 1.]
solution objective: 0

Note: IBM CPLEX is an optional installation addition for Aqua. If installed then the Aqua CPLEX.Ising algorithm will be able to be used. If not, then solving this problem using this particular algorithm will simply be skipped.

We change the configuration parameters to solve it with the CPLEX backend. The CPLEX backend can deal with a particular type of Hamiltonian called Ising Hamiltonian, which consists of only Pauli Z at most second order and often for combinatorial optimization problems that can be formulated as quadratic unconstrained binary optimization problems, such as the Number Partitioning problem.

Note that for a Number Partitioning problem, since we are computing a bipartition of the set $S$, every binary vector $x$ and its complement (i.e., the vector $y$ such that $y_j = 1 - x_j$ for all $j$) represent exactly the same solution, and will have the same objective function value. Different solution methods may return solutions that look different, but in fact have the same objective function value.


In [6]:
if 'CPLEX.Ising' not in operational_algos:
    print("CPLEX.Ising is not in operational algorithms.")
else:
    algorithm_cfg = {
        'name': 'CPLEX.Ising',
        'display': 0
    }

    params = {
        'problem': {'name': 'ising'},
        'algorithm': algorithm_cfg
    }

    result = run_algorithm(params, algo_input)

    x_dict = result['x_sol']
    print('energy:', result['energy'])
    print('time:', result['eval_time'])
    print('partition objective:', result['energy'] + offset)
    x = np.array([x_dict[i] for i in sorted(x_dict.keys())])
    print('solution:', x)
    print('solution objective:', partition.partition_value(x, number_list))


CPXPARAM_TimeLimit                               600
CPXPARAM_Read_DataCheck                          1
CPXPARAM_Threads                                 1
CPXPARAM_MIP_Tolerances_Integrality              0
CPXPARAM_MIP_Display                             0
energy: -694.0
time: 0.009222549037076533
partition objective: 0.0
solution: [1 1 0 1 1]
solution objective: 0

Now we want VQE and so change it and add its other configuration parameters. VQE also needs and optimizer and variational form. While we can omit them from the dictionary, such that defaults are used, here we specify them explicitly so we can set their parameters as we desire.


In [8]:
if 'VQE' not in operational_algos:
    print("VQE is not in operational algorithms.")
else:
    algorithm_cfg = {
        'name': 'VQE',
        'operator_mode': 'matrix'
    }

    optimizer_cfg = {
        'name': 'L_BFGS_B',
        'maxfun': 6000
    }

    var_form_cfg = {
        'name': 'RYRZ',
        'depth': 3,
        'entanglement': 'linear'
    }

    params = {
        'problem': {'name': 'ising'},
        'algorithm': algorithm_cfg,
        'optimizer': optimizer_cfg,
        'variational_form': var_form_cfg,
        'backend': {'name': 'statevector_simulator'}
    }

    result = run_algorithm(params,algo_input)

    x = partition.sample_most_likely(result['eigvecs'][0])
    print('energy:', result['energy'])
    print('time:', result['eval_time'])
    print('partition objective:', result['energy'] + offset)
    print('solution:', x)
    print('solution objective:', partition.partition_value(x, number_list))


energy: -693.9999999997457
time: 239.3542149066925
partition objective: 2.5431745598325506e-10
solution: [0. 0. 1. 0. 0.]
solution objective: 0

In [ ]: