Skip to content

Commit 2312220

Browse files
committed
Deploying to gh-pages from @ 59a4bf9 🚀
1 parent f1c4d19 commit 2312220

File tree

63 files changed

+1632
-1311
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

63 files changed

+1632
-1311
lines changed

.buildinfo

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
# Sphinx build info version 1
22
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
3-
config: a24491ae6015d5dcc4e2ba7c9b006e91
3+
config: 7c74910c02476fcddefacab4e321669e
44
tags: 645f666f9bcd5a90fca523b33c5a78b7
-91 Bytes
Loading
Loading
-66 Bytes
Loading
-86 Bytes
Loading
26 Bytes
Loading

_modules/qiskit_finance/circuit/library/payoff_functions/european_call_pricing_objective.html

+2-2
Original file line numberDiff line numberDiff line change
@@ -359,7 +359,7 @@
359359
<h1>Source code for qiskit_finance.circuit.library.payoff_functions.european_call_pricing_objective</h1><div class="highlight"><pre>
360360
<span></span><span class="c1"># This code is part of a Qiskit project.</span>
361361
<span class="c1">#</span>
362-
<span class="c1"># (C) Copyright IBM 2018, 2023.</span>
362+
<span class="c1"># (C) Copyright IBM 2018, 2024.</span>
363363
<span class="c1">#</span>
364364
<span class="c1"># This code is licensed under the Apache License, Version 2.0. You may</span>
365365
<span class="c1"># obtain a copy of this license in the LICENSE.txt file in the root directory</span>
@@ -413,7 +413,7 @@ <h1>Source code for qiskit_finance.circuit.library.payoff_functions.european_cal
413413
<span class="p">)</span>
414414

415415
<span class="nb">super</span><span class="p">()</span><span class="o">.</span><span class="fm">__init__</span><span class="p">(</span><span class="o">*</span><span class="n">european_call</span><span class="o">.</span><span class="n">qregs</span><span class="p">,</span> <span class="n">name</span><span class="o">=</span><span class="s2">&quot;ECEV&quot;</span><span class="p">)</span>
416-
<span class="bp">self</span><span class="o">.</span><span class="n">_data</span> <span class="o">=</span> <span class="n">european_call</span><span class="o">.</span><span class="n">data</span>
416+
<span class="bp">self</span><span class="o">.</span><span class="n">data</span> <span class="o">=</span> <span class="n">european_call</span><span class="o">.</span><span class="n">data</span>
417417
<span class="bp">self</span><span class="o">.</span><span class="n">_european_call</span> <span class="o">=</span> <span class="n">european_call</span>
418418

419419
<div class="viewcode-block" id="EuropeanCallPricingObjective.post_processing"><a class="viewcode-back" href="../../../../../stubs/qiskit_finance.circuit.library.EuropeanCallPricingObjective.html#qiskit_finance.circuit.library.EuropeanCallPricingObjective.post_processing">[docs]</a> <span class="k">def</span> <span class="nf">post_processing</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">scaled_value</span><span class="p">:</span> <span class="nb">float</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">float</span><span class="p">:</span>

_modules/qiskit_finance/circuit/library/probability_distributions/lognormal.html

+5-5
Original file line numberDiff line numberDiff line change
@@ -359,7 +359,7 @@
359359
<h1>Source code for qiskit_finance.circuit.library.probability_distributions.lognormal</h1><div class="highlight"><pre>
360360
<span></span><span class="c1"># This code is part of a Qiskit project.</span>
361361
<span class="c1">#</span>
362-
<span class="c1"># (C) Copyright IBM 2017, 2023.</span>
362+
<span class="c1"># (C) Copyright IBM 2017, 2024.</span>
363363
<span class="c1">#</span>
364364
<span class="c1"># This code is licensed under the Apache License, Version 2.0. You may</span>
365365
<span class="c1"># obtain a copy of this license in the LICENSE.txt file in the root directory</span>
@@ -373,7 +373,10 @@ <h1>Source code for qiskit_finance.circuit.library.probability_distributions.log
373373

374374
<span class="kn">from</span> <span class="nn">typing</span> <span class="kn">import</span> <span class="n">Tuple</span><span class="p">,</span> <span class="n">List</span><span class="p">,</span> <span class="n">Union</span><span class="p">,</span> <span class="n">Optional</span>
375375
<span class="kn">import</span> <span class="nn">numpy</span> <span class="k">as</span> <span class="nn">np</span>
376+
376377
<span class="kn">from</span> <span class="nn">qiskit.circuit</span> <span class="kn">import</span> <span class="n">QuantumCircuit</span>
378+
<span class="kn">from</span> <span class="nn">qiskit.circuit.library</span> <span class="kn">import</span> <span class="n">Initialize</span><span class="p">,</span> <span class="n">Isometry</span>
379+
377380
<span class="kn">from</span> <span class="nn">.normal</span> <span class="kn">import</span> <span class="n">_check_bounds_valid</span><span class="p">,</span> <span class="n">_check_dimensions_match</span>
378381

379382

@@ -521,13 +524,10 @@ <h1>Source code for qiskit_finance.circuit.library.probability_distributions.log
521524
<span class="nb">super</span><span class="p">()</span><span class="o">.</span><span class="fm">__init__</span><span class="p">(</span><span class="o">*</span><span class="n">inner</span><span class="o">.</span><span class="n">qregs</span><span class="p">,</span> <span class="n">name</span><span class="o">=</span><span class="n">name</span><span class="p">)</span>
522525

523526
<span class="c1"># use default the isometry (or initialize w/o resets) algorithm to construct the circuit</span>
524-
<span class="c1"># pylint: disable=no-member</span>
525527
<span class="k">if</span> <span class="n">upto_diag</span><span class="p">:</span>
526-
<span class="n">inner</span><span class="o">.</span><span class="n">isometry</span><span class="p">(</span><span class="n">np</span><span class="o">.</span><span class="n">sqrt</span><span class="p">(</span><span class="n">normalized_probabilities</span><span class="p">),</span> <span class="n">inner</span><span class="o">.</span><span class="n">qubits</span><span class="p">,</span> <span class="kc">None</span><span class="p">)</span>
528+
<span class="n">inner</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">Isometry</span><span class="p">(</span><span class="n">np</span><span class="o">.</span><span class="n">sqrt</span><span class="p">(</span><span class="n">normalized_probabilities</span><span class="p">),</span> <span class="mi">0</span><span class="p">,</span> <span class="mi">0</span><span class="p">),</span> <span class="n">inner</span><span class="o">.</span><span class="n">qubits</span><span class="p">)</span>
527529
<span class="bp">self</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">inner</span><span class="o">.</span><span class="n">to_instruction</span><span class="p">(),</span> <span class="n">inner</span><span class="o">.</span><span class="n">qubits</span><span class="p">)</span> <span class="c1"># Isometry is not a Gate</span>
528530
<span class="k">else</span><span class="p">:</span>
529-
<span class="kn">from</span> <span class="nn">qiskit.extensions</span> <span class="kn">import</span> <span class="n">Initialize</span> <span class="c1"># pylint: disable=cyclic-import</span>
530-
531531
<span class="n">initialize</span> <span class="o">=</span> <span class="n">Initialize</span><span class="p">(</span><span class="n">np</span><span class="o">.</span><span class="n">sqrt</span><span class="p">(</span><span class="n">normalized_probabilities</span><span class="p">))</span>
532532
<span class="n">circuit</span> <span class="o">=</span> <span class="n">initialize</span><span class="o">.</span><span class="n">gates_to_uncompute</span><span class="p">()</span><span class="o">.</span><span class="n">inverse</span><span class="p">()</span>
533533
<span class="n">inner</span><span class="o">.</span><span class="n">compose</span><span class="p">(</span><span class="n">circuit</span><span class="p">,</span> <span class="n">inplace</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span>

_modules/qiskit_finance/circuit/library/probability_distributions/normal.html

+4-5
Original file line numberDiff line numberDiff line change
@@ -359,7 +359,7 @@
359359
<h1>Source code for qiskit_finance.circuit.library.probability_distributions.normal</h1><div class="highlight"><pre>
360360
<span></span><span class="c1"># This code is part of a Qiskit project.</span>
361361
<span class="c1">#</span>
362-
<span class="c1"># (C) Copyright IBM 2017, 2023.</span>
362+
<span class="c1"># (C) Copyright IBM 2017, 2024.</span>
363363
<span class="c1">#</span>
364364
<span class="c1"># This code is licensed under the Apache License, Version 2.0. You may</span>
365365
<span class="c1"># obtain a copy of this license in the LICENSE.txt file in the root directory</span>
@@ -373,7 +373,9 @@ <h1>Source code for qiskit_finance.circuit.library.probability_distributions.nor
373373

374374
<span class="kn">from</span> <span class="nn">typing</span> <span class="kn">import</span> <span class="n">Tuple</span><span class="p">,</span> <span class="n">Union</span><span class="p">,</span> <span class="n">List</span><span class="p">,</span> <span class="n">Optional</span><span class="p">,</span> <span class="n">Any</span>
375375
<span class="kn">import</span> <span class="nn">numpy</span> <span class="k">as</span> <span class="nn">np</span>
376+
376377
<span class="kn">from</span> <span class="nn">qiskit.circuit</span> <span class="kn">import</span> <span class="n">QuantumCircuit</span>
378+
<span class="kn">from</span> <span class="nn">qiskit.circuit.library</span> <span class="kn">import</span> <span class="n">Initialize</span><span class="p">,</span> <span class="n">Isometry</span>
377379

378380

379381
<div class="viewcode-block" id="NormalDistribution"><a class="viewcode-back" href="../../../../../stubs/qiskit_finance.circuit.library.NormalDistribution.html#qiskit_finance.circuit.library.NormalDistribution">[docs]</a><span class="k">class</span> <span class="nc">NormalDistribution</span><span class="p">(</span><span class="n">QuantumCircuit</span><span class="p">):</span>
@@ -567,13 +569,10 @@ <h1>Source code for qiskit_finance.circuit.library.probability_distributions.nor
567569
<span class="nb">super</span><span class="p">()</span><span class="o">.</span><span class="fm">__init__</span><span class="p">(</span><span class="o">*</span><span class="n">inner</span><span class="o">.</span><span class="n">qregs</span><span class="p">,</span> <span class="n">name</span><span class="o">=</span><span class="n">name</span><span class="p">)</span>
568570

569571
<span class="c1"># use default the isometry (or initialize w/o resets) algorithm to construct the circuit</span>
570-
<span class="c1"># pylint: disable=no-member</span>
571572
<span class="k">if</span> <span class="n">upto_diag</span><span class="p">:</span>
572-
<span class="n">inner</span><span class="o">.</span><span class="n">isometry</span><span class="p">(</span><span class="n">np</span><span class="o">.</span><span class="n">sqrt</span><span class="p">(</span><span class="n">normalized_probabilities</span><span class="p">),</span> <span class="n">inner</span><span class="o">.</span><span class="n">qubits</span><span class="p">,</span> <span class="kc">None</span><span class="p">)</span>
573+
<span class="n">inner</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">Isometry</span><span class="p">(</span><span class="n">np</span><span class="o">.</span><span class="n">sqrt</span><span class="p">(</span><span class="n">normalized_probabilities</span><span class="p">),</span> <span class="mi">0</span><span class="p">,</span> <span class="mi">0</span><span class="p">),</span> <span class="n">inner</span><span class="o">.</span><span class="n">qubits</span><span class="p">)</span>
573574
<span class="bp">self</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">inner</span><span class="o">.</span><span class="n">to_instruction</span><span class="p">(),</span> <span class="n">inner</span><span class="o">.</span><span class="n">qubits</span><span class="p">)</span> <span class="c1"># Isometry is not a Gate</span>
574575
<span class="k">else</span><span class="p">:</span>
575-
<span class="kn">from</span> <span class="nn">qiskit.extensions</span> <span class="kn">import</span> <span class="n">Initialize</span> <span class="c1"># pylint: disable=cyclic-import</span>
576-
577576
<span class="n">initialize</span> <span class="o">=</span> <span class="n">Initialize</span><span class="p">(</span><span class="n">np</span><span class="o">.</span><span class="n">sqrt</span><span class="p">(</span><span class="n">normalized_probabilities</span><span class="p">))</span>
578577
<span class="n">circuit</span> <span class="o">=</span> <span class="n">initialize</span><span class="o">.</span><span class="n">gates_to_uncompute</span><span class="p">()</span><span class="o">.</span><span class="n">inverse</span><span class="p">()</span>
579578
<span class="n">inner</span><span class="o">.</span><span class="n">compose</span><span class="p">(</span><span class="n">circuit</span><span class="p">,</span> <span class="n">inplace</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span>

_modules/qiskit_finance/data_providers/_base_data_provider.html

+2-2
Original file line numberDiff line numberDiff line change
@@ -359,7 +359,7 @@
359359
<h1>Source code for qiskit_finance.data_providers._base_data_provider</h1><div class="highlight"><pre>
360360
<span></span><span class="c1"># This code is part of a Qiskit project.</span>
361361
<span class="c1">#</span>
362-
<span class="c1"># (C) Copyright IBM 2019, 2023.</span>
362+
<span class="c1"># (C) Copyright IBM 2019, 2024.</span>
363363
<span class="c1">#</span>
364364
<span class="c1"># This code is licensed under the Apache License, Version 2.0. You may</span>
365365
<span class="c1"># obtain a copy of this license in the LICENSE.txt file in the root directory</span>
@@ -400,7 +400,7 @@ <h1>Source code for qiskit_finance.data_providers._base_data_provider</h1><div c
400400
<span class="sd"> Doing so requires that the required driver interface is implemented.</span>
401401

402402
<span class="sd"> To use the subclasses, please see</span>
403-
<span class="sd"> https://qiskit.org/ecosystem/finance/tutorials/11_time_series.html</span>
403+
<span class="sd"> https://qiskit-community.github.io/qiskit-finance/tutorials/11_time_series.html</span>
404404

405405
<span class="sd"> &quot;&quot;&quot;</span>
406406

_modules/qiskit_finance/data_providers/data_on_demand_provider.html

+2-2
Original file line numberDiff line numberDiff line change
@@ -359,7 +359,7 @@
359359
<h1>Source code for qiskit_finance.data_providers.data_on_demand_provider</h1><div class="highlight"><pre>
360360
<span></span><span class="c1"># This code is part of a Qiskit project.</span>
361361
<span class="c1">#</span>
362-
<span class="c1"># (C) Copyright IBM 2019, 2023.</span>
362+
<span class="c1"># (C) Copyright IBM 2019, 2024.</span>
363363
<span class="c1">#</span>
364364
<span class="c1"># This code is licensed under the Apache License, Version 2.0. You may</span>
365365
<span class="c1"># obtain a copy of this license in the LICENSE.txt file in the root directory</span>
@@ -389,7 +389,7 @@ <h1>Source code for qiskit_finance.data_providers.data_on_demand_provider</h1><d
389389
<span class="w"> </span><span class="sd">&quot;&quot;&quot;NASDAQ Data on Demand data provider.</span>
390390

391391
<span class="sd"> Please see:</span>
392-
<span class="sd"> https://qiskit.org/ecosystem/finance/tutorials/11_time_series.html</span>
392+
<span class="sd"> https://qiskit-community.github.io/qiskit-finance/tutorials/11_time_series.html</span>
393393
<span class="sd"> for instructions on use, which involve obtaining a NASDAQ DOD access token.</span>
394394
<span class="sd"> &quot;&quot;&quot;</span>
395395

_modules/qiskit_finance/data_providers/exchange_data_provider.html

+2-2
Original file line numberDiff line numberDiff line change
@@ -359,7 +359,7 @@
359359
<h1>Source code for qiskit_finance.data_providers.exchange_data_provider</h1><div class="highlight"><pre>
360360
<span></span><span class="c1"># This code is part of a Qiskit project.</span>
361361
<span class="c1">#</span>
362-
<span class="c1"># (C) Copyright IBM 2019, 2023.</span>
362+
<span class="c1"># (C) Copyright IBM 2019, 2024.</span>
363363
<span class="c1">#</span>
364364
<span class="c1"># This code is licensed under the Apache License, Version 2.0. You may</span>
365365
<span class="c1"># obtain a copy of this license in the LICENSE.txt file in the root directory</span>
@@ -386,7 +386,7 @@ <h1>Source code for qiskit_finance.data_providers.exchange_data_provider</h1><di
386386
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Exchange data provider.</span>
387387

388388
<span class="sd"> Please see:</span>
389-
<span class="sd"> https://qiskit.org/ecosystem/finance/tutorials/11_time_series.html</span>
389+
<span class="sd"> https://qiskit-community.github.io/qiskit-finance/tutorials/11_time_series.html</span>
390390
<span class="sd"> for instructions on use, which involve obtaining a Nasdaq Data Link access token.</span>
391391
<span class="sd"> &quot;&quot;&quot;</span>
392392

_modules/qiskit_finance/data_providers/wikipedia_data_provider.html

+2-2
Original file line numberDiff line numberDiff line change
@@ -359,7 +359,7 @@
359359
<h1>Source code for qiskit_finance.data_providers.wikipedia_data_provider</h1><div class="highlight"><pre>
360360
<span></span><span class="c1"># This code is part of a Qiskit project.</span>
361361
<span class="c1">#</span>
362-
<span class="c1"># (C) Copyright IBM 2019, 2023.</span>
362+
<span class="c1"># (C) Copyright IBM 2019, 2024.</span>
363363
<span class="c1">#</span>
364364
<span class="c1"># This code is licensed under the Apache License, Version 2.0. You may</span>
365365
<span class="c1"># obtain a copy of this license in the LICENSE.txt file in the root directory</span>
@@ -386,7 +386,7 @@ <h1>Source code for qiskit_finance.data_providers.wikipedia_data_provider</h1><d
386386
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Wikipedia data provider.</span>
387387

388388
<span class="sd"> Please see:</span>
389-
<span class="sd"> https://qiskit.org/ecosystem/finance/tutorials/11_time_series.html</span>
389+
<span class="sd"> https://qiskit-community.github.io/qiskit-finance/tutorials/11_time_series.html</span>
390390
<span class="sd"> for instructions on use.</span>
391391
<span class="sd"> &quot;&quot;&quot;</span>
392392

_modules/qiskit_finance/data_providers/yahoo_data_provider.html

+2-2
Original file line numberDiff line numberDiff line change
@@ -359,7 +359,7 @@
359359
<h1>Source code for qiskit_finance.data_providers.yahoo_data_provider</h1><div class="highlight"><pre>
360360
<span></span><span class="c1"># This code is part of a Qiskit project.</span>
361361
<span class="c1">#</span>
362-
<span class="c1"># (C) Copyright IBM 2020, 2023.</span>
362+
<span class="c1"># (C) Copyright IBM 2020, 2024.</span>
363363
<span class="c1">#</span>
364364
<span class="c1"># This code is licensed under the Apache License, Version 2.0. You may</span>
365365
<span class="c1"># obtain a copy of this license in the LICENSE.txt file in the root directory</span>
@@ -395,7 +395,7 @@ <h1>Source code for qiskit_finance.data_providers.yahoo_data_provider</h1><div c
395395
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Yahoo data provider.</span>
396396

397397
<span class="sd"> Please see:</span>
398-
<span class="sd"> https://qiskit.org/ecosystem/finance/tutorials/11_time_series.html</span>
398+
<span class="sd"> https://qiskit-community.github.io/qiskit-finance/tutorials/11_time_series.html</span>
399399
<span class="sd"> for instructions on use.</span>
400400
<span class="sd"> &quot;&quot;&quot;</span>
401401

_sources/getting_started.rst.txt

+4-5
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ Installation
88
============
99

1010
Qiskit Finance depends on Qiskit, which has its own
11-
`Qiskit Getting Started <https://qiskit.org/documentation/getting_started.html>`__ detailing the
11+
`installation instructions <https://docs.quantum.ibm.com/start/install>`__ detailing the
1212
installation options and its supported environments/platforms. You should refer to
1313
that first. Then the information here can be followed which focuses on the additional installation
1414
specific to Qiskit Finance.
@@ -17,10 +17,9 @@ specific to Qiskit Finance.
1717

1818
.. tab-item:: Start locally
1919

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

23-
In your virtual environment, where you installed Qiskit, install Qiskit Finance as follows:
22+
In your virtual environment, where you installed Qiskit, install ``qiskit-finance`` as follows:
2423

2524
.. code:: sh
2625
@@ -41,7 +40,7 @@ specific to Qiskit Finance.
4140

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

4645
.. raw:: html
4746

0 commit comments

Comments
 (0)