master to test-v2-master (#1450)

## Changes
- Sync test master with original master

---------

Co-authored-by: Alan Martin <53958929+Alan-eMartin@users.noreply.github.com>
Co-authored-by: Andrija Paurevic <46359773+andrijapau@users.noreply.github.com>
Co-authored-by: Paul Finlay <50180049+doctorperceptron@users.noreply.github.com>
Co-authored-by: GitHub Nightly Merge Action <actions@github.com>
Co-authored-by: josephbowles <54283511+josephbowles@users.noreply.github.com>
Co-authored-by: Rashid N H M <95639609+rashidnhm@users.noreply.github.com>
Co-authored-by: doctorperceptron <paul@xanadu.ai>
Co-authored-by: dwierichs <david.wierichs@xanadu.ai>
Co-authored-by: JerryChen97 <chenys13@outlook.com>
Co-authored-by: Mudit Pandey <18223836+mudit2812@users.noreply.github.com>
Co-authored-by: Astral Cai <astral.cai@xanadu.ai>
Co-authored-by: Luis Alfredo Nuñez Meneses <alfredo.nunez@xanadu.ai>

Author: 12 people

.github/workflows/v2-build-branch-dev.yml

@@ -2,7 +2,7 @@ name: V2 Build QML Branch - Dev
 on:
   workflow_dispatch:
   schedule:
-    - cron: '0 0 * * 0,2,4,6' # At 00:00 on Sunday, Tuesday, Thursday, and Saturday.
+    - cron: '0 0 * * 1,3,5' # At 00:00 on Sunday (Monday am), Tuesday (Wednesday am), Thursday (Friday am).
 
 concurrency:
   group: v2-build-qml-demo-branch-dev
@@ -16,6 +16,7 @@ jobs:
       dev: true
       save-artifact: true
       artifact-name: build-branch-dev
+      artifact-retention: 3
       keep-going: false
       quiet: false
       batch_size: 10

.github/workflows/v2-build-branch-master.yml

@@ -2,7 +2,7 @@ name: V2 Build QML Branch - Master
 on:
   workflow_dispatch:
   schedule:
-    - cron: '0 0 * * 0,2,4,6' # At 00:00 on Sunday, Tuesday, Thursday, and Saturday.
+    - cron: '0 0 * * 1,3,5' # At 00:00 on Sunday (Monday am), Tuesday (Wednesday am), Thursday (Friday am).
 
 concurrency:
   group: v2-build-qml-demo-branch-master
@@ -16,6 +16,7 @@ jobs:
       dev: false
       save-artifact: true
       artifact-name: build-branch-master
+      artifact-retention: 3
       keep-going: false
       quiet: false
       batch_size: 10

.github/workflows/v2-build-demos.yml

@@ -26,10 +26,15 @@ on:
         type: boolean
         default: true
       artifact-name:
-        description: Name of the artifact containing the built demos (defaults to demo-build-{ref})
+        description: Name of the artifact containing the built demos (defaults to demo-build-{ref}).
         required: false
         type: string
         default: ''
+      artifact-retention:
+        description: The number of days to persist the consolidated artifacts.
+        required: false
+        type: number
+        default: 1
       keep-going:
         description: Keep going if a demo fails to build.
         required: false
@@ -76,6 +81,11 @@ on:
         required: false
         type: string
         default: ''
+      artifact-retention:
+        description: The number of days to persist the consolidated artifacts.
+        required: false
+        type: number
+        default: 1
       keep-going:
         description: Keep going if a demo fails to build.
         required: false
@@ -87,8 +97,7 @@ on:
         type: boolean
         default: false
       batch_size:
-        description: |
-          Number of demos to build per job
+        description: Number of demos to build per job.
         type: number
         default: 10
 
@@ -208,7 +217,7 @@ jobs:
         with:
           name: ${{ needs.generate-build-variables.outputs.artifact-name }}
           path: _build/pack/*.zip
-          retention-days: 1
+          retention-days: ${{ inputs.artifact-retention }}
           overwrite: true
 
       - name: Delete partial artifacts

.github/workflows/v2-deploy-pr.yml

@@ -80,12 +80,13 @@ jobs:
       github.event.workflow_run.event == 'pull_request' && 
       needs.prepare-build-context.result == 'success' &&
       needs.prepare-build-context.outputs.pr_ref != '' &&
+      needs.prepare-build-context.outputs.pr_id != '' &&
       needs.prepare-build-context.outputs.updated_demos != '[]'
     uses: ./.github/workflows/v2-deploy-demos.yml
     needs: prepare-build-context
     with:
       # TODO: Update SWC environment to "swc-prod"
-      environment: 'swc-dev' 
+      environment: 'swc-staging'
       artifact-name: demo-build-${{ needs.prepare-build-context.outputs.pr_ref }}
       workflow-run-id: ${{ github.event.workflow_run.id }}
       pr_number: ${{ fromJson(needs.prepare-build-context.outputs.pr_id) }}

Makefile

@@ -62,6 +62,7 @@ download:
 	wget --no-verbose -N https://download.pytorch.org/tutorial/hymenoptera_data.zip -P $(DATADIR)
 	unzip -q -o $(DATADIR)/hymenoptera_data.zip -d $(DATADIR)/
 
+# TODO: Update flax, or certain tutorials e.g. tutorial_rl_pulse.py will fail due to implicit confliction between jax==0.6.0 and flax==0.9.0
 environment:
 	@command -v $(POETRY_BIN) --version >/dev/null 2>&1 || { echo >&2 "Setting up the environment requires a valid installation of python-poetry. Please install and add poetry to PATH or pass the executable using POETRY_BIN. Aborting."; exit 1; }
 	@if [ '$(BASE_ONLY)' = 'true' ]; then\

README.md

@@ -165,7 +165,10 @@ Due to the large scope of requirements in this repository, the traditional `requ
 and `pyproject.toml` is being introduced instead, the goal being easier management in regard to adding/updating packages.
 
 To install all the dependencies locally, [poetry](https://python-poetry.org/) needs to be installed. Please follow the
-[official installation documentation](https://python-poetry.org/docs/#installation).
+[official installation documentation](https://python-poetry.org/docs/#installation). To ensure that no issues arise, we
+recommend using the [official installer](https://python-poetry.org/docs/#installing-with-the-official-installer).
+
+**IMPORTANT NOTE:** It is important to install Poetry using the official instructions and NOT into the same virtual env as QML itself, this would cause poetry to manage itself and raise unexpected errors.
 
 ### Installing dependencies
 

_static/demonstration_assets/adjoint_diff/scaling.png

@@ -18,12 +18,17 @@
 import numpy as np
 from jinja2 import FileSystemLoader, Environment
 import yaml
-from pennylane import PennyLaneDeprecationWarning
 from pathlib import Path
 
 sys.path.insert(0, os.path.abspath("."))
 sys.path.insert(0, os.path.join(os.path.dirname(__file__)))
 
+# This module has been refactored from pennylane v0.41.0 to v0.42.0
+# This can be removed after the release of v0.42.0
+try:
+    from pennylane.exceptions import PennyLaneDeprecationWarning
+except ModuleNotFoundError:
+    from pennylane import PennyLaneDeprecationWarning
 
 # -- Project information -----------------------------------------------------
 # General information about the project.
@@ -213,3 +218,6 @@
     "pennylane": ("https://docs.pennylane.ai/en/stable/", None),
     "catalyst": ("https://docs.pennylane.ai/projects/catalyst/en/stable", None)
 }
+
+# Enable :doc: references for intersphinx (disabled by default in Sphinx 5.0+)
+intersphinx_disabled_reftypes = []