Merge branch 'main' of github.com:pytorch/tutorials into wwen/compile-tutorial-update

Author: williamwen42

.ci/docker/build.sh

@@ -11,7 +11,7 @@ IMAGE_NAME="$1"
 shift
 
 export UBUNTU_VERSION="22.04"
-export CUDA_VERSION="12.4.1"
+export CUDA_VERSION="12.6.3"
 
 export BASE_IMAGE="nvidia/cuda:${CUDA_VERSION}-devel-ubuntu${UBUNTU_VERSION}"
 echo "Building ${IMAGE_NAME} Docker image"

.ci/docker/requirements.txt

@@ -1,20 +1,29 @@
 # --extra-index-url https://download.pytorch.org/whl/cu117/index.html # Use this to run/publish tutorials against the latest binaries during the RC stage. Comment out after the release. Each release verify the correct cuda version.
-# Refer to ./jenkins/build.sh for tutorial build instructions
+# Refer to ./jenkins/build.sh for tutorial build instructions.
 
-sphinx==5.0.0
-sphinx-gallery==0.11.1
-sphinx_design
-docutils==0.16
-sphinx-copybutton
-sphinx_sitemap==2.6.0
-pypandoc==1.12
-pandocfilters
-markdown
+# Sphinx dependencies
+sphinx==7.2.6
+sphinx-gallery==0.19.0
+sphinx-reredirects==0.1.4
+sphinx_design==0.6.1
+docutils>=0.18.1,<0.21
+sphinx-copybutton==0.5.2
+sphinx_sitemap==2.7.1
+sphinxcontrib-mermaid==1.0.0
+sphinxcontrib.katex==0.9.10
+pypandoc==1.15
+pandocfilters==1.5.1
+markdown==3.8.2
+
+# PyTorch Theme
+git+https://github.com/pytorch/pytorch_sphinx_theme.git@bbe196cbc5037d69d89ad1bf079e2afa3b3e9611#egg=pytorch_sphinx_theme2
+
+# Tutorial dependencies
 tqdm==4.66.1
 numpy==1.24.4
 matplotlib
 librosa
-torch==2.7
+torch==2.8
 torchvision
 torchdata
 networkx
@@ -28,13 +37,13 @@ tensorboard
 jinja2==3.1.3
 pytorch-lightning
 torchx
-torchrl==0.7.2
-tensordict==0.7.2
-ax-platform>=0.4.0
+torchrl==0.9.2
+tensordict==0.9.1
+# For ax_multiobjective_nas_tutorial.py
+ax-platform>=0.4.0,<0.5.0
 nbformat>=5.9.2
 datasets
 transformers
-torchmultimodal-nightly # needs to be updated to stable as soon as it's avaialable
 onnx
 onnxscript>=0.2.2
 onnxruntime
@@ -43,9 +52,6 @@ accelerate>=0.20.1
 
 importlib-metadata==6.8.0
 
-# PyTorch Theme
--e git+https://github.com/pytorch/pytorch_sphinx_theme.git#egg=pytorch_sphinx_theme
-
 ipython
 
 sphinxcontrib.katex
@@ -63,11 +69,10 @@ gym-super-mario-bros==7.4.0
 pyopengl
 gymnasium[mujoco]==0.27.0
 timm
-iopath
 pygame==2.6.0
 pycocotools
 semilearn==0.3.2
 torchao==0.10.0
 segment_anything==1.0
-torchrec==1.1.0; platform_system == "Linux"
+torchrec==1.2.0; platform_system == "Linux"
 fbgemm-gpu==1.2.0; platform_system == "Linux"

.github/ISSUE_TEMPLATE/bug-report.yml

@@ -13,17 +13,17 @@ body:
 - type: textarea
   attributes:
     label: Add Link
-    description: | 
+    description: |
       **Add the link to the tutorial***
     placeholder: |
       Link to the tutorial on the website:
   validations:
-    required: true 
+    required: true
 - type: textarea
   attributes:
     label: Describe the bug
-    description: | 
-      **Add the bug description**      
+    description: |
+      **Add the bug description**
     placeholder: |
       Provide a detailed description of the issue with code samples if relevant
       ```python

.github/ISSUE_TEMPLATE/feature-request.yml

@@ -18,7 +18,7 @@ body:
 - type: textarea
   attributes:
     label: Existing tutorials on this topic
-    description: | 
+    description: |
       **Add a list of existing tutorials on the same topic.**
     placeholder: |
       List tutorials that already explain this functionality if exist. On pytorch.org or elsewhere.

.github/scripts/check_redirects.sh

@@ -0,0 +1,46 @@
+#!/bin/bash
+
+if [ "$CURRENT_BRANCH" == "$BASE_BRANCH" ]; then
+  echo "Running on $BASE_BRANCH branch. Skipping check."
+  exit 0
+fi
+
+
+# Get list of deleted or renamed files in this branch compared to base
+DELETED_FILES=$(git diff --name-status $BASE_BRANCH $CURRENT_BRANCH --diff-filter=DR | awk '{print $2}' | grep -E '\.(rst|py|md)$' | grep -v 'redirects.py')
+# Check if any deleted or renamed files were found
+if [ -z "$DELETED_FILES" ]; then
+  echo "No deleted or renamed files found. Skipping check."
+  exit 0
+fi
+
+echo "Deleted or renamed files:"
+echo "$DELETED_FILES"
+
+# Check if redirects.py has been updated
+REDIRECTS_UPDATED=$(git diff --name-status $BASE_BRANCH $CURRENT_BRANCH --diff-filter=AM | grep 'redirects.py' && echo "yes" || echo "no")
+
+if [ "$REDIRECTS_UPDATED" == "no" ]; then
+  echo "ERROR: Files were deleted or renamed but redirects.py was not updated. Please update .github/scripts/redirects.py to redirect these files."
+  exit 1
+fi
+
+# Check if each deleted file has a redirect entry
+MISSING_REDIRECTS=0
+for FILE in $DELETED_FILES; do
+  # Convert file path to URL path format (remove extension and adjust path)
+  REDIRECT_PATH=$(echo $FILE | sed -E 's/(.+)_source\/(.+)\.(py|rst|md)$/\1\/\2.html/')
+
+  # Check if this path exists in redirects.py as a key. We don't check for values.
+  if ! grep -q "\"$REDIRECT_PATH\":" redirects.py; then
+    echo "ERROR: Missing redirect for deleted file: $FILE (should have entry for \"$REDIRECT_PATH\")"
+    MISSING_REDIRECTS=1
+  fi
+done
+
+if [ $MISSING_REDIRECTS -eq 1 ]; then
+  echo "ERROR: Please add redirects for all deleted/renamed files to redirects.py"
+  exit 1
+fi
+
+echo "All deleted/renamed files have proper redirects. Check passed!"

.github/scripts/docathon-label-sync.py

@@ -25,12 +25,12 @@ def main():
     issue_number = int(re.findall(r'#(\d{1,5})', pull_request_body)[0])
     issue = repo.get_issue(issue_number)
     issue_labels = issue.labels
-    docathon_label_present = any(label.name == 'docathon-h1-2024' for label in issue_labels)
+    docathon_label_present = any(label.name == 'docathon-h1-2025' for label in issue_labels)
 
     # if the issue has a docathon label, add all labels from the issue to the PR.
     if not docathon_label_present:
-        print("The 'docathon-h1-2024' label is not present in the issue.")
-        return    
+        print("The 'docathon-h1-2025' label is not present in the issue.")
+        return
     pull_request_labels = pull_request.get_labels()
     issue_label_names = [label.name for label in issue_labels]
     labels_to_add = [label for label in issue_label_names if label not in pull_request_labels]
@@ -39,8 +39,8 @@ def main():
         return
     pull_request.add_to_labels(*labels_to_add)
     print("Labels added to the pull request!")
-        
 
-           
+
+
 if __name__  == "__main__":
     main()

.github/workflows/MonthlyLinkCheck.yml

@@ -1,4 +1,4 @@
-#Runs once a month and checks links in the repo to ensure they are valid 
+#Runs once a month and checks links in the repo to ensure they are valid
 #If action fails, it creates an issue with the failing links and an "incorrect link" label
 #If link is valid but failing, it can be added to the .lycheeignore file
 #Action can also be run manually as needed.
@@ -34,8 +34,8 @@ jobs:
           content-filepath: ./lychee/out.md
           labels: 'incorrect link'
           #token: ${{ secrets.CUSTOM_TOKEN }}
-          
-    
+
+
       - name: Suggestions
         if: failure()
         run: |

.github/workflows/StalePRs.yml

@@ -21,7 +21,7 @@ on:
 jobs:
   stale:
     if: ${{ github.repository == 'pytorch/tutorials' }}
-    runs-on: ubuntu-latest 
+    runs-on: ubuntu-latest
     permissions:
       contents: read
       pull-requests: write
@@ -154,4 +154,3 @@ jobs:
               }
             }
             core.info(`Processed ${numProcessed} PRs total.`);
-

.github/workflows/check-redirects.yml

@@ -0,0 +1,25 @@
+name: Check Redirects for Deleted or Renamed Files
+
+on:
+  pull_request:
+    paths:
+     - '*/**/*.rst'
+     - '*/**/*.py'
+     - '*/**/*.md'
+
+jobs:
+  check-redirects:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - name: Run redirect check script
+        run: |
+            chmod +x ./.github/scripts/check_redirects.sh
+            ./.github/scripts/check_redirects.sh
+        env:
+          BASE_BRANCH: ${{ github.base_ref }}
+          CURRENT_BRANCH: ${{ github.head_ref }}

.github/workflows/docathon-assign.yml

@@ -28,14 +28,14 @@ jobs:
                   repo: context.repo.repo,
                   issue_number: issueNumber
                 });
-              const hasLabel = issue.labels.some(label => label.name === 'docathon-h1-2024');
+              const hasLabel = issue.labels.some(label => label.name === 'docathon-h1-2025');
               if (hasLabel) {
                 if (issue.assignee !== null) {
                   await github.rest.issues.createComment({
                     owner: context.repo.owner,
                     repo: context.repo.repo,
                     issue_number: issueNumber,
-                    body: "The issue is already assigned. Please pick an opened and unnasigned issue with the [docathon-h1-2024 label](https://github.com/pytorch/pytorch/issues?q=is%3Aopen+is%3Aissue+label%3Adocathon-h1-2024)."
+                    body: "The issue is already assigned. Please pick an opened and unnasigned issue with the [docathon-h1-2025 label](https://github.com/pytorch/pytorch/issues?q=is%3Aopen+is%3Aissue+label%3Adocathon-h1-2025)."
                   });
                 } else {
                   await github.rest.issues.addAssignees({
@@ -46,7 +46,7 @@ jobs:
                   });
                 }
               } else {
-                const commmentMessage = "This issue does not have the correct label. Please pick an opened and unnasigned issue with the [docathon-h1-2024 label](https://github.com/pytorch/pytorch/issues?q=is%3Aopen+is%3Aissue+label%3Adocathon-h1-2024)."
+                const commmentMessage = "This issue does not have the correct label. Please pick an opened and unnasigned issue with the [docathon-h1-2025 label](https://github.com/pytorch/pytorch/issues?q=is%3Aopen+is%3Aissue+label%3Adocathon-h1-2025)."
                 await github.rest.issues.createComment({
                   owner: context.repo.owner,
                   repo: context.repo.repo,