From 3e85776666427d27030ac1eed3d77c15e9ed5233 Mon Sep 17 00:00:00 2001 From: Paul Finlay <50180049+doctorperceptron@users.noreply.github.com> Date: Tue, 23 Sep 2025 08:58:16 -0400 Subject: [PATCH 1/3] [PENNYPALOOZA] Update pyproject (#1557) Updates the project description to be more general. **Note**: Consider reducing the number of QML-related keywords. --- pyproject.toml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pyproject.toml b/pyproject.toml index d83786471f..97fff520c7 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -4,7 +4,7 @@ [project] name = "qml" version = "0.0.0" -description = "Introductions to key concepts in quantum machine learning, as well as tutorials and implementations from cutting-edge QML research." +description = "Introductions to key concepts in quantum computing, as well as tutorials and implementations from cutting-edge quantum-computing research." readme = "README.md" license = "Apache-2.0" requires-python = ">=3.10.0,<3.13.0" From 49a6904a40f339ef5c5fa4f9e2acb6e4d2dcbce7 Mon Sep 17 00:00:00 2001 From: Paul Finlay <50180049+doctorperceptron@users.noreply.github.com> Date: Tue, 23 Sep 2025 08:58:55 -0400 Subject: [PATCH 2/3] [PENNYPALOOZA] Remove unused rst (#1559) We no longer use the `demonstrations.rst` file or the CircleCI config for this project. Sphinx still needs an `index.rst` file to build, but it can be (and now is) empty. Removing these clears up a lot of the warnings that Sphinx was previously throwing during builds. **Note**: Also cleaned up a small config bug with Sphinx. Newer versions require you to set the `language` parameter. Example of building the gbs demo with these changes: ``` Running Sphinx v5.3.0 Using pandoc version: 3.7.0.1 to convert rst text blocks to markdown for .ipynb files loading pickled environment... done generating gallery... generating gallery for demos... [100%] gbs.py building [mo]: targets for 0 po files that are out of date building [json]: targets for 3 source files that are out of date updating environment: 0 added, 3 changed, 0 removed reading sources... [100%] demos/sg_execution_times looking for now-outdated files... none found pickling environment... done checking consistency... done preparing documents... done writing output... [100%] index generating indices... genindex done writing additional pages... search done copying images... [100%] demos/images/thumb/sphx_glr_gbs_thumb.png copying downloadable files... [100%] demos/demos_jupyter.zip copying static files... done copying extra files... done dumping search index in English (code: en)... done dumping object inventory... done Sphinx-Gallery gallery_conf["plot_gallery"] was False, so no examples were executed. build succeeded. You can now process the JSON files in _build/json. ``` --- .circleci/config.yml | 201 ---------------------------- conf.py | 5 +- demonstrations.rst | 308 ------------------------------------------- index.rst | 201 ---------------------------- 4 files changed, 2 insertions(+), 713 deletions(-) delete mode 100644 .circleci/config.yml delete mode 100644 demonstrations.rst diff --git a/.circleci/config.yml b/.circleci/config.yml deleted file mode 100644 index dc2508143d..0000000000 --- a/.circleci/config.yml +++ /dev/null @@ -1,201 +0,0 @@ -version: 2.1 - -orbs: - aws-cli: circleci/aws-cli@0.1.16 - -jobs: - build: - docker: - - image: circleci/python:3.7.12 - resource_class: large - - steps: - - checkout - - - restore_cache: - keys: - # when lock file changes, use increasingly general patterns to restore cache - - pip-v34c-{{ .Branch }}-{{ checksum "requirements.txt" }}-{{ checksum "requirements_no_deps.txt" }} - - pip-v34c-{{ .Branch }}- - - pip-v34c- - - - run: - name: Install dependencies - command: | - sudo apt install pandoc -qq - python3 -m venv venv - . venv/bin/activate - pip install pip setuptools cmake --upgrade - pip install -r requirements.txt - pip install --no-deps -r requirements_no_deps.txt - - - save_cache: - paths: - - venv - key: pip-v34c-{{ .Branch }}-{{ checksum "requirements.txt" }}-{{ checksum "requirements_no_deps.txt" }} - - - restore_cache: - keys: - - gallery-v34a-{{ .Branch }}-{{ .Revision }} - - gallery-v34a-{{ .Branch }}- - - gallery-v34a- - - - run: - name: Build tutorials - no_output_timeout: 60m - command: | - . venv/bin/activate - make download - make html - cd _build/ && zip -r /tmp/qml_html.zip html && cd ../ - zip -r /tmp/qml_demos.zip demos - zip -r /tmp/qml_backreferences backreferences - - - save_cache: - paths: - - ./demos - key: gallery-v34a-{{ .Branch }}-{{ .Revision }} - - - save_cache: - paths: - - ./_build/html - key: html-{{ .Environment.CIRCLE_SHA1 }} - - - store_artifacts: - path: /tmp/qml_html.zip - - - store_artifacts: - path: /tmp/qml_demos.zip - - - store_artifacts: - path: /tmp/qml_backreferences.zip - - - store_artifacts: - path: _build/html - - - store_test_results: - path: _build/test-results - - - store_artifacts: - path: _build/test-results - - build_dev: - docker: - - image: circleci/python:3.7.12 - resource_class: large - - steps: - - checkout - - - run: - name: Install dependencies - command: | - python3 -m venv venv - . venv/bin/activate - pip install pip setuptools cmake --upgrade - pip install -r requirements.txt - pip install --no-deps -r requirements_no_deps.txt - - - run: - name: Build tutorials - no_output_timeout: 30m - command: | - . venv/bin/activate - make download - make html - cd _build/ && zip -r /tmp/qml_html.zip html && cd ../ - zip -r /tmp/qml_demos.zip demos - zip -r /tmp/qml_backreferences backreferences - - - save_cache: - paths: - - ./_build/html - key: html-{{ .Environment.CIRCLE_SHA1 }} - - - store_artifacts: - path: /tmp/qml_html.zip - - - store_artifacts: - path: /tmp/qml_demos.zip - - - store_artifacts: - path: _build/html - - - store_test_results: - path: _build/test-results - - - store_artifacts: - path: _build/test-results - - deploy_dev: - executor: - name: aws-cli/default - python-version: '3.7.2' - - steps: - - aws-cli/setup - - - restore_cache: - keys: - - html-{{ .Environment.CIRCLE_SHA1 }} - - - deploy: - name: Deploy to AWS S3 - command: | - aws s3 sync _build/html s3://pennylane.ai-dev/qml --delete - - deploy_prod: - executor: - name: aws-cli/default - python-version: '3.7.2' - - steps: - - aws-cli/setup - - - restore_cache: - keys: - - html-{{ .Environment.CIRCLE_SHA1 }} - - - deploy: - name: Deploy to AWS S3 - command: | - aws s3 sync _build/html s3://pennylane.ai-prod/qml --delete - touch _build/html/implementations.html - touch _build/html/beginner.html - aws s3 cp _build/html/implementations.html s3://pennylane.ai-prod/qml/implementations.html --website-redirect https://pennylane.ai/qml/demonstrations.html - aws s3 cp _build/html/beginner.html s3://pennylane.ai-prod/qml/beginner.html --website-redirect https://pennylane.ai/qml/demonstrations.html - - - run: - name: Invalidate CloudFront - command: aws cloudfront create-invalidation --distribution-id $DISTRIBUTION_ID --paths /qml/* - -workflows: - version: 2 - - build_deploy: - jobs: - - build: - filters: - branches: - ignore: dev - - - build_dev: - filters: - branches: - only: dev - - - deploy_prod: - context: aws - requires: - - build - filters: - branches: - only: master - - - deploy_dev: - context: aws - requires: - - build_dev - filters: - branches: - only: dev diff --git a/conf.py b/conf.py index a437f83905..c6c65d4663 100644 --- a/conf.py +++ b/conf.py @@ -35,7 +35,7 @@ project = "PennyLane" -copyright = "2022, Xanadu Quantum Technologies, Inc." +copyright = "2025, Xanadu Quantum Technologies, Inc." author = "Xanadu Inc." @@ -44,7 +44,6 @@ # The full version, including alpha/beta/rc tags release = "" - # -- General configuration --------------------------------------------------- # If your documentation needs a minimal Sphinx version, state it here. @@ -148,7 +147,7 @@ # # This is also used if you do content translation via gettext catalogs. # Usually you set "language" from the command line for these cases. -language = None +language = "en" # List of patterns, relative to source directory, that match files and # directories to ignore when looking for source files. diff --git a/demonstrations.rst b/demonstrations.rst deleted file mode 100644 index c0d0cd061b..0000000000 --- a/demonstrations.rst +++ /dev/null @@ -1,308 +0,0 @@ -.. raw:: html - - - -Demos -===== - -.. meta:: - :property="og:description": Take a deeper dive into quantum computing by exploring cutting-edge algorithms using PennyLane and quantum hardware. - :property="og:image": https://pennylane.ai/qml/_static/demos_card.png - -.. raw:: html - - - - - - -
- -

- Take a deeper dive into quantum computing by exploring cutting-edge algorithms using PennyLane and quantum hardware. -

- -
- -
- -
-
-
- -
-
-
-

- -
- Getting started -

-

Begin your journey into quantum computing using PennyLane.

-
Read more
-
-
-
- -
-
- -
-
-
-

- -
- Optimization -

-

Learn how to train quantum circuits like neural networks, using the latest tips and tricks from the literature.

-
Read more
-
-
-
- -
-
- -
-
-
-

- -
- QML -

-

Explore cutting-edge research in quantum machine learning using PennyLane.

-
Read more
-
-
-
- -
-
- -
-
- -
-
-
-

- -
- Quantum Chemistry -

-

Study the properties of molecules and materials using quantum computing.

-
Read more
-
-
-
- -
-
- -
-
-
-

- -
- Quantum Computing -

-

Explore general quantum computing concepts and algorithms, from quantum volume to boson sampling.

-
Read more
-
-
-
- -
-
- -
-
-
-

- -
- Community -

-

Discover PennyLane demonstrations created by other users, or submit one yourself.

-
Read more
-
-
-
- -
-
- -
-

- Do you want to make your own demo using PennyLane? Read - the guidelines and submission instructions here, and have - your demo featured on our community page. -

-

- To cite a PennyLane demo, please refer to it as: Author. Title (PennyLane). Date of publication (updated on Date of last update). URL address (accessed on Date of access). -

-
- -

Featured

- - - -

- All content above is free, open-source, and available as executable code downloads. If you would like to contribute a demo, please make a pull request over at our GitHub repository. -

- -
-
- - -.. toctree:: - :maxdepth: 2 - :caption: QML Demos - :hidden: - - demos_community - demos_getting-started - demos_qml - demos_quantum-computing - demos_quantum-chemistry - demos_optimization diff --git a/index.rst b/index.rst index dbe870487e..e69de29bb2 100644 --- a/index.rst +++ b/index.rst @@ -1,201 +0,0 @@ -.. raw:: html - -Learn quantum programming -========================= - -.. meta:: - :property="og:description": Sit back and learn about quantum computing, quantum machine learning, and quantum chemistry. Explore key concepts and work through practical demonstrations. - :property="og:image": https://pennylane.ai/qml/_static/hubs/superhub-card.png - - -.. raw:: html - - -
-

- We have entered a new era of quantum computing, where increasingly advanced quantum devices are used to drive an active field of research and applications. -

- Get started in programming for quantum computers by choosing your area of interest below, or check out our full collection of demos and tutorials. -

- -
-
-
- -
-
-

- Quantum Computing icon -
- Quantum
Computing -

-

- Learn how universal computation can be achieved using quantum-mechanical systems. -

-
-
-
Read more
-
-
- -
- -
- -
-
-

- Book about quantum machine learning -
- Quantum Machine Learning -

-

- Find out how the principles of quantum computing and machine learning can be united to create something new. -

-
-
-
Read more
-
-
- -
- -
- -
-
-

- Laptop with quantum chemistry icon -
- Quantum
Chemistry -

-

- Study the properties of molecules and materials using quantum computers and algorithms. -

-
-
-
Read more
-
-
- -
-
-
-

- Yellow folder with Pennylane logo - Explore our new quantum datasets -

-
-
- -
- -
-
-

Browse our full set of demonstrations and tutorials

-
-
-
- -
-
-

- Chalk board with Pennylane logo -
- Demos -

-

- Dive into the code and see how to apply cutting-edge algorithms and techniques with PennyLane. -

-
-
-
Read more
-
-
- -
- -
- -
-
-

- Video play button icon -
- Videos -

-

- Follow along with our experts and explore ideas in quantum computing, quantum machine learning, and quantum chemistry. -

-
-
-
Read more
-
-
- -
-
-
- -

Our aim is to bring together a community focused on quantum machine learning, and provide a leading resource hub for quantum computing education and research.

- -
- -
-
- Light bulb with an atom inside -
-
Research-focused
-
-

Xanadu is not just a software company; we also perform high-impact research and build quantum hardware. Check out some of the papers released using our open-source software tools. -

-
- - -
-
- Blue book with Pennylane logo on it -
-
Documented
-
-

Code documentation is important; it encourages everyone to dive straight in and begin tinkering with the code. We have the highest standard for documentation — our aim is to make everything accessible, from code to theory. -

-
- - -
-
- Fork branch icon -
-
Open-source
-
-

The physics community is embracing open-source software, bringing transparency and reproducibility to physics research. All of our software is open-source, and we are excited to be along for the ride. -

-
- - -
-
- Atom icon -
-
Community-driven
-
-

When we release software, we have the community in mind. Development takes place publicly on GitHub, and members of our team are available to chat on our Slack and discussion forum. -

-
- -
- -
- -.. toctree:: - :maxdepth: 2 - :hidden: - - quantum-computing - quantum-machine-learning - quantum-chemistry - glossary - demonstrations - videos - datasets From 5a4b46ec86de443cba7ab3bcc40e76f58f221bc9 Mon Sep 17 00:00:00 2001 From: Paul Finlay <50180049+doctorperceptron@users.noreply.github.com> Date: Tue, 23 Sep 2025 09:00:03 -0400 Subject: [PATCH 3/3] [PENNYPALOOZA] Modify kitchen sink demo (#1558) Changes the description appearing in the kitchen sink demo that references quantum machine learning. --- documentation/reference_demo/demo.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/documentation/reference_demo/demo.py b/documentation/reference_demo/demo.py index fb76f806f2..7f428554f0 100644 --- a/documentation/reference_demo/demo.py +++ b/documentation/reference_demo/demo.py @@ -28,7 +28,7 @@ # --------------------------------------------- # # This document contains a comprehensive collection of all mathematical symbols and notations -# used across the PennyLane quantum machine learning demonstrations. +# used across the PennyLane demonstrations and tutorials. # %% # QUANTUM MECHANICS NOTATION