From d8e05550a37bfff66423fef2c6f91a9d58df911d Mon Sep 17 00:00:00 2001 From: Ashish Kanwar Singh <104938869+ashishks0522@users.noreply.github.com> Date: Fri, 18 Oct 2024 12:38:00 -0400 Subject: [PATCH] Update Pennylane.ai links to be without `.html` (#6412) ## Changes - Updated links to PennyLane.ai in the documentation to use the latest URL format, which excludes the `.html` prefix. --------- Co-authored-by: Mudit Pandey --- .github/CONTRIBUTING.md | 8 ++++---- README.md | 20 ++++++++++---------- doc/code/qml_devices.rst | 2 +- doc/code/qml_qchem.rst | 2 +- doc/index.rst | 14 +++++++------- doc/introduction/circuits.rst | 2 +- doc/introduction/importing_workflows.rst | 2 +- doc/introduction/pennylane.rst | 2 +- doc/releases/changelog-0.19.0.md | 2 +- doc/releases/changelog-0.24.0.md | 2 +- doc/releases/changelog-0.25.0.md | 2 +- doc/releases/changelog-0.26.0.md | 2 +- doc/releases/changelog-0.27.0.md | 2 +- doc/releases/changelog-dev.md | 4 ++++ pennylane/devices/device_constructor.py | 2 +- pennylane/fourier/reconstruct.py | 4 ++-- pennylane/optimize/qnspsa.py | 2 +- pennylane/pulse/__init__.py | 2 +- pennylane/shadows/__init__.py | 2 +- pennylane/shadows/classical_shadow.py | 4 ++-- tests/optimize/test_rotoselect.py | 2 +- 21 files changed, 44 insertions(+), 40 deletions(-) diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index 47c7db373d0..8779835639d 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -17,8 +17,8 @@ and help us make quantum computing a welcoming place for all. Start by experimenting with PennyLane. Figure out how to do things and form opinions about what you like and dislike about the ecosystem. What made your life easier? What was a source of difficulty and confusion? We can always use more user feedback. You can use our -[demonstrations](https://pennylane.ai/qml/demonstrations.html) and -[blog](https://pennylane.ai/blog/) to learn about features and applications. +[demonstrations](https://pennylane.ai/qml/demonstrations) and +[blog](https://pennylane.ai/blog) to learn about features and applications. As you get a feel for the user experience, you can start peeking under the hood and finding out how the package accomplishes its tasks. @@ -33,7 +33,7 @@ Sometimes, it might take us a couple of hours to reply - please be patient! It's up to you! * **Write a Community Demo.** - Show off your PennyLane application on - [our community page](https://pennylane.ai/qml/demos_community.html). We take Jupyter notebooks, + [our community page](https://pennylane.ai/qml/demos_community). We take Jupyter notebooks, scripts with explanations, or entire repositories. Community demos are a great way to showcase research and new papers. @@ -42,7 +42,7 @@ It's up to you! * **Test the cutting-edge PennyLane releases.** - Clone our GitHub repository, and keep up with the latest features. Learn how to install PennyLane from source - [here](https://pennylane.ai/install.html?version=preview). If you run into any bugs, make a bug + [here](https://pennylane.ai/install). If you run into any bugs, make a bug report on our [issue tracker](https://github.com/XanaduAI/pennylane/issues). * **Report bugs.** - If you come across any bugs or issues, make a bug report. PennyLane has diff --git a/README.md b/README.md index 7ef6986e1cf..eb5b69e17c2 100644 --- a/README.md +++ b/README.md @@ -87,11 +87,11 @@ PennyLane's [quantum machine learning hub](https://pennylane.ai/qml/): -* [What is quantum machine learning?](https://pennylane.ai/qml/whatisqml.html) -* [QML tutorials and demos](https://pennylane.ai/qml/demonstrations.html) -* [Frequently asked questions](https://pennylane.ai/faq.html) -* [Key concepts of QML](https://pennylane.ai/qml/glossary.html) -* [QML videos](https://pennylane.ai/qml/videos.html) +* [What is quantum machine learning?](https://pennylane.ai/qml/whatisqml) +* [QML tutorials and demos](https://pennylane.ai/qml/demonstrations) +* [Frequently asked questions](https://pennylane.ai/faq) +* [Key concepts of QML](https://pennylane.ai/qml/glossary) +* [QML videos](https://pennylane.ai/qml/videos) You can also check out our [documentation](https://pennylane.readthedocs.io) for [quickstart guides](https://pennylane.readthedocs.io/en/stable/introduction/pennylane.html) to using PennyLane, @@ -102,9 +102,9 @@ quantum device. ## Tutorials and demonstrations Take a deeper dive into quantum machine learning by exploring cutting-edge algorithms on our [demonstrations -page](https://pennylane.ai/qml/demonstrations.html). +page](https://pennylane.ai/qml/demonstrations). - + @@ -112,14 +112,14 @@ All demonstrations are fully executable, and can be downloaded as Jupyter notebo scripts. If you would like to contribute your own demo, see our [demo submission -guide](https://pennylane.ai/qml/demos_submission.html). +guide](https://pennylane.ai/qml/demos_submission). ## Videos -Seeing is believing! Check out [our videos](https://pennylane.ai/qml/videos.html) to learn about +Seeing is believing! Check out [our videos](https://pennylane.ai/qml/videos) to learn about PennyLane, quantum computing concepts, and more. - + diff --git a/doc/code/qml_devices.rst b/doc/code/qml_devices.rst index 4c6111dbc71..1ea20ace93e 100644 --- a/doc/code/qml_devices.rst +++ b/doc/code/qml_devices.rst @@ -8,7 +8,7 @@ qml.devices Unless you are a PennyLane or plugin developer, you likely do not need to use these classes directly. - See the `main plugins page `_ for more + See the `main plugins page `_ for more details on available plugins. .. rubric:: Modules diff --git a/doc/code/qml_qchem.rst b/doc/code/qml_qchem.rst index 9284c9f9e32..375187a0b8d 100644 --- a/doc/code/qml_qchem.rst +++ b/doc/code/qml_qchem.rst @@ -71,7 +71,7 @@ The generated Hamiltonian can be used in a circuit where the molecular geometry, parameters, and the circuit parameters are optimized simultaneously. Further information about molecular geometry optimization with PennyLane is provided in this `paper `__ and this -`demo `__. +`demo `__. .. code-block:: python3 diff --git a/doc/index.rst b/doc/index.rst index 22511ed99fc..b554310934a 100644 --- a/doc/index.rst +++ b/doc/index.rst @@ -84,7 +84,7 @@ Features - *Device-independent*. The same quantum circuit model can be **run on different backends**. Install - `plugins `_ to access even more + `plugins `_ to access even more devices, including **Strawberry Fields**, **Amazon Braket**, **IBM Q**, **Google Cirq**, **Rigetti Forest**, **Microsoft QDK**, and **ProjectQ**. @@ -94,15 +94,15 @@ Getting started For an introduction to quantum machine learning, we have several guides and resources available on our `QML website `_, including -`What is QML? `_, -`frequently asked questions `_, -a `glossary of key concepts `_, and a curated selection -of `QML videos `_. +`What is QML? `_, +`frequently asked questions `_, +a `glossary of key concepts `_, and a curated selection +of `QML videos `_. Then, take a deeper dive into quantum machine learning by exploring cutting-edge algorithms using PennyLane and near-term quantum hardware, with our collection of -`QML demonstrations `_. +`QML demonstrations `_. You can also check out the :doc:`Using PennyLane ` section for more details on the :doc:`quantum operations `, and to explore @@ -110,7 +110,7 @@ the available :doc:`optimization tools ` provided by Pe We also have a detailed guide on :doc:`how to write your own ` PennyLane-compatible quantum device. -Finally, play around with the numerous `devices and plugins `_ +Finally, play around with the numerous `devices and plugins `_ available for running your hybrid optimizations—these include IBM Q, provided by the `PennyLane-Qiskit `__ plugin, as well as the Rigetti Aspen QPU provided by `PennyLane-Rigetti diff --git a/doc/introduction/circuits.rst b/doc/introduction/circuits.rst index 74f8ff8bf21..f32b8436d69 100644 --- a/doc/introduction/circuits.rst +++ b/doc/introduction/circuits.rst @@ -89,7 +89,7 @@ instantiated using the :func:`device ` loader. PennyLane offers some basic devices such as the ``'default.qubit'``, ``'default.mixed'``, ``lightning.qubit``, ``'default.gaussian'``, ``'default.clifford'``, and ``'default.tensor'`` simulators; additional devices can be installed as plugins -(see `available plugins `_ for more details). Note that the +(see `available plugins `_ for more details). Note that the choice of a device significantly determines the speed of your computation, as well as the available options that can be passed to the device loader. diff --git a/doc/introduction/importing_workflows.rst b/doc/introduction/importing_workflows.rst index 01f24b23946..c60b59cc6f1 100644 --- a/doc/introduction/importing_workflows.rst +++ b/doc/introduction/importing_workflows.rst @@ -15,7 +15,7 @@ constructed using another framework. This includes circuits defined using `Qiski To import a quantum circuit defined using a particular framework, you will need to install the corresponding PennyLane plugin for that framework. More information about PennyLane plugins is - available on the `plugins `_ page. + available on the `plugins `_ page. Importing quantum circuits -------------------------- diff --git a/doc/introduction/pennylane.rst b/doc/introduction/pennylane.rst index e452c119b6d..4ec5cb0812d 100644 --- a/doc/introduction/pennylane.rst +++ b/doc/introduction/pennylane.rst @@ -42,5 +42,5 @@ the complex job of optimising communication with the devices, compiling circuits and choosing the best gradient strategies is taken care of. The library comes with default simulator devices, but is well-integrated with -`external software and hardware `__ to run quantum +`external software and hardware `__ to run quantum circuits---such as IBM's Qiskit, or Google's Cirq, Rigetti's Forest, or Xanadu's Strawberry Fields. diff --git a/doc/releases/changelog-0.19.0.md b/doc/releases/changelog-0.19.0.md index 753a8d97ca9..5b13a4295f7 100644 --- a/doc/releases/changelog-0.19.0.md +++ b/doc/releases/changelog-0.19.0.md @@ -1112,7 +1112,7 @@

Documentation

-* Adds a link to https://pennylane.ai/qml/demonstrations.html in the navbar. +* Adds a link to https://pennylane.ai/qml/demonstrations in the navbar. [(#1624)](https://github.com/PennyLaneAI/pennylane/pull/1624) * Corrects the docstring of `ExpvalCost` by adding `wires` to the signature of diff --git a/doc/releases/changelog-0.24.0.md b/doc/releases/changelog-0.24.0.md index 9f9ffc573b4..4858bba54a8 100644 --- a/doc/releases/changelog-0.24.0.md +++ b/doc/releases/changelog-0.24.0.md @@ -66,7 +66,7 @@ qfim = qml.qinfo.quantum_fisher(circ)(params) ``` - These quantities are typically employed in variational optimization schemes to tilt the gradient in a more favourable direction --- producing what is known as the [natural gradient](https://pennylane.ai/qml/demos/tutorial_quantum_natural_gradient.html). For example: + These quantities are typically employed in variational optimization schemes to tilt the gradient in a more favourable direction --- producing what is known as the [natural gradient](https://pennylane.ai/qml/demos/tutorial_quantum_natural_gradient). For example: ```pycon >>> grad = qml.grad(circ)(params) diff --git a/doc/releases/changelog-0.25.0.md b/doc/releases/changelog-0.25.0.md index bc476f85679..a6c921edcc3 100644 --- a/doc/releases/changelog-0.25.0.md +++ b/doc/releases/changelog-0.25.0.md @@ -610,7 +610,7 @@ * The deprecated `qml.hf` module is removed. Users with code that calls `qml.hf` can simply replace `qml.hf` with `qml.qchem` in most cases, or refer to the [qchem documentation](https://pennylane.readthedocs.io/en/stable/code/qml_qchem.html) - and [demos](https://pennylane.ai/qml/demos_quantum-chemistry.html) for more + and [demos](https://pennylane.ai/qml/demos_quantum-chemistry) for more information. [(#2795)](https://github.com/PennyLaneAI/pennylane/pull/2795) diff --git a/doc/releases/changelog-0.26.0.md b/doc/releases/changelog-0.26.0.md index d688d1f631d..1e65e32d551 100644 --- a/doc/releases/changelog-0.26.0.md +++ b/doc/releases/changelog-0.26.0.md @@ -227,7 +227,7 @@ params, cost = opt.step_and_cost(cost, params) ``` - Check out [our demo](https://pennylane.ai/qml/demos/qnspsa.html) on the QNSPSA optimizer for more information. + Check out [our demo](https://pennylane.ai/qml/demos/qnspsa) on the QNSPSA optimizer for more information.

Operator and parameter broadcasting supplements 📈

diff --git a/doc/releases/changelog-0.27.0.md b/doc/releases/changelog-0.27.0.md index 096830c22ac..e45bcb00a08 100644 --- a/doc/releases/changelog-0.27.0.md +++ b/doc/releases/changelog-0.27.0.md @@ -196,7 +196,7 @@ ``` For a detailed breakdown of its implementation, check out the [Adaptive circuits for quantum chemistry - demo](https://pennylane.ai/qml/demos/tutorial_adaptive_circuits.html). + demo](https://pennylane.ai/qml/demos/tutorial_adaptive_circuits).

Automatic interface detection 🧩

diff --git a/doc/releases/changelog-dev.md b/doc/releases/changelog-dev.md index ead3ffbe945..bebdf90709b 100644 --- a/doc/releases/changelog-dev.md +++ b/doc/releases/changelog-dev.md @@ -252,6 +252,9 @@

Documentation 📝

+* Updated links to PennyLane.ai in the documentation to use the latest URL format, which excludes the `.html` prefix. + [(#6412)](https://github.com/PennyLaneAI/pennylane/pull/6412) + * Update `qml.Qubitization` documentation based on new decomposition. [(#6276)](https://github.com/PennyLaneAI/pennylane/pull/6276) @@ -363,4 +366,5 @@ Erick Ochoa Lopez, Lee J. O'Riordan, Mudit Pandey, Andrija Paurevic, +Ashish Kanwar Singh, David Wierichs, diff --git a/pennylane/devices/device_constructor.py b/pennylane/devices/device_constructor.py index 1fc4df2acff..e0e6e9b753f 100644 --- a/pennylane/devices/device_constructor.py +++ b/pennylane/devices/device_constructor.py @@ -88,7 +88,7 @@ def device(name, *args, **kwargs): of quantum circuits based on tensor networks. Additional devices are supported through plugins — see - the `available plugins `_ for more + the `available plugins `_ for more details. To list all currently installed devices, run :func:`qml.about `. diff --git a/pennylane/fourier/reconstruct.py b/pennylane/fourier/reconstruct.py index 7a363fe32f7..c594dd9999a 100644 --- a/pennylane/fourier/reconstruct.py +++ b/pennylane/fourier/reconstruct.py @@ -392,9 +392,9 @@ def reconstruct(qnode, ids=None, nums_frequency=None, spectra=None, shifts=None) `Wierichs, Izaac, Wang and Lin (2022) `__ . An introduction to the concept of quantum circuits as Fourier series can also be found in the - `Quantum models as Fourier series `__ + `Quantum models as Fourier series `__ and - `General parameter-shift rules `__ + `General parameter-shift rules `__ demos as well as the :mod:`qml.fourier ` module docstring. diff --git a/pennylane/optimize/qnspsa.py b/pennylane/optimize/qnspsa.py index bfbeb2d0c1d..213544697dd 100644 --- a/pennylane/optimize/qnspsa.py +++ b/pennylane/optimize/qnspsa.py @@ -77,7 +77,7 @@ class QNSPSAOptimizer: "Simultaneous Perturbation Stochastic Approximation of the Quantum Fisher Information." `Quantum, 5, 567 `_, 2021. - You can also find a walkthrough of the implementation in this `tutorial `_. + You can also find a walkthrough of the implementation in this `tutorial `_. **Examples:** diff --git a/pennylane/pulse/__init__.py b/pennylane/pulse/__init__.py index b1e6fd53e09..61ed2974cb1 100644 --- a/pennylane/pulse/__init__.py +++ b/pennylane/pulse/__init__.py @@ -30,7 +30,7 @@ `jax.readthedocs.io `_. For a demonstration of the basic pulse functionality in PennyLane and running a ctrl-VQE example, see our demo on -`differentiable pulse programming `_. +`differentiable pulse programming `_. Overview -------- diff --git a/pennylane/shadows/__init__.py b/pennylane/shadows/__init__.py index c2cdbff5dff..19a3c6361f4 100644 --- a/pennylane/shadows/__init__.py +++ b/pennylane/shadows/__init__.py @@ -45,7 +45,7 @@ .. note:: As per `arXiv:2103.07510 `_, when computing multiple expectation values it is advisable to directly estimate the desired observables by simultaneously measuring qubit-wise-commuting terms. One way of doing this in PennyLane is via :class:`~pennylane.Hamiltonian` and setting ``grouping_type="qwc"``. For more details on this topic, see the PennyLane demo - on `estimating expectation values with classical shadows `_. + on `estimating expectation values with classical shadows `_. A :class:`ClassicalShadow` is a classical description of a quantum state that is capable of reproducing expectation values of local Pauli observables, see `arXiv:2002.08953 `_. diff --git a/pennylane/shadows/classical_shadow.py b/pennylane/shadows/classical_shadow.py index 8492fc6d072..c3556841b1e 100644 --- a/pennylane/shadows/classical_shadow.py +++ b/pennylane/shadows/classical_shadow.py @@ -46,7 +46,7 @@ class ClassicalShadow: .. note:: As per `arXiv:2103.07510 `_, when computing multiple expectation values it is advisable to directly estimate the desired observables by simultaneously measuring qubit-wise-commuting terms. One way of doing this in PennyLane is via :class:`~pennylane.Hamiltonian` and setting ``grouping_type="qwc"``. For more details on this topic, see our demo - on `estimating expectation values with classical shadows `_. + on `estimating expectation values with classical shadows `_. Args: bits (tensor): recorded measurement outcomes in random Pauli bases. @@ -55,7 +55,7 @@ class ClassicalShadow: they appear in the columns of ``bits`` and ``recipes``. If None, defaults to ``range(n)``, where ``n`` is the number of measured wires. - .. seealso:: Demo on `Estimating observables with classical shadows in the Pauli basis `_, :func:`~.pennylane.classical_shadow` + .. seealso:: Demo on `Estimating observables with classical shadows in the Pauli basis `_, :func:`~.pennylane.classical_shadow` **Example** diff --git a/tests/optimize/test_rotoselect.py b/tests/optimize/test_rotoselect.py index e95b9043e70..a4dda96f731 100644 --- a/tests/optimize/test_rotoselect.py +++ b/tests/optimize/test_rotoselect.py @@ -71,7 +71,7 @@ def cost_fn(params, generators): def test_rotoselect_optimizer(self, x_start, generators, tol): """Tests that rotoselect optimizer finds the optimal generators and parameters for the VQE circuit defined in `this rotoselect tutorial - `_.""" + `_.""" # the optimal generators for the 2-qubit VQE circuit # H = 0.5 * Y_2 + 0.8 * Z_1 - 0.2 * X_1