Skip to content

Commit

Permalink
Deploying to gh-pages from @ b880eb0 🚀
Browse files Browse the repository at this point in the history
  • Loading branch information
woodsp-ibm committed Feb 14, 2024
1 parent e6d712c commit f742321
Show file tree
Hide file tree
Showing 37 changed files with 1,268 additions and 1,289 deletions.
2 changes: 1 addition & 1 deletion .buildinfo
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Sphinx build info version 1
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
config: 9819ffc6e12194ec337e2a6db159e35c
config: 29ed7a05517d7dde50ab7eb968f02f45
tags: 645f666f9bcd5a90fca523b33c5a78b7
Binary file modified _images/tutorials_06_examples_max_cut_and_tsp_16_1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified _images/tutorials_06_examples_max_cut_and_tsp_19_1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified _images/tutorials_06_examples_max_cut_and_tsp_20_1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified _images/tutorials_06_examples_max_cut_and_tsp_5_0.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified _images/tutorials_06_examples_max_cut_and_tsp_8_1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
16 changes: 6 additions & 10 deletions _sources/getting_started.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,9 @@ Getting started
Installation
============

Qiskit Optimization depends Qiskit. which has its own
`Qiskit Getting Started <https://qiskit.org/documentation/getting_started.html>`__ detailing the
installation options and its supported environments/platforms. You should refer to
Qiskit Optimization depends on Qiskit, which has its own
`installation instructions <https://docs.quantum.ibm.com/start/install>`__ detailing the
installation options for Qiskit and its supported environments/platforms. You should refer to
that first. Then the information here can be followed which focuses on the additional installation
specific to Qiskit Optimization.

Expand All @@ -21,13 +21,9 @@ See :ref:`optional_installs` for more information.

.. tab-item:: Start locally

The simplest way to get started is to first follow the `getting started 'Start locally' guide for
Qiskit <https://qiskit.org/documentation/getting_started.html>`__
The simplest way to get started is to follow the `Qiskit installation instructions <https://docs.quantum.ibm.com/start/install>`__

In your virtual environment where you installed Qiskit simply add ``optimization`` to the
extra list in a similar manner to how the extra ``visualization`` support is installed for
Qiskit, i.e:
In your virtual environment, where you installed Qiskit, install Qiskit Optimization as follows:
In your virtual environment where you installed Qiskit, also install ``qiskit-optimization``:

.. code:: sh
Expand All @@ -48,7 +44,7 @@ See :ref:`optional_installs` for more information.

Since Qiskit Optimization depends on Qiskit, and its latest changes may require new or changed
features of Qiskit, you should first follow Qiskit's `"Install from source"` instructions
here `Qiskit Getting Started <https://qiskit.org/documentation/getting_started.html>`__
`here <https://docs.quantum.ibm.com/start/install-qiskit-source>`__

.. raw:: html

Expand Down
4 changes: 2 additions & 2 deletions _sources/migration/01_migration_guide_to_v0.5.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ Overview

Qiskit Terra v0.22 introduces new algorithm implementations that
leverage `Qiskit
Primitives <https://qiskit.org/documentation/apidoc/primitives.html>`__
Primitives <https://docs.quantum.ibm.com/api/qiskit/primitives>`__
(Estimator and Sampler). The former algorithm implementations that
leverage opflow will be deprecated in the future release.

Expand All @@ -19,7 +19,7 @@ of Qiskit Terra v0.22 until the former algorithms are deprecated.
It is not the intention to provide detailed explanations of the
primitives in this migration guide. We suggest that you read the
`corresponding
resources <https://qiskit.org/documentation/apidoc/primitives.html>`__
resources <https://docs.quantum.ibm.com/api/qiskit/primitives>`__
of the Qiskit Terra documentation instead.

We use ``qiskit.primitives.Sampler`` in this guide as an example of
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@
"To begin, we utilize the `Maxcut` class from Qiskit Optimization's application module. It allows us to generate a `QuadraticProgram` representation of the given graph.\n",
"\n",
"Note that once our problem has been represented as a `QuadraticProgram`, it will need to be converted to the correct type, a [quadratic unconstrained binary optimization (QUBO)](https://en.wikipedia.org/wiki/Quadratic_unconstrained_binary_optimization) problem, so that it is compatible with QRAO.\n",
"A `QuadraticProgram` generated by `Maxcut` is already a QUBO, but if you define your own problem be sure you convert it to a QUBO before proceeding. Here is [a tutorial](https://qiskit.org/documentation/optimization/tutorials/02_converters_for_quadratic_programs.html) on converting `QuadraticPrograms`."
"A `QuadraticProgram` generated by `Maxcut` is already a QUBO, but if you define your own problem be sure you convert it to a QUBO before proceeding. Here is [a tutorial](https://qiskit-community.github.io/qiskit-optimization/tutorials/02_converters_for_quadratic_programs.html) on converting `QuadraticPrograms`."
]
},
{
Expand Down Expand Up @@ -113,7 +113,7 @@
"\n",
"Once we have appropriately configured our problem, we proceed to encode it using the `QuantumRandomAccessEncoding` class from the `qrao` module. This encoding step allows us to generate a quantum Hamiltonian operator that represents our problem. In particular, we employ a Quantum Random Access Code (QRAC) to encode multiple classical binary variables (corresponding to the nodes of our max-cut graph) into each qubit.\n",
"\n",
"It's important to note that the resulting \"relaxed\" Hamiltonian, produced by this encoding, will not be diagonal. This differs from the standard workflow in `qiskit-optimization`, which typically generates a diagonal (Ising) Hamiltonian suitable for optimization using a `MinimumEigenOptimizer`. You can find a tutorial on the `MinimumEigenOptimizer` [here](https://qiskit.org/documentation/optimization/tutorials/03_minimum_eigen_optimizer.html).\n",
"It's important to note that the resulting \"relaxed\" Hamiltonian, produced by this encoding, will not be diagonal. This differs from the standard workflow in `qiskit-optimization`, which typically generates a diagonal (Ising) Hamiltonian suitable for optimization using a `MinimumEigenOptimizer`. You can find a tutorial on the `MinimumEigenOptimizer` [here](https://qiskit-community.github.io/qiskit-optimization/tutorials/03_minimum_eigen_optimizer.html).\n",
"\n",
"In our encoding process, we employ a $(3,1,p)-$QRAC, where each qubit can accommodate a maximum of 3 classical binary variables. The parameter $p$ represents the bit recovery probability achieved through measurement. Depending on the nature of the problem, some qubits may have fewer than 3 classical variables assigned to them. To evaluate the compression achieved, we can examine the `compression_ratio` attribute of the encoding, which provides the ratio between the number of original binary variables and the number of qubits used (at best, a factor of 3)."
]
Expand Down Expand Up @@ -552,7 +552,7 @@
"\n",
"By invoking `qrao.solve_relaxed()`, we obtain two essential outputs:\n",
"\n",
"- `MinimumEigensolverResult`: This object contains the results of running the minimum eigen optimizer such as the VQE on the relaxed problem. It provides information about the eigenvalue, and other relevant details. You can refer to the Qiskit Algorithms [documentation](https://qiskit.org/documentation/stubs/qiskit.algorithms.MinimumEigensolverResult.html) for a comprehensive explanation of the entries within this object.\n",
"- `MinimumEigensolverResult`: This object contains the results of running the minimum eigen optimizer such as the VQE on the relaxed problem. It provides information about the eigenvalue, and other relevant details. You can refer to the Qiskit Algorithms [documentation](https://docs.quantum.ibm.com/api/qiskit/qiskit.algorithms.MinimumEigensolverResult) for a comprehensive explanation of the entries within this object.\n",
"- `RoundingContext`: This object encapsulates essential information about the encoding and the solution of the relaxed problem in a form that is ready for consumption by the rounding schemes."
]
},
Expand Down
16 changes: 6 additions & 10 deletions getting_started.html
Original file line number Diff line number Diff line change
Expand Up @@ -432,9 +432,9 @@
<h1>Getting started<a class="headerlink" href="#getting-started" title="Permalink to this heading">#</a></h1>
<section id="installation">
<h2>Installation<a class="headerlink" href="#installation" title="Permalink to this heading">#</a></h2>
<p>Qiskit Optimization depends Qiskit. which has its own
<a class="reference external" href="https://qiskit.org/documentation/getting_started.html">Qiskit Getting Started</a> detailing the
installation options and its supported environments/platforms. You should refer to
<p>Qiskit Optimization depends on Qiskit, which has its own
<a class="reference external" href="https://docs.quantum.ibm.com/start/install">installation instructions</a> detailing the
installation options for Qiskit and its supported environments/platforms. You should refer to
that first. Then the information here can be followed which focuses on the additional installation
specific to Qiskit Optimization.</p>
<p>Qiskit Optimization has some functions that have been made optional where the dependent code and/or
Expand All @@ -444,12 +444,8 @@ <h2>Installation<a class="headerlink" href="#installation" title="Permalink to t
<input checked="checked" id="sd-tab-item-0" name="sd-tab-set-0" type="radio">
</input><label class="sd-tab-label" for="sd-tab-item-0">
Start locally</label><div class="sd-tab-content docutils">
<p>The simplest way to get started is to first follow the <a class="reference external" href="https://qiskit.org/documentation/getting_started.html">getting started ‘Start locally’ guide for
Qiskit</a></p>
<p>In your virtual environment where you installed Qiskit simply add <code class="docutils literal notranslate"><span class="pre">optimization</span></code> to the
extra list in a similar manner to how the extra <code class="docutils literal notranslate"><span class="pre">visualization</span></code> support is installed for
Qiskit, i.e:
In your virtual environment, where you installed Qiskit, install Qiskit Optimization as follows:</p>
<p>The simplest way to get started is to follow the <a class="reference external" href="https://docs.quantum.ibm.com/start/install">Qiskit installation instructions</a></p>
<p>In your virtual environment where you installed Qiskit, also install <code class="docutils literal notranslate"><span class="pre">qiskit-optimization</span></code>:</p>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>pip<span class="w"> </span>install<span class="w"> </span>qiskit-optimization
</pre></div>
</div>
Expand All @@ -469,7 +465,7 @@ <h2>Installation<a class="headerlink" href="#installation" title="Permalink to t
the latest version of the Qiskit Optimization code more efficiently.</p>
<p>Since Qiskit Optimization depends on Qiskit, and its latest changes may require new or changed
features of Qiskit, you should first follow Qiskit’s <cite>“Install from source”</cite> instructions
here <a class="reference external" href="https://qiskit.org/documentation/getting_started.html">Qiskit Getting Started</a></p>
<a class="reference external" href="https://docs.quantum.ibm.com/start/install-qiskit-source">here</a></p>
<h2>Installing Qiskit Optimization from Source</h2><p>Using the same development environment that you installed Qiskit in you are ready to install
Qiskit Optimization.</p>
<ol class="arabic">
Expand Down
4 changes: 2 additions & 2 deletions migration/01_migration_guide_to_v0.5.html
Original file line number Diff line number Diff line change
Expand Up @@ -435,15 +435,15 @@ <h1>Qiskit Optimization v0.5 Migration Guide<a class="headerlink" href="#qiskit-
<section id="overview">
<h2>Overview<a class="headerlink" href="#overview" title="Permalink to this heading">#</a></h2>
<p>Qiskit Terra v0.22 introduces new algorithm implementations that
leverage <a class="reference external" href="https://qiskit.org/documentation/apidoc/primitives.html">Qiskit
leverage <a class="reference external" href="https://docs.quantum.ibm.com/api/qiskit/primitives">Qiskit
Primitives</a>
(Estimator and Sampler). The former algorithm implementations that
leverage opflow will be deprecated in the future release.</p>
<p>Qiskit Optimization v0.5 supports both the new and the former algorithms
of Qiskit Terra v0.22 until the former algorithms are deprecated.</p>
<p>It is not the intention to provide detailed explanations of the
primitives in this migration guide. We suggest that you read the
<a class="reference external" href="https://qiskit.org/documentation/apidoc/primitives.html">corresponding
<a class="reference external" href="https://docs.quantum.ibm.com/api/qiskit/primitives">corresponding
resources</a>
of the Qiskit Terra documentation instead.</p>
<p>We use <code class="docutils literal notranslate"><span class="pre">qiskit.primitives.Sampler</span></code> in this guide as an example of
Expand Down
2 changes: 1 addition & 1 deletion searchindex.js

Large diffs are not rendered by default.

6 changes: 3 additions & 3 deletions tutorials/01_quadratic_program.html
Original file line number Diff line number Diff line change
Expand Up @@ -1068,15 +1068,15 @@ <h2>Substituting Variables<a class="headerlink" href="#Substituting-Variables" t
</div>
<div class="output_area stderr docutils container">
<div class="highlight"><pre>
/tmp/ipykernel_2278/1492642725.py:1: DeprecationWarning: qiskit.tools.jupyter is deprecated and will be removed in Qiskit 1.0.0
/tmp/ipykernel_2289/1492642725.py:1: DeprecationWarning: qiskit.tools.jupyter is deprecated and will be removed in Qiskit 1.0.0
import qiskit.tools.jupyter
</pre></div></div>
</div>
<div class="nboutput docutils container">
<div class="prompt empty docutils container">
</div>
<div class="output_area rendered_html docutils container">
<h3>Version Information</h3><table><tr><th>Software</th><th>Version</th></tr><tr><td><code>qiskit</code></td><td>0.46.0</td></tr><tr><td><code>qiskit_optimization</code></td><td>0.6.0</td></tr><tr><th colspan='2'>System information</th></tr><tr><td>Python version</td><td>3.8.18</td></tr><tr><td>Python compiler</td><td>GCC 11.4.0</td></tr><tr><td>Python build</td><td>default, Aug 28 2023 08:27:22</td></tr><tr><td>OS</td><td>Linux</td></tr><tr><td>CPUs</td><td>2</td></tr><tr><td>Memory (Gb)</td><td>15.60690689086914</td></tr><tr><td colspan='2'>Fri Feb 09 16:51:30 2024 UTC</td></tr></table></div>
<h3>Version Information</h3><table><tr><th>Software</th><th>Version</th></tr><tr><td><code>qiskit</code></td><td>0.46.0</td></tr><tr><td><code>qiskit_optimization</code></td><td>0.6.0</td></tr><tr><th colspan='2'>System information</th></tr><tr><td>Python version</td><td>3.8.18</td></tr><tr><td>Python compiler</td><td>GCC 11.4.0</td></tr><tr><td>Python build</td><td>default, Aug 28 2023 08:27:22</td></tr><tr><td>OS</td><td>Linux</td></tr><tr><td>CPUs</td><td>2</td></tr><tr><td>Memory (Gb)</td><td>15.60690689086914</td></tr><tr><td colspan='2'>Wed Feb 14 16:06:22 2024 UTC</td></tr></table></div>
</div>
<div class="nboutput nblast docutils container">
<div class="prompt empty docutils container">
Expand All @@ -1093,7 +1093,7 @@ <h3>Version Information</h3><table><tr><th>Software</th><th>Version</th></tr><tr
</div>
</div>
<script type="application/vnd.jupyter.widget-state+json">
{"state": {"61b45c7c88b5400bbec491d93e4283dc": {"model_name": "LayoutModel", "model_module": "@jupyter-widgets/base", "model_module_version": "2.0.0", "state": {"_model_module": "@jupyter-widgets/base", "_model_module_version": "2.0.0", "_model_name": "LayoutModel", "_view_count": null, "_view_module": "@jupyter-widgets/base", "_view_module_version": "2.0.0", "_view_name": "LayoutView", "align_content": null, "align_items": null, "align_self": null, "border_bottom": null, "border_left": null, "border_right": null, "border_top": null, "bottom": null, "display": null, "flex": null, "flex_flow": null, "grid_area": null, "grid_auto_columns": null, "grid_auto_flow": null, "grid_auto_rows": null, "grid_column": null, "grid_gap": null, "grid_row": null, "grid_template_areas": null, "grid_template_columns": null, "grid_template_rows": null, "height": null, "justify_content": null, "justify_items": null, "left": null, "margin": "0px 0px 10px 0px", "max_height": null, "max_width": null, "min_height": null, "min_width": null, "object_fit": null, "object_position": null, "order": null, "overflow": null, "padding": null, "right": null, "top": null, "visibility": null, "width": null}}, "c3690c648a4647c68e5b0d8795b02643": {"model_name": "HTMLStyleModel", "model_module": "@jupyter-widgets/controls", "model_module_version": "2.0.0", "state": {"_model_module": "@jupyter-widgets/controls", "_model_module_version": "2.0.0", "_model_name": "HTMLStyleModel", "_view_count": null, "_view_module": "@jupyter-widgets/base", "_view_module_version": "2.0.0", "_view_name": "StyleView", "background": null, "description_width": "", "font_size": null, "text_color": null}}, "0106149443b148e88e2769f7046fbbd9": {"model_name": "HTMLModel", "model_module": "@jupyter-widgets/controls", "model_module_version": "2.0.0", "state": {"_dom_classes": [], "_model_module": "@jupyter-widgets/controls", "_model_module_version": "2.0.0", "_model_name": "HTMLModel", "_view_count": null, "_view_module": "@jupyter-widgets/controls", "_view_module_version": "2.0.0", "_view_name": "HTMLView", "description": "", "description_allow_html": false, "layout": "IPY_MODEL_61b45c7c88b5400bbec491d93e4283dc", "placeholder": "\u200b", "style": "IPY_MODEL_c3690c648a4647c68e5b0d8795b02643", "tabbable": null, "tooltip": null, "value": "<p style='font-family: IBM Plex Sans, Arial, Helvetica, sans-serif; font-size: 20px; font-weight: medium;'>Circuit Properties</p>"}}}, "version_major": 2, "version_minor": 0}
{"state": {"c2efcc7a599941bca2ec19bd6080e900": {"model_name": "LayoutModel", "model_module": "@jupyter-widgets/base", "model_module_version": "2.0.0", "state": {"_model_module": "@jupyter-widgets/base", "_model_module_version": "2.0.0", "_model_name": "LayoutModel", "_view_count": null, "_view_module": "@jupyter-widgets/base", "_view_module_version": "2.0.0", "_view_name": "LayoutView", "align_content": null, "align_items": null, "align_self": null, "border_bottom": null, "border_left": null, "border_right": null, "border_top": null, "bottom": null, "display": null, "flex": null, "flex_flow": null, "grid_area": null, "grid_auto_columns": null, "grid_auto_flow": null, "grid_auto_rows": null, "grid_column": null, "grid_gap": null, "grid_row": null, "grid_template_areas": null, "grid_template_columns": null, "grid_template_rows": null, "height": null, "justify_content": null, "justify_items": null, "left": null, "margin": "0px 0px 10px 0px", "max_height": null, "max_width": null, "min_height": null, "min_width": null, "object_fit": null, "object_position": null, "order": null, "overflow": null, "padding": null, "right": null, "top": null, "visibility": null, "width": null}}, "bd3e7fdda08b44cf91bb9dc2ccfd6824": {"model_name": "HTMLStyleModel", "model_module": "@jupyter-widgets/controls", "model_module_version": "2.0.0", "state": {"_model_module": "@jupyter-widgets/controls", "_model_module_version": "2.0.0", "_model_name": "HTMLStyleModel", "_view_count": null, "_view_module": "@jupyter-widgets/base", "_view_module_version": "2.0.0", "_view_name": "StyleView", "background": null, "description_width": "", "font_size": null, "text_color": null}}, "234623a278c341fb99459bf1b5702184": {"model_name": "HTMLModel", "model_module": "@jupyter-widgets/controls", "model_module_version": "2.0.0", "state": {"_dom_classes": [], "_model_module": "@jupyter-widgets/controls", "_model_module_version": "2.0.0", "_model_name": "HTMLModel", "_view_count": null, "_view_module": "@jupyter-widgets/controls", "_view_module_version": "2.0.0", "_view_name": "HTMLView", "description": "", "description_allow_html": false, "layout": "IPY_MODEL_c2efcc7a599941bca2ec19bd6080e900", "placeholder": "\u200b", "style": "IPY_MODEL_bd3e7fdda08b44cf91bb9dc2ccfd6824", "tabbable": null, "tooltip": null, "value": "<p style='font-family: IBM Plex Sans, Arial, Helvetica, sans-serif; font-size: 20px; font-weight: medium;'>Circuit Properties</p>"}}}, "version_major": 2, "version_minor": 0}
</script></section>
</section>

Expand Down
Loading

0 comments on commit f742321

Please sign in to comment.