Releasing update [rebase & merge]

.azure/gpu-benchmarks.yml

@@ -46,7 +46,7 @@ jobs:
     variables:
       DEVICES: $( python -c 'print("$(Agent.Name)".split("_")[-1])' )
     container:
-      image: "pytorchlightning/pytorch_lightning:base-cuda-py3.12-torch2.4-cuda12.1.0"
+      image: "pytorchlightning/pytorch_lightning:base-cuda-py3.12-torch2.5-cuda12.1.0"
       options: "--gpus=all --shm-size=32g"
     strategy:
       matrix:

.azure/gpu-tests-fabric.yml

@@ -60,7 +60,7 @@ jobs:
           image: "pytorchlightning/pytorch_lightning:base-cuda-py3.11-torch2.3-cuda12.1.0"
           PACKAGE_NAME: "fabric"
         "Lightning | latest":
-          image: "pytorchlightning/pytorch_lightning:base-cuda-py3.12-torch2.4-cuda12.1.0"
+          image: "pytorchlightning/pytorch_lightning:base-cuda-py3.12-torch2.5-cuda12.1.0"
           PACKAGE_NAME: "lightning"
     workspace:
       clean: all

.azure/gpu-tests-pytorch.yml

@@ -53,7 +53,7 @@ jobs:
           image: "pytorchlightning/pytorch_lightning:base-cuda-py3.11-torch2.3-cuda12.1.0"
           PACKAGE_NAME: "pytorch"
         "Lightning | latest":
-          image: "pytorchlightning/pytorch_lightning:base-cuda-py3.12-torch2.4-cuda12.1.0"
+          image: "pytorchlightning/pytorch_lightning:base-cuda-py3.12-torch2.5-cuda12.1.0"
           PACKAGE_NAME: "lightning"
     pool: lit-rtx-3090
     variables:

.github/checkgroup.yml

@@ -21,23 +21,26 @@ subprojects:
     checks:
       - "pl-cpu (macOS-13, lightning, 3.9, 2.1, oldest)"
       - "pl-cpu (macOS-14, lightning, 3.10, 2.1)"
-      - "pl-cpu (macOS-14, lightning, 3.11, 2.2)"
+      - "pl-cpu (macOS-14, lightning, 3.11, 2.2.2)"
       - "pl-cpu (macOS-14, lightning, 3.11, 2.3)"
-      - "pl-cpu (macOS-14, lightning, 3.12, 2.4)"
+      - "pl-cpu (macOS-14, lightning, 3.12, 2.4.1)"
+      - "pl-cpu (macOS-14, lightning, 3.12, 2.5.1)"
       - "pl-cpu (ubuntu-20.04, lightning, 3.9, 2.1, oldest)"
       - "pl-cpu (ubuntu-20.04, lightning, 3.10, 2.1)"
-      - "pl-cpu (ubuntu-20.04, lightning, 3.11, 2.2)"
+      - "pl-cpu (ubuntu-20.04, lightning, 3.11, 2.2.2)"
       - "pl-cpu (ubuntu-20.04, lightning, 3.11, 2.3)"
-      - "pl-cpu (ubuntu-20.04, lightning, 3.12, 2.4)"
+      - "pl-cpu (ubuntu-22.04, lightning, 3.12, 2.4.1)"
+      - "pl-cpu (ubuntu-22.04, lightning, 3.12, 2.5.1)"
       - "pl-cpu (windows-2022, lightning, 3.9, 2.1, oldest)"
       - "pl-cpu (windows-2022, lightning, 3.10, 2.1)"
-      - "pl-cpu (windows-2022, lightning, 3.11, 2.2)"
+      - "pl-cpu (windows-2022, lightning, 3.11, 2.2.2)"
       - "pl-cpu (windows-2022, lightning, 3.11, 2.3)"
-      - "pl-cpu (windows-2022, lightning, 3.12, 2.4)"
+      - "pl-cpu (windows-2022, lightning, 3.12, 2.4.1)"
+      - "pl-cpu (windows-2022, lightning, 3.12, 2.5.1)"
       - "pl-cpu (macOS-14, pytorch, 3.9, 2.1)"
       - "pl-cpu (ubuntu-20.04, pytorch, 3.9, 2.1)"
       - "pl-cpu (windows-2022, pytorch, 3.9, 2.1)"
-      - "pl-cpu (macOS-12, pytorch, 3.10, 2.1)"
+      - "pl-cpu (macOS-13, pytorch, 3.10, 2.1)"
       - "pl-cpu (ubuntu-22.04, pytorch, 3.10, 2.1)"
       - "pl-cpu (windows-2022, pytorch, 3.10, 2.1)"
 
@@ -141,15 +144,17 @@ subprojects:
       - "!*.md"
       - "!**/*.md"
     checks:
-      - "build-cuda (3.11, 2.1, 12.1.0)"
-      - "build-cuda (3.11, 2.2, 12.1.0)"
-      - "build-cuda (3.11, 2.3, 12.1.0)"
-      - "build-cuda (3.12, 2.4, 12.1.0)"
+      - "build-cuda (3.10, 2.1.2, 12.1.0)"
+      - "build-cuda (3.11, 2.2.2, 12.1.0)"
+      - "build-cuda (3.11, 2.3.1, 12.1.0)"
+      - "build-cuda (3.11, 2.4.1, 12.1.0)"
+      - "build-cuda (3.12, 2.5.1, 12.1.0)"
       #- "build-NGC"
-      - "build-pl (3.11, 2.1, 12.1.0)"
+      - "build-pl (3.10, 2.1, 12.1.0)"
       - "build-pl (3.11, 2.2, 12.1.0)"
       - "build-pl (3.11, 2.3, 12.1.0)"
-      - "build-pl (3.12, 2.4, 12.1.0)"
+      - "build-pl (3.11, 2.4, 12.1.0)"
+      - "build-pl (3.12, 2.5, 12.1.0)"
 
   # SECTION: lightning_fabric
 
@@ -168,23 +173,26 @@ subprojects:
     checks:
       - "fabric-cpu (macOS-13, lightning, 3.9, 2.1, oldest)"
       - "fabric-cpu (macOS-14, lightning, 3.10, 2.1)"
-      - "fabric-cpu (macOS-14, lightning, 3.11, 2.2)"
+      - "fabric-cpu (macOS-14, lightning, 3.11, 2.2.2)"
       - "fabric-cpu (macOS-14, lightning, 3.11, 2.3)"
-      - "fabric-cpu (macOS-14, lightning, 3.12, 2.4)"
+      - "fabric-cpu (macOS-14, lightning, 3.12, 2.4.1)"
+      - "fabric-cpu (macOS-14, lightning, 3.12, 2.5.1)"
       - "fabric-cpu (ubuntu-20.04, lightning, 3.9, 2.1, oldest)"
       - "fabric-cpu (ubuntu-20.04, lightning, 3.10, 2.1)"
-      - "fabric-cpu (ubuntu-20.04, lightning, 3.11, 2.2)"
+      - "fabric-cpu (ubuntu-20.04, lightning, 3.11, 2.2.2)"
       - "fabric-cpu (ubuntu-20.04, lightning, 3.11, 2.3)"
-      - "fabric-cpu (ubuntu-20.04, lightning, 3.12, 2.4)"
+      - "fabric-cpu (ubuntu-22.04, lightning, 3.12, 2.4.1)"
+      - "fabric-cpu (ubuntu-22.04, lightning, 3.12, 2.5.1)"
       - "fabric-cpu (windows-2022, lightning, 3.9, 2.1, oldest)"
       - "fabric-cpu (windows-2022, lightning, 3.10, 2.1)"
-      - "fabric-cpu (windows-2022, lightning, 3.11, 2.2)"
+      - "fabric-cpu (windows-2022, lightning, 3.11, 2.2.2)"
       - "fabric-cpu (windows-2022, lightning, 3.11, 2.3)"
-      - "fabric-cpu (windows-2022, lightning, 3.12, 2.4)"
+      - "fabric-cpu (windows-2022, lightning, 3.12, 2.4.1)"
+      - "fabric-cpu (windows-2022, lightning, 3.12, 2.5.1)"
       - "fabric-cpu (macOS-14, fabric, 3.9, 2.1)"
       - "fabric-cpu (ubuntu-20.04, fabric, 3.9, 2.1)"
       - "fabric-cpu (windows-2022, fabric, 3.9, 2.1)"
-      - "fabric-cpu (macOS-12, fabric, 3.10, 2.1)"
+      - "fabric-cpu (macOS-13, fabric, 3.10, 2.1)"
       - "fabric-cpu (ubuntu-22.04, fabric, 3.10, 2.1)"
       - "fabric-cpu (windows-2022, fabric, 3.10, 2.1)"
 
@@ -258,14 +266,14 @@ subprojects:
       - "install-pkg (ubuntu-22.04, lightning, 3.11)"
       - "install-pkg (ubuntu-22.04, notset, 3.9)"
       - "install-pkg (ubuntu-22.04, notset, 3.11)"
-      - "install-pkg (macOS-12, fabric, 3.9)"
-      - "install-pkg (macOS-12, fabric, 3.11)"
-      - "install-pkg (macOS-12, pytorch, 3.9)"
-      - "install-pkg (macOS-12, pytorch, 3.11)"
-      - "install-pkg (macOS-12, lightning, 3.9)"
-      - "install-pkg (macOS-12, lightning, 3.11)"
-      - "install-pkg (macOS-12, notset, 3.9)"
-      - "install-pkg (macOS-12, notset, 3.11)"
+      - "install-pkg (macOS-13, fabric, 3.9)"
+      - "install-pkg (macOS-13, fabric, 3.11)"
+      - "install-pkg (macOS-13, pytorch, 3.9)"
+      - "install-pkg (macOS-13, pytorch, 3.11)"
+      - "install-pkg (macOS-13, lightning, 3.9)"
+      - "install-pkg (macOS-13, lightning, 3.11)"
+      - "install-pkg (macOS-13, notset, 3.9)"
+      - "install-pkg (macOS-13, notset, 3.11)"
       - "install-pkg (windows-2022, fabric, 3.9)"
       - "install-pkg (windows-2022, fabric, 3.11)"
       - "install-pkg (windows-2022, pytorch, 3.9)"

.github/workflows/call-clear-cache.yml

@@ -23,18 +23,18 @@ on:
 jobs:
   cron-clear:
     if: github.event_name == 'schedule' || github.event_name == 'pull_request'
-    uses: Lightning-AI/utilities/.github/workflows/cleanup-caches.yml@v0.11.7
+    uses: Lightning-AI/utilities/.github/workflows/cleanup-caches.yml@v0.11.8
     with:
-      scripts-ref: v0.11.7
+      scripts-ref: v0.11.8
       dry-run: ${{ github.event_name == 'pull_request' }}
       pattern: "latest|docs"
       age-days: 7
 
   direct-clear:
     if: github.event_name == 'workflow_dispatch' || github.event_name == 'pull_request'
-    uses: Lightning-AI/utilities/.github/workflows/cleanup-caches.yml@v0.11.7
+    uses: Lightning-AI/utilities/.github/workflows/cleanup-caches.yml@v0.11.8
     with:
-      scripts-ref: v0.11.7
+      scripts-ref: v0.11.8
       dry-run: ${{ github.event_name == 'pull_request' }}
       pattern: ${{ inputs.pattern || 'pypi_wheels' }} # setting str in case of PR / debugging
       age-days: ${{ fromJSON(inputs.age-days) || 0 }} # setting 0 in case of PR / debugging

.github/workflows/ci-check-md-links.yml

@@ -14,7 +14,7 @@ on:
 
 jobs:
   check-md-links:
-    uses: Lightning-AI/utilities/.github/workflows/check-md-links.yml@v0.11.7
+    uses: Lightning-AI/utilities/.github/workflows/check-md-links.yml@v0.11.8
     with:
       config-file: ".github/markdown-links-config.json"
       base-branch: "master"

.github/workflows/ci-pkg-install.yml

@@ -42,7 +42,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        os: ["ubuntu-22.04", "macOS-12", "windows-2022"]
+        os: ["ubuntu-22.04", "macOS-13", "windows-2022"]
         pkg-name: ["fabric", "pytorch", "lightning", "notset"]
         python-version: ["3.9", "3.11"]
     steps:

.github/workflows/ci-schema.yml

@@ -8,7 +8,7 @@ on:
 
 jobs:
   check:
-    uses: Lightning-AI/utilities/.github/workflows/check-schema.yml@v0.11.7
+    uses: Lightning-AI/utilities/.github/workflows/check-schema.yml@v0.11.8
     with:
       # skip azure due to the wrong schema file by MSFT
       # https://github.com/Lightning-AI/lightning-flash/pull/1455#issuecomment-1244793607

.github/workflows/ci-tests-fabric.yml

@@ -43,17 +43,20 @@ jobs:
           - { os: "macOS-14", pkg-name: "lightning", python-version: "3.10", pytorch-version: "2.1" }
           - { os: "ubuntu-20.04", pkg-name: "lightning", python-version: "3.10", pytorch-version: "2.1" }
           - { os: "windows-2022", pkg-name: "lightning", python-version: "3.10", pytorch-version: "2.1" }
-          - { os: "macOS-14", pkg-name: "lightning", python-version: "3.11", pytorch-version: "2.2" }
-          - { os: "ubuntu-20.04", pkg-name: "lightning", python-version: "3.11", pytorch-version: "2.2" }
-          - { os: "windows-2022", pkg-name: "lightning", python-version: "3.11", pytorch-version: "2.2" }
+          - { os: "macOS-14", pkg-name: "lightning", python-version: "3.11", pytorch-version: "2.2.2" }
+          - { os: "ubuntu-20.04", pkg-name: "lightning", python-version: "3.11", pytorch-version: "2.2.2" }
+          - { os: "windows-2022", pkg-name: "lightning", python-version: "3.11", pytorch-version: "2.2.2" }
           - { os: "macOS-14", pkg-name: "lightning", python-version: "3.11", pytorch-version: "2.3" }
           - { os: "ubuntu-20.04", pkg-name: "lightning", python-version: "3.11", pytorch-version: "2.3" }
           - { os: "windows-2022", pkg-name: "lightning", python-version: "3.11", pytorch-version: "2.3" }
-          - { os: "macOS-14", pkg-name: "lightning", python-version: "3.12", pytorch-version: "2.4" }
-          - { os: "ubuntu-20.04", pkg-name: "lightning", python-version: "3.12", pytorch-version: "2.4" }
-          - { os: "windows-2022", pkg-name: "lightning", python-version: "3.12", pytorch-version: "2.4" }
+          - { os: "macOS-14", pkg-name: "lightning", python-version: "3.12", pytorch-version: "2.4.1" }
+          - { os: "ubuntu-22.04", pkg-name: "lightning", python-version: "3.12", pytorch-version: "2.4.1" }
+          - { os: "windows-2022", pkg-name: "lightning", python-version: "3.12", pytorch-version: "2.4.1" }
+          - { os: "macOS-14", pkg-name: "lightning", python-version: "3.12", pytorch-version: "2.5.1" }
+          - { os: "ubuntu-22.04", pkg-name: "lightning", python-version: "3.12", pytorch-version: "2.5.1" }
+          - { os: "windows-2022", pkg-name: "lightning", python-version: "3.12", pytorch-version: "2.5.1" }
           # only run PyTorch latest with Python latest, use Fabric scope to limit dependency issues
-          - { os: "macOS-12", pkg-name: "fabric", python-version: "3.10", pytorch-version: "2.1" }
+          - { os: "macOS-13", pkg-name: "fabric", python-version: "3.10", pytorch-version: "2.1" }
           - { os: "ubuntu-22.04", pkg-name: "fabric", python-version: "3.10", pytorch-version: "2.1" }
           - { os: "windows-2022", pkg-name: "fabric", python-version: "3.10", pytorch-version: "2.1" }
           # "oldest" versions tests, only on minimum Python

.github/workflows/ci-tests-pytorch.yml

@@ -47,17 +47,20 @@ jobs:
           - { os: "macOS-14", pkg-name: "lightning", python-version: "3.10", pytorch-version: "2.1" }
           - { os: "ubuntu-20.04", pkg-name: "lightning", python-version: "3.10", pytorch-version: "2.1" }
           - { os: "windows-2022", pkg-name: "lightning", python-version: "3.10", pytorch-version: "2.1" }
-          - { os: "macOS-14", pkg-name: "lightning", python-version: "3.11", pytorch-version: "2.2" }
-          - { os: "ubuntu-20.04", pkg-name: "lightning", python-version: "3.11", pytorch-version: "2.2" }
-          - { os: "windows-2022", pkg-name: "lightning", python-version: "3.11", pytorch-version: "2.2" }
+          - { os: "macOS-14", pkg-name: "lightning", python-version: "3.11", pytorch-version: "2.2.2" }
+          - { os: "ubuntu-20.04", pkg-name: "lightning", python-version: "3.11", pytorch-version: "2.2.2" }
+          - { os: "windows-2022", pkg-name: "lightning", python-version: "3.11", pytorch-version: "2.2.2" }
           - { os: "macOS-14", pkg-name: "lightning", python-version: "3.11", pytorch-version: "2.3" }
           - { os: "ubuntu-20.04", pkg-name: "lightning", python-version: "3.11", pytorch-version: "2.3" }
           - { os: "windows-2022", pkg-name: "lightning", python-version: "3.11", pytorch-version: "2.3" }
-          - { os: "macOS-14", pkg-name: "lightning", python-version: "3.12", pytorch-version: "2.4" }
-          - { os: "ubuntu-20.04", pkg-name: "lightning", python-version: "3.12", pytorch-version: "2.4" }
-          - { os: "windows-2022", pkg-name: "lightning", python-version: "3.12", pytorch-version: "2.4" }
+          - { os: "macOS-14", pkg-name: "lightning", python-version: "3.12", pytorch-version: "2.4.1" }
+          - { os: "ubuntu-22.04", pkg-name: "lightning", python-version: "3.12", pytorch-version: "2.4.1" }
+          - { os: "windows-2022", pkg-name: "lightning", python-version: "3.12", pytorch-version: "2.4.1" }
+          - { os: "macOS-14", pkg-name: "lightning", python-version: "3.12", pytorch-version: "2.5.1" }
+          - { os: "ubuntu-22.04", pkg-name: "lightning", python-version: "3.12", pytorch-version: "2.5.1" }
+          - { os: "windows-2022", pkg-name: "lightning", python-version: "3.12", pytorch-version: "2.5.1" }
           # only run PyTorch latest with Python latest, use PyTorch scope to limit dependency issues
-          - { os: "macOS-12", pkg-name: "pytorch", python-version: "3.10", pytorch-version: "2.1" }
+          - { os: "macOS-13", pkg-name: "pytorch", python-version: "3.10", pytorch-version: "2.1" }
           - { os: "ubuntu-22.04", pkg-name: "pytorch", python-version: "3.10", pytorch-version: "2.1" }
           - { os: "windows-2022", pkg-name: "pytorch", python-version: "3.10", pytorch-version: "2.1" }
           # "oldest" versions tests, only on minimum Python

.github/workflows/docker-build.yml

@@ -43,10 +43,11 @@ jobs:
         include:
           # We only release one docker image per PyTorch version.
           # Make sure the matrix here matches the one below.
-          - { python_version: "3.11", pytorch_version: "2.1", cuda_version: "12.1.0" }
+          - { python_version: "3.10", pytorch_version: "2.1", cuda_version: "12.1.0" }
           - { python_version: "3.11", pytorch_version: "2.2", cuda_version: "12.1.0" }
           - { python_version: "3.11", pytorch_version: "2.3", cuda_version: "12.1.0" }
-          - { python_version: "3.12", pytorch_version: "2.4", cuda_version: "12.1.0" }
+          - { python_version: "3.11", pytorch_version: "2.4", cuda_version: "12.1.0" }
+          - { python_version: "3.12", pytorch_version: "2.5", cuda_version: "12.1.0" }
     steps:
       - uses: actions/checkout@v4
         with:
@@ -103,10 +104,11 @@ jobs:
         include:
           # These are the base images for PL release docker images.
           # Make sure the matrix here matches the one above.
-          - { python_version: "3.11", pytorch_version: "2.1", cuda_version: "12.1.0" }
-          - { python_version: "3.11", pytorch_version: "2.2", cuda_version: "12.1.0" }
-          - { python_version: "3.11", pytorch_version: "2.3", cuda_version: "12.1.0" }
-          - { python_version: "3.12", pytorch_version: "2.4", cuda_version: "12.1.0" }
+          - { python_version: "3.10", pytorch_version: "2.1.2", cuda_version: "12.1.0" }
+          - { python_version: "3.11", pytorch_version: "2.2.2", cuda_version: "12.1.0" }
+          - { python_version: "3.11", pytorch_version: "2.3.1", cuda_version: "12.1.0" }
+          - { python_version: "3.11", pytorch_version: "2.4.1", cuda_version: "12.1.0" }
+          - { python_version: "3.12", pytorch_version: "2.5.1", cuda_version: "12.1.0" }
     steps:
       - uses: actions/checkout@v4
       - uses: docker/setup-buildx-action@v3
@@ -115,6 +117,12 @@ jobs:
         with:
           username: ${{ secrets.DOCKER_USERNAME }}
           password: ${{ secrets.DOCKER_PASSWORD }}
+
+      - name: shorten Torch version
+        run: |
+          # convert 1.10.2 to 1.10
+          pt_version=$(echo ${{ matrix.pytorch_version }} | cut -d. -f1,2)
+          echo "PT_VERSION=$pt_version" >> $GITHUB_ENV
       - uses: docker/build-push-action@v6
         with:
           build-args: |
@@ -123,7 +131,7 @@ jobs:
             CUDA_VERSION=${{ matrix.cuda_version }}
           file: dockers/base-cuda/Dockerfile
           push: ${{ env.PUSH_NIGHTLY }}
-          tags: "pytorchlightning/pytorch_lightning:base-cuda-py${{ matrix.python_version }}-torch${{ matrix.pytorch_version }}-cuda${{ matrix.cuda_version }}"
+          tags: "pytorchlightning/pytorch_lightning:base-cuda-py${{ matrix.python_version }}-torch${{ env.PT_VERSION }}-cuda${{ matrix.cuda_version }}"
         timeout-minutes: 95
       - uses: ravsamhq/notify-slack-action@v2
         if: failure() && env.PUSH_NIGHTLY == 'true'

.pre-commit-config.yaml

@@ -58,7 +58,7 @@ repos:
         #args: ["--write-changes"] # uncomment if you want to get automatic fixing
 
   - repo: https://github.com/PyCQA/docformatter
-    rev: v1.7.5
+    rev: 06907d0267368b49b9180eed423fae5697c1e909 # todo: fix for docformatter after last 1.7.5
     hooks:
       - id: docformatter
         additional_dependencies: [tomli]

docs/source-fabric/fundamentals/launch.rst

@@ -116,7 +116,7 @@ This is essentially the same as running ``python path/to/your/script.py``, but i
                                       machine.
       --precision [16-mixed|bf16-mixed|32-true|64-true|64|32|16|bf16]
                                       Double precision (``64-true`` or ``64``),
-                                      full precision (``32-true`` or ``64``), half
+                                      full precision (``32-true`` or ``32``), half
                                       precision (``16-mixed`` or ``16``) or
                                       bfloat16 precision (``bf16-mixed`` or
                                       ``bf16``)

docs/source-pytorch/accelerators/tpu_advanced.rst

@@ -52,7 +52,7 @@ Example:
     model = WeightSharingModule()
     trainer = Trainer(max_epochs=1, accelerator="tpu")
 
-See `XLA Documentation <https://github.com/pytorch/xla/blob/master/TROUBLESHOOTING.md#xla-tensor-quirks>`_
+See `XLA Documentation <https://github.com/pytorch/xla/blob/v2.5.0/TROUBLESHOOTING.md#xla-tensor-quirks>`_
 
 ----
 
@@ -61,4 +61,4 @@ XLA
 XLA is the library that interfaces PyTorch with the TPUs.
 For more information check out `XLA <https://github.com/pytorch/xla>`_.
 
-Guide for `troubleshooting XLA <https://github.com/pytorch/xla/blob/master/TROUBLESHOOTING.md>`_
+Guide for `troubleshooting XLA <https://github.com/pytorch/xla/blob/v2.5.0/TROUBLESHOOTING.md>`_

docs/source-pytorch/accelerators/tpu_basic.rst

@@ -108,7 +108,7 @@ There are cases in which training on TPUs is slower when compared with GPUs, for
 - XLA Graph compilation during the initial steps `Reference <https://github.com/pytorch/xla/issues/2383#issuecomment-666519998>`_
 - Some tensor ops are not fully supported on TPU, or not supported at all. These operations will be performed on CPU (context switch).
 
-The official PyTorch XLA `performance guide <https://github.com/pytorch/xla/blob/master/TROUBLESHOOTING.md#known-performance-caveats>`_
+The official PyTorch XLA `performance guide <https://github.com/pytorch/xla/blob/v2.5.0/TROUBLESHOOTING.md#known-performance-caveats>`_
 has more detailed information on how PyTorch code can be optimized for TPU. In particular, the
-`metrics report <https://github.com/pytorch/xla/blob/master/TROUBLESHOOTING.md#get-a-metrics-report>`_ allows
+`metrics report <https://github.com/pytorch/xla/blob/v2.5.0/TROUBLESHOOTING.md#get-a-metrics-report>`_ allows
 one to identify operations that lead to context switching.