Skip to content

Commit

Permalink
Remove outdated Docker description from Installation docs (#6487)
Browse files Browse the repository at this point in the history
**Context:**
See [slack
message](https://xanaduhq.slack.com/archives/C0743CNS9E3/p1730125288115899)
regarding [GH
issue](#6452).

- Docker description in [Installation and dependencies
documentation](https://docs.pennylane.ai/en/stable/development/guide/installation.html?highlight=docker)is
outdated due to unmaintained Docker builds. We recommend removing the
Docker section entirely, and guiding users to [Docker support in
Lightning
documentation](https://docs.pennylane.ai/projects/lightning/en/stable/dev/docker.html).

**Description of the Change:**
- Remove outdated 'Docker' section in [Installation and dependencies
documentation](https://docs.pennylane.ai/en/stable/development/guide/installation.html?highlight=docker)

**Benefits:**
- Eliminates outdated information, helping prevent user confusion from
unsupported Docker builds as noted in this [GH
issue](#6452).

**Possible Drawbacks:**

**Related GitHub Issues:**
#6452
  • Loading branch information
justinpickering authored Oct 30, 2024
1 parent 1bc9602 commit d86a964
Showing 1 changed file with 0 additions and 52 deletions.
52 changes: 0 additions & 52 deletions doc/development/guide/installation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -78,55 +78,3 @@ pre-commit quality checks. Those can be installed easily via ``pip``:
.. code-block:: bash
pip install -r requirements-dev.txt
Docker
------

Build a PennyLane Docker image
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

**Docker** support exists for building using **CPU** and **GPU** (Nvidia CUDA 11.1+) images.

.. note::

Docker builds using "make" will work on Linux and MacOS only. For MS Windows
you can use `WSL <https://docs.microsoft.com/en-us/windows/wsl/install-win10>`__.
They are currently not supported on the Apple M1 chip (ARM64).


Build a basic PennyLane image
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

- To build a basic PennyLane image without any additional interfaces (Torch,
TensorFlow, or Jax) or **plugins** (qiskit, amazon-braket, cirq, forest), run
the following:

.. code-block:: bash
make -f docker/Makefile build-base
Build a PennyLane image with a specific interface
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

- To build a PennyLane image using a specific **interface** (Torch, TensorFlow or Jax), run the following:

.. code-block:: bash
make -f docker/Makefile build-interface interface-name=tensorflow
- To build a PennyLane image using a specific interface (Torch, TensorFlow or
Jax) with GPU support, run the following:

.. code-block:: bash
make -f docker/Makefile build-interface-gpu interface-name=tensorflow
Build a PennyLane image with a plugin
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

- To build a PennyLane image using a specific plugin (qiskit, amazon-braket,
cirq, forest, etc), run the following:

.. code-block:: bash
make -f docker/Makefile build-plugin plugin-name=qiskit

0 comments on commit d86a964

Please sign in to comment.