Merge branch 'main' into fix/ppo-mujoco-colab

Author: abhitorch81

.ci/docker/requirements.txt

@@ -1,16 +1,25 @@
 # --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.3.0
-sphinx-gallery==0.17.1
+# Sphinx dependencies
+sphinx==7.2.6
+sphinx-gallery==0.19.0
 sphinx-reredirects==0.1.4
-sphinx-design==0.4.0
-docutils==0.16
-sphinx-copybutton
-sphinx_sitemap==2.6.0
-pypandoc==1.12
-pandocfilters
-markdown
+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
+-e git+https://github.com/pytorch/pytorch_sphinx_theme.git@pytorch_sphinx_theme2#egg=pytorch_sphinx_theme2
+
+# Tutorial dependencies
 tqdm==4.66.1
 numpy==1.24.4
 matplotlib
@@ -42,6 +51,7 @@ onnxruntime
 evaluate
 accelerate>=0.20.1
 
+
 importlib-metadata==6.8.0
 
 # PyTorch Theme

.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/docathon-label-sync.py

@@ -30,7 +30,7 @@ def main():
     # 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-2025' label is not present in the issue.")
-        return    
+        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/link_checkPR.yml

@@ -31,15 +31,15 @@ jobs:
               issue_number: context.issue.number
             });
             return labels.data.some(label => label.name === 'skip-link-check');
-          
+
       - name: Check Links
         if: steps.skip-label.outputs.result == 'false'
         uses: lycheeverse/lychee-action@v1
         with:
           args: --accept=200,403,429 --base . --verbose --no-progress ${{ steps.changed-files.outputs.all_changed_files }}
           token: ${{ secrets.CUSTOM_TOKEN }}
           fail: true
-          
+
       - name: Skip Message
         if: steps.skip-label.outputs.result == 'true'
         run: echo "Link check was skipped due to the presence of the 'skip-link-check' label."
@@ -48,7 +48,7 @@ jobs:
       - name: No Files to Check
         if: steps.skip-label.outputs.result == 'false' && steps.changed-files.outputs.any_changed == 'true'
         run: echo "No relevant files were changed in this PR that require link checking."
-      
+
       - name: Suggestions
         if: failure()
         run: |

.github/workflows/lintrunner.yml

@@ -0,0 +1,38 @@
+name: Lintrunner
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.sha }}-${{ github.event_name == 'workflow_dispatch' }}
+  cancel-in-progress: true
+
+jobs:
+  lintrunner:
+    name: lintrunner
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout tutorials
+        uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
+
+      - name: Setup Python
+        uses: actions/setup-python@a26af69be951a213d495a4c3e4e4022e16d87065 # v5.6.0
+        with:
+          python-version: '3.12'
+
+      - name: Install Lintrunner
+        run: |
+          pip install lintrunner==0.12.5
+          lintrunner init
+
+      - name: Run lintrunner on all files - Linux
+        run: |
+          set +e
+          if ! lintrunner -v --force-color --all-files --tee-json=lint.json; then
+              echo ""
+              echo -e "\e[1m\e[36mYou can reproduce these results locally by using \`lintrunner -m main\`.\e[0m"
+              exit 1
+          fi

.github/workflows/spelling.yml

@@ -17,7 +17,7 @@ jobs:
           script: |
             let skipCheck = false;
             let changedFiles = [];
-            
+
             if (context.eventName === 'pull_request') {
               // Check for skip label
               const { data: labels } = await github.rest.issues.listLabelsOnIssue({
@@ -26,15 +26,15 @@ jobs:
                 issue_number: context.issue.number
               });
               skipCheck = labels.some(label => label.name === 'skip-spell-check');
-              
+
               if (!skipCheck) {
                 // Get changed files in PR
                 const { data: files } = await github.rest.pulls.listFiles({
                   owner: context.repo.owner,
                   repo: context.repo.repo,
                   pull_number: context.issue.number
                 });
-                
+
                 changedFiles = files
                   .filter(file => file.filename.match(/\.(py|rst|md)$/))
                   .map(file => file.filename);
@@ -43,7 +43,7 @@ jobs:
               // For push events, we'll still need to use git diff
               // We'll handle this after checkout
             }
-            
+
             core.setOutput('skip', skipCheck.toString());
             core.setOutput('files', changedFiles.join('\n'));
             core.setOutput('is-pr', (context.eventName === 'pull_request').toString());
@@ -73,7 +73,7 @@ jobs:
           else
             FILES="${{ steps.push-files.outputs.files }}"
           fi
-          
+
           if [ -z "$FILES" ]; then
             echo "skip=true" >> $GITHUB_OUTPUT
             echo "No relevant files changed (*.py, *.rst, *.md), skipping spell check"
@@ -110,7 +110,7 @@ jobs:
           else
             mapfile -t FILES <<< "${{ steps.push-files.outputs.files }}"
           fi
-          
+
           # Check each file individually
           FINAL_EXIT_CODE=0
           SPELLCHECK_LOG=""

.gitignore

@@ -127,3 +127,6 @@ cleanup.sh
 
 # pyspelling
 dictionary.dic
+
+# linters
+/.lintbin