<reponame>Zoufalc/qiskit-machine-learning<filename>test/algorithms/regressors/test_vqr.py
# This code is part of Qiskit.
#
# (C) Copyright IBM 2018, 2021.
#
# This code is licensed under the Apache License, Version 2.0. You may
# obtain a copy of this license in the LICENSE.txt file in the root directory
# of this source tree or at http://www.apache.org/licenses/LICENSE-2.0.
#
# Any modifications or derivative works of this code must retain this
# copyright notice, and modified files need to carry a notice indicating
# that they have been altered from the originals.

""" Test Neural Network Regressor """

import unittest
from test import QiskitMachineLearningTestCase

import numpy as np
from ddt import data, ddt

from qiskit import Aer, QuantumCircuit
from qiskit.algorithms.optimizers import COBYLA, L_BFGS_B
from qiskit.circuit import Parameter
from qiskit.utils import QuantumInstance
from qiskit_machine_learning.algorithms import VQR


@ddt
class TestVQR(QiskitMachineLearningTestCase):
    """VQR Tests."""

    def setUp(self):
        super().setUp()

        # specify quantum instances
        self.random_seed = 12345
        self.sv_quantum_instance = QuantumInstance(Aer.get_backend('statevector_simulator'),
                                                   seed_simulator=self.random_seed,
                                                   seed_transpiler=self.random_seed)
        self.qasm_quantum_instance = QuantumInstance(Aer.get_backend('qasm_simulator'), shots=100,
                                                     seed_simulator=self.random_seed,
                                                     seed_transpiler=self.random_seed)
        np.random.seed(self.random_seed)

        num_samples = 20
        eps = 0.2

        # pylint: disable=invalid-name
        lb, ub = -np.pi, np.pi
        self.X = (ub - lb) * np.random.rand(num_samples, 1) + lb
        self.y = np.sin(self.X[:, 0]) + eps * (2 * np.random.rand(num_samples) - 1)

    @data(
        # optimizer, loss, quantum instance
        ('cobyla', 'statevector', True),
        ('cobyla', 'qasm', True),

        ('bfgs', 'statevector', True),
        ('bfgs', 'qasm', True),

        ('cobyla', 'statevector', False),
        ('cobyla', 'qasm', False),

        ('bfgs', 'statevector', False),
        ('bfgs', 'qasm', False),
    )
    def test_vqr(self, config):
        """ Test VQR."""

        opt, q_i, has_ansatz = config

        if q_i == 'statevector':
            quantum_instance = self.sv_quantum_instance
        else:
            quantum_instance = self.qasm_quantum_instance

        if opt == 'bfgs':
            optimizer = L_BFGS_B(maxiter=5)
        else:
            optimizer = COBYLA(maxiter=25)

        num_qubits = 1
        # construct simple feature map
        param_x = Parameter('x')
        feature_map = QuantumCircuit(num_qubits, name='fm')
        feature_map.ry(param_x, 0)

        if has_ansatz:
            param_y = Parameter('y')
            ansatz = QuantumCircuit(num_qubits, name='vf')
            ansatz.ry(param_y, 0)
        else:
            ansatz = None

        # construct regressor
        regressor = VQR(feature_map=feature_map,
                        ansatz=ansatz,
                        optimizer=optimizer,
                        quantum_instance=quantum_instance)

        # fit to data
        regressor.fit(self.X, self.y)

        # score
        score = regressor.score(self.X, self.y)
        self.assertGreater(score, 0.5)


if __name__ == '__main__':
    unittest.main()

# This code is part of Qiskit.
#
# (C) Copyright IBM 2018, 2021.
#
# This code is licensed under the Apache License, Version 2.0. You may
# obtain a copy of this license in the LICENSE.txt file in the root directory
# of this source tree or at http://www.apache.org/licenses/LICENSE-2.0.
#
# Any modifications or derivative works of this code must retain this
# copyright notice, and modified files need to carry a notice indicating
# that they have been altered from the originals.

""" Test Neural Network Regressor """

import unittest
from test import QiskitMachineLearningTestCase

import numpy as np
from ddt import data, ddt

from qiskit import Aer, QuantumCircuit
from qiskit.algorithms.optimizers import COBYLA, L_BFGS_B
from qiskit.circuit import Parameter
from qiskit.utils import QuantumInstance
from qiskit_machine_learning.algorithms import VQR


@ddt
class TestVQR(QiskitMachineLearningTestCase):
    """VQR Tests."""

    def setUp(self):
        super().setUp()

        # specify quantum instances
        self.random_seed = 12345
        self.sv_quantum_instance = QuantumInstance(Aer.get_backend('statevector_simulator'),
                                                   seed_simulator=self.random_seed,
                                                   seed_transpiler=self.random_seed)
        self.qasm_quantum_instance = QuantumInstance(Aer.get_backend('qasm_simulator'), shots=100,
                                                     seed_simulator=self.random_seed,
                                                     seed_transpiler=self.random_seed)
        np.random.seed(self.random_seed)

        num_samples = 20
        eps = 0.2

        # pylint: disable=invalid-name
        lb, ub = -np.pi, np.pi
        self.X = (ub - lb) * np.random.rand(num_samples, 1) + lb
        self.y = np.sin(self.X[:, 0]) + eps * (2 * np.random.rand(num_samples) - 1)

    @data(
        # optimizer, loss, quantum instance
        ('cobyla', 'statevector', True),
        ('cobyla', 'qasm', True),

        ('bfgs', 'statevector', True),
        ('bfgs', 'qasm', True),

        ('cobyla', 'statevector', False),
        ('cobyla', 'qasm', False),

        ('bfgs', 'statevector', False),
        ('bfgs', 'qasm', False),
    )
    def test_vqr(self, config):
        """ Test VQR."""

        opt, q_i, has_ansatz = config

        if q_i == 'statevector':
            quantum_instance = self.sv_quantum_instance
        else:
            quantum_instance = self.qasm_quantum_instance

        if opt == 'bfgs':
            optimizer = L_BFGS_B(maxiter=5)
        else:
            optimizer = COBYLA(maxiter=25)

        num_qubits = 1
        # construct simple feature map
        param_x = Parameter('x')
        feature_map = QuantumCircuit(num_qubits, name='fm')
        feature_map.ry(param_x, 0)

        if has_ansatz:
            param_y = Parameter('y')
            ansatz = QuantumCircuit(num_qubits, name='vf')
            ansatz.ry(param_y, 0)
        else:
            ansatz = None

        # construct regressor
        regressor = VQR(feature_map=feature_map,
                        ansatz=ansatz,
                        optimizer=optimizer,
                        quantum_instance=quantum_instance)

        # fit to data
        regressor.fit(self.X, self.y)

        # score
        score = regressor.score(self.X, self.y)
        self.assertGreater(score, 0.5)


if __name__ == '__main__':
    unittest.main()
# This code is part of Qiskit. # # (C) Copyright IBM 2018, 2021. # # This code is licensed under the Apache License, Version 2.0. You may # obtain a copy of this license in the LICENSE.txt file in the root directory # of this source tree or at http://www.apache.org/licenses/LICENSE-2.0. # # Any modifications or derivative works of this code must retain this # copyright notice, and modified files need to carry a notice indicating # that they have been altered from the originals. Test Neural Network Regressor VQR Tests. # specify quantum instances # pylint: disable=invalid-name # optimizer, loss, quantum instance Test VQR. # construct simple feature map # construct regressor # fit to data # score