OpenQAOA Core API Reference

OpenQAOA Core API

• Workflows
  • Workflow - ABC
    • Workflow
  • Workflow Properties
    • BackendProperties
    • ClassicalOptimizer
    • CircuitProperties
  • QAOA
    • QAOA
    • RQAOA
  • RQAOA Workflow Properties
    • RqaoaParameters
  • References
• Recursive QAOA functions
  • ada_max_terms()
  • final_solution()
  • find_parent()
  • max_terms()
  • problem_from_dict()
  • redefine_problem()
  • solution_for_vanishing_instances()
  • spin_mapping()
• Problems
  • Problem
    • Problem.problem_instance
    • Problem.random_instance()
  • QUBO
    • QUBO.TERMS_CLEANING_LIMIT
    • QUBO.asdict()
    • QUBO.clean_terms_and_weights()
    • QUBO.convert_qubo_to_ising()
    • QUBO.from_dict()
    • QUBO.hamiltonian
    • QUBO.n
    • QUBO.random_instance()
    • QUBO.set_metadata()
  • Built-in problems
    • TSP
    • NumberPartition
    • MaximumCut
    • Knapsack
    • SlackFreeKnapsack
    • MinimumVertexCover
    • ShortestPath
  • Utils and Converters
    • create_problem_from_dict()
    • FromDocplex2IsingModel
• QAOA Parametrisations
  • Parameters
    • AnsatzDescriptor
  • Standard Parameters
    • QAOAVariationalStandardParams
    • QAOAVariationalStandardWithBiasParams
  • Extended Parameters
    • QAOAVariationalExtendedParams
  • Fourier Parameters
    • QAOAVariationalFourierParams
    • QAOAVariationalFourierWithBiasParams
    • QAOAVariationalFourierExtendedParams
  • Annealing Parameters
    • QAOAVariationalAnnealingParams
• Base Backends and Device
  • BaseDevice
    • DeviceBase
  • BaseBackends
    • VQABaseBackend
    • QAOABaseBackend
    • QAOABaseBackendStatevector
    • QAOABaseBackendShotBased
    • QAOABaseBackendCloud
    • QAOABaseBackendParametric
• Local Backend and Devices — Simulators
  • Local Device
    • DeviceLocal
  • Vectorized
    • QAOAvectorizedBackendSimulator
  • Analytical Simulator
    • QAOABackendAnalyticalSimulator
• Backend selector method
  • device_to_backend_mapper()
  • get_qaoa_backend()
• QAOA Result
  • QAOAResult
    • QAOAResult.asdict()
    • QAOAResult.calculate_statistics()
    • QAOAResult.from_dict()
    • QAOAResult.get_counts()
    • QAOAResult.lowest_cost_bitstrings()
    • QAOAResult.plot_cost()
    • QAOAResult.plot_n_shots()
    • QAOAResult.plot_probabilities()
• RQAOA Result
  • RQAOAResult
    • RQAOAResult.asdict()
    • RQAOAResult.clear()
    • RQAOAResult.copy()
    • RQAOAResult.from_dict()
    • RQAOAResult.fromkeys()
    • RQAOAResult.get()
    • RQAOAResult.get_corr_matrix()
    • RQAOAResult.get_exp_vals_z()
    • RQAOAResult.get_hamiltonian()
    • RQAOAResult.get_problem()
    • RQAOAResult.get_qaoa_optimized_angles()
    • RQAOAResult.get_qaoa_results()
    • RQAOAResult.get_solution()
    • RQAOAResult.items()
    • RQAOAResult.keys()
    • RQAOAResult.plot_corr_matrix()
    • RQAOAResult.pop()
    • RQAOAResult.popitem()
    • RQAOAResult.setdefault()
    • RQAOAResult.update()
    • RQAOAResult.values()
• Logger
  • Logger
    • Logger.log_variables()
    • Logger.root_nodes
    • Logger.update_edges
• Optimisers
  • OptimizeVQA
    • OptimizeVQA.optimize()
    • OptimizeVQA.optimize_this()
    • OptimizeVQA.results_dictionary()
  • SciPy Optimizers
    • ScipyOptimizer
    • CustomScipyGradientOptimizer
    • PennyLaneOptimizer
  • Optimization Methods
    • pennylane_optimizer()
  • Derivate functions
    • derivative()
    • grad_fd()
    • grad_ps()
    • grad_spsa()
    • hessian_fd()
    • update_and_compute_expectation()
    • update_and_get_counts()
  • QFIM
    • log_qfim_evals()
    • qfim()
  • Optimizers selectors
    • available_optimizers()
    • get_optimizer()
• Utilities
  • XY_mixer_hamiltonian()
  • X_mixer_hamiltonian()
  • bitstring_energy()
  • calculate_calibration_factors()
  • check_kwargs()
  • convert2serialize()
  • delete_keys_from_dict()
  • dicke_basis()
  • dicke_wavefunction()
  • energy_expectation()
  • energy_expectation_analytical()
  • energy_spectrum_hamiltonian()
  • exp_val_hamiltonian_termwise()
  • exp_val_pair()
  • exp_val_pair_analytical()
  • exp_val_single()
  • exp_val_single_analytical()
  • flip_counts()
  • generate_timestamp()
  • generate_uuid()
  • get_mixer_hamiltonian()
  • graph_from_hamiltonian()
  • ground_state_hamiltonian()
  • hamiltonian_from_graph()
  • is_valid_uuid()
  • k_cumulative_excitations()
  • knapsack_balanced_basis()
  • low_energy_states()
  • low_energy_states_overlap()
  • negate_counts_dictionary()
  • permute_counts_dictionary()
  • plot_energy_spectrum()
  • plot_graph()
  • qaoa_probabilities()
  • quick_create_mixer_for_topology()
  • random_classical_hamiltonian()
  • random_k_regular_graph()
  • ring_of_disagrees()
  • round_value()