Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

couple of cosmetic fixes to docs #128

Merged
merged 1 commit into from
Nov 11, 2022
Merged

couple of cosmetic fixes to docs #128

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
64 changes: 37 additions & 27 deletions docs/source/backends.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,9 +1,16 @@
Abstract Backends
Base Backends and Device
=================================
.. .. autoclass:: openqaoa.basebackend.QuantumCircuitBase
.. :members:
.. :undoc-members:
.. :inherited-members:

BaseDevice
----------

.. autoclass:: openqaoa.devices.DeviceBase
:members:
:undoc-members:
:inherited-members:

BaseBackends
------------

.. autoclass:: openqaoa.basebackend.VQABaseBackend
:members:
Expand Down Expand Up @@ -36,58 +43,61 @@ Abstract Backends
:inherited-members:


Cloud Devices

Cloud Backends and Devices
=================================
QCS - Rigetti
----------------------------------
.. autoclass:: openqaoa.backends.qpus.qaoa_pyquil_qpu.QAOAPyQuilQPUBackend
:members:
:undoc-members:
:inherited-members:

IBM Quantum - IBM
----------------------------------
.. autoclass:: openqaoa.backends.qpus.qaoa_qiskit_qpu.QAOAQiskitQPUBackend
Cloud Devices
-------------

.. autoclass:: openqaoa.devices.DeviceQiskit
:members:
:undoc-members:
:inherited-members:

Amazon Braket - Amazon
----------------------------------
.. autoclass:: openqaoa.backends.qpus.qaoa_braket_qpu.QAOAAWSQPUBackend
.. autoclass:: openqaoa.devices.DevicePyquil
:members:
:undoc-members:
:inherited-members:

Devices
-------
.. autoclass:: openqaoa.devices.DeviceBase
.. autoclass:: openqaoa.devices.DeviceAWS
:members:
:undoc-members:
:inherited-members:

.. autoclass:: openqaoa.devices.DeviceLocal
QCS - Rigetti
-------------
.. autoclass:: openqaoa.backends.qpus.qaoa_pyquil_qpu.QAOAPyQuilQPUBackend
:members:
:undoc-members:
:inherited-members:

.. autoclass:: openqaoa.devices.DeviceQiskit
IBM Quantum - IBM
-----------------
.. autoclass:: openqaoa.backends.qpus.qaoa_qiskit_qpu.QAOAQiskitQPUBackend
:members:
:undoc-members:
:inherited-members:

.. autoclass:: openqaoa.devices.DevicePyquil
Amazon Braket - Amazon
----------------------
.. autoclass:: openqaoa.backends.qpus.qaoa_braket_qpu.QAOAAWSQPUBackend
:members:
:undoc-members:
:inherited-members:

.. autoclass:: openqaoa.devices.DeviceAWS

Local Backend and Devices --- Simulators
========================================

Local Device
------------

.. autoclass:: openqaoa.devices.DeviceLocal
:members:
:undoc-members:
:inherited-members:

Local devices --- Simulators
=================================
Vectorised
----------------------------------
.. autoclass:: openqaoa.backends.simulators.qaoa_vectorized.QAOAvectorizedBackendSimulator
Expand Down
10 changes: 2 additions & 8 deletions docs/source/workflows.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,11 +39,8 @@ Workflow QAOA Parameters
:inherited-members:




Recursive QAOA
===============

RQAOA
-----
Recursive QAOA (RQAOA) is an iterative variant of QAOA, first introduced by Bravyi et. al in [1]. It runs QAOA recursively and uses the expectation values of the Hamiltonian terms to impose constraints and eliminate qubits for the problem at each step. Once the reduced problem reaches a preset cutoff size, it is solved exactly solved via classical methods. The final answer is then reconstructed by re-inserting the eliminated qubits in the classical solution in the appropriate order.

We currently offer two flavors of RQAOA, both of which can be found in the ``rqaoa`` module:
Expand All @@ -56,9 +53,6 @@ The development of this method is associated with an internal research project a

To choose the strategy, set the parameter ``rqaoa_type`` using the `set_rqaoa_parameters` method. To use the ``Adaptive`` strategy, pass ``rqaoa_type = 'adaptive'``. The default strategy is ``Custom``.


RQAOA
-----
.. autoclass:: openqaoa.workflows.optimizer.RQAOA
:members:
:undoc-members:
Expand Down