.. _example_map:

===================
End-to-End Examples
===================

The following pages provide examples with detailed explanations. For examples of
setting parameters, see the code snippets in the :ref:`API <ocean_packages>`
documentation for the relevant function.

The `dwave-examples <https://github.com/dwave-examples>`_ GitHub repo provides
additional examples.

Industrial Optimization
=======================

The :ref:`industrial-optimization documentation <index_industrial_optimization>`
provides the following detailed examples.

.. grid:: 2 2 3 3
    :gutter: 2

    .. grid-item-card:: :ref:`opt_index_examples_beginner`
        :img-top: /_images/rocket_icon.svg
        :link: opt_index_examples_beginner
        :link-type: ref

        Examples to get you started with using hybrid solvers such as the Stride
        solver.

    .. grid-item-card:: :ref:`Advanced Hybrid Examples <opt_index_examples_advanced>`
        :img-top: /_images/optimization_icon.svg
        :link: opt_index_examples_advanced
        :link-type: ref

        Examples to help you formulate models such as nonlinear models for the
        Stride solver and use the returned solutions.

    .. grid-item-card:: :ref:`Stride Performance Benchmarks <opt_index_benchmarks>`
        :img-top: /_images/vignette_icon.svg
        :link: opt_index_benchmarks
        :link-type: ref

        Comparisons of the Stride solver to other solvers.

Quantum Research
================

The :ref:`quantum-research documentation <index_quantum_research>`
provides the following detailed examples.

Quantum Annealing
-----------------

Usage examples for :ref:`quantum-annealing <qpu_quantum_annealing_intro>`
solvers.

.. grid:: 2 2 3 3
    :gutter: 2

    .. grid-item-card:: :ref:`qpu_index_examples_beginner`
        :img-top: /_images/rocket_icon_inv.svg
        :link: qpu_index_examples_beginner
        :link-type: ref

        Beginner examples to get you started with using the quantum computer.

    .. grid-item-card:: :ref:`Advanced QPU Examples <qpu_index_examples_advanced>`
        :img-top: /_images/bipartite_icon.svg
        :link: qpu_index_examples_advanced
        :link-type: ref

        Examples of best practices for using the QPU.

    .. grid-item-card:: :ref:`QPU Performance Benchmarks <qpu_index_benchmarks>`
        :img-top: /_images/vignette_icon_quantum-research.svg
        :link: qpu_index_benchmarks
        :link-type: ref

        Comparison of D-Wave's quantum computers and competing solvers.

Gate Model
----------

Under construction.