pytorch · zklaus · Apr 24, 2025 · Apr 24, 2025 · Apr 30, 2025 · May 1, 2025
@@ -383,7 +383,7 @@ if [[ -n "${CI:-}" ]]; then
 fi
 
 # Build image
-docker build \
+tar ch . | docker build \
        ${no_cache_flag} \
        ${progress_flag} \
        --build-arg "BUILD_ENVIRONMENT=${image}" \
@@ -422,7 +422,7 @@ docker build \
        -f $(dirname ${DOCKERFILE})/Dockerfile \
        -t "$tmp_tag" \
        "$@" \
-       .
+       -
 
 # NVIDIA dockers for RC releases use tag names like `11.0-cudnn9-devel-ubuntu18.04-rc`,
 # for this case we will set UBUNTU_VERSION to `18.04-rc` so that the Dockerfile could

@@ -0,0 +1 @@
+../../docs/requirements.txt
@@ -35,6 +35,7 @@ jobs:
       contents: write
     outputs:
       pt_release_name: ${{ steps.release_name.outputs.pt_release_name }}
+      pt_pep517_release_name: ${{ steps.release_name.outputs.pt_pep517_release_name }}
     steps:
       - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
         with:
@@ -53,36 +54,57 @@ jobs:
           tag_or_branch="${tag_or_branch#refs/heads/}"
           # replace directory separators with _ in branch name
           tag_or_branch="${tag_or_branch//\//_}"
-          echo "PT_RELEASE_NAME=pytorch-$tag_or_branch" >> "$GITHUB_ENV"
-          echo "PT_RELEASE_FILE=pytorch-$tag_or_branch.tar.gz" >> "$GITHUB_ENV"
+          torch_version="$(python -c 'from tools.generate_torch_version import get_torch_version; print(get_torch_version())')"
+          {
+            echo "PT_RELEASE_NAME=pytorch-$tag_or_branch";
+            echo "PT_RELEASE_FILE=pytorch-$tag_or_branch.tar.gz";
+            echo "PT_PEP517_RELEASE_FILE=torch-${torch_version}.tar.gz";
+          } >> "$GITHUB_ENV"
       - name: Checkout optional submodules
         run: python3 tools/optional_submodules.py
       - name: Create source distribution
         run: |
-            # Create new folder with specified name so extracting the archive yields that
-            rm -rf "/tmp/$PT_RELEASE_NAME"
-            cp -r "$PWD" "/tmp/$PT_RELEASE_NAME"
-            mv "/tmp/$PT_RELEASE_NAME" .
-            # Cleanup
-            rm -rf "$PT_RELEASE_NAME"/{.circleci,.ci}
-            find "$PT_RELEASE_NAME" -name '.git*' -exec rm -rv {} \; || true
-            # Create archive
-            tar -czf "$PT_RELEASE_FILE" "$PT_RELEASE_NAME"
-            echo "Created source archive $PT_RELEASE_FILE with content: $(ls -a "$PT_RELEASE_NAME")"
+          # Create new folder with specified name so extracting the archive yields that
+          rm -rf "/tmp/$PT_RELEASE_NAME"
+          cp -r "$PWD" "/tmp/$PT_RELEASE_NAME"
+          mv "/tmp/$PT_RELEASE_NAME" .
+          # Cleanup
+          rm -rf "$PT_RELEASE_NAME"/{.circleci,.ci}
+          find "$PT_RELEASE_NAME" -name '.git*' -exec rm -rv {} \; || true
+          # Create archive
+          tar -czf "$PT_RELEASE_FILE" "$PT_RELEASE_NAME"
+          echo "Created source archive $PT_RELEASE_FILE with content: $(ls -a "$PT_RELEASE_NAME")"
+      - name: Create PEP 517 compatible source distribution
+        run: |
+          pip install build==1.2.2.post1 || exit 1
+          python -m build --sdist || exit 1
+          cd dist || exit 1
       - name: Upload source distribution for release
         if: ${{ github.event_name == 'release' }}
         uses: softprops/action-gh-release@da05d552573ad5aba039eaac05058a918a7bf631 # v2.2.2
         with:
-          files: ${{env.PT_RELEASE_FILE}}
+          files: |
+            ${{ env.PT_RELEASE_FILE }}
+            ${{ env.PT_PEP517_RELEASE_FILE }}
       - name: Upload source distribution to GHA artifacts for release tags
         if: ${{ github.event_name == 'push' && startsWith(github.ref, 'refs/tags/v') && contains(github.ref, 'rc') }}
         uses: actions/upload-artifact@50769540e7f4bd5e21e526ee35c689e35e0d6874 # v4.4.0
         with:
           name: ${{ env.PT_RELEASE_FILE }}
           path: ${{ env.PT_RELEASE_FILE }}
+      - name: Upload PEP 517 source distribution to GHA artifacts for release tags
+        if: ${{ github.event_name == 'push' && startsWith(github.ref, 'refs/tags/v') && contains(github.ref, 'rc') }}
+        uses: actions/upload-artifact@50769540e7f4bd5e21e526ee35c689e35e0d6874 # v4.4.0
+        with:
+          name: ${{ env.PT_PEP517_RELEASE_FILE }}
+          path: dist/${{ env.PT_PEP517_RELEASE_FILE }}
       - name: Set output
         id: release_name
-        run: echo "pt_release_name=${{ env.PT_RELEASE_NAME }}.tar.gz" >> "${GITHUB_OUTPUT}"
+        run: |
+          {
+            echo "pt_release_name=${{ env.PT_RELEASE_FILE }}";
+            echo "pt_pep517_release_name=${{ env.PT_PEP517_RELEASE_FILE }}";
+          } >> "${GITHUB_OUTPUT}"
 
   upload_source_code_to_s3:
     if: ${{ github.repository == 'pytorch/pytorch' && github.event_name == 'push' && startsWith(github.ref, 'refs/tags/v') && contains(github.ref, 'rc') }}
@@ -98,6 +120,9 @@ jobs:
       - uses: actions/download-artifact@65a9edc5881444af0b9093a5e628f2fe47ea3b2e # v4.1.7
         with:
           name: ${{ needs.release.outputs.pt_release_name }}
+      - uses: actions/download-artifact@65a9edc5881444af0b9093a5e628f2fe47ea3b2e # v4.1.7
+        with:
+          name: ${{ needs.release.outputs.pt_pep517_release_name }}
       - name: Configure AWS credentials(PyTorch account)
         uses: aws-actions/configure-aws-credentials@ececac1a45f3b08a01d2dd070d28d111c5fe6722 # v4.1.0
         with:
@@ -108,7 +133,9 @@ jobs:
           s3-bucket: pytorch
           s3-prefix: source_code/test
           if-no-files-found: warn
-          path: ${{ needs.release.outputs.pt_release_name }}
+          path: |
+            ${{ needs.release.outputs.pt_release_name }}
+            ${{ needs.release.outputs.pt_pep517_release_name }}
 
 concurrency:
   group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.sha }}-${{ github.event_name }}

diff --git a/MANIFEST.in b/MANIFEST.in
@@ -1,50 +1,100 @@
 # Reference: https://setuptools.pypa.io/en/latest/userguide/miscellaneous.html
 
-# Include source files in SDist
-include CMakeLists.txt
-include *.bzl *.bazel .bazel* BUILD *.BUILD BUILD.* WORKSPACE
-include BUCK BUCK.*
-include requirements*.txt
-include version.txt
-include [Mm]akefile *.[Mm]akefile [Mm]akefile.*
-include [Dd]ockerfile *.[Dd]ockerfile [Dd]ockerfile.* .dockerignore
+# Include individual top-level files
+include MANIFEST.in
+include CITATION.cff
+include CODEOWNERS
+include Dockerfile
+include LICENSE
+include Makefile
+include NOTICE
+include .clang-format .clang-tidy
+include .cmakelintrc
+include .coveragerc
+include .dockerignore
+include .flake8
+include .gdbinit
+include .lintrunner.toml
+include .lldbinit
+include docker.Makefile
+include ubsan.supp
+
+# Include bazel and BUCK related files
+include BUILD.bazel BUCK.oss
+include WORKSPACE
+include *.bzl
+include .bazelignore .bazelrc .bazelversion
+
+# Include general configuration files
+include *.ini
+# Include important top-level information
+include *.md
+# Include technical text files at the moment, comprises
+# version.txt, CMakeLists.txt, requirements.txt
+include *.txt
+
+# Include ctags configuration
+include .ctags.d/*.ctags
+
+# Include subfolders completely
+graft .devcontainer
+graft .vscode
 graft android
+# The following folder (assets) is empty except for a .gitignore file, which
+# will not be included in the sdist, hence we include the directory explicitly.
+include android/test_app/app/src/main/assets
 graft aten
 graft binaries
 graft c10
 graft caffe2
 graft cmake
-graft functorch
-graft third_party
-graft tools
 graft torch
+graft tools
+graft test
+graft docs
+graft ios
+graft third_party
+graft test
+graft benchmarks
+graft scripts
+graft mypy_plugins
+graft modules
+graft functorch
 graft torchgen
 # FIXME: torch-xla codegen build failure if include this file in wheel
-exclude torchgen/BUILD.bazel
+# exclude torchgen/BUILD.bazel
 
-# Misc files and directories in SDist
-include *.md
-include CITATION.cff
-include LICENSE NOTICE
-include mypy*.ini
-graft benchmarks
-graft docs
-graft mypy_plugins
-graft scripts
+# The following exclusions omit parts from third-party dependencies that
+# contain invalid symlinks[1] and that are not needed for pytorch, such as
+# bindings for unused languages
+prune third_party/ittapi/rust
+prune third_party/flatbuffers/java
+prune third_party/flatbuffers/kotlin
+prune third_party/nccl/pkg/debian
+prune third_party/opentelemetry-cpp/third_party/prometheus-cpp/cmake/project-import-*
+
+# The following document is also an invalid symlink[1] and superfluous
+exclude third_party/flatbuffers/docs/source/CONTRIBUTING.md
+
+# Omit autogenerated code
+prune torchgen/packaged
+
+# Omit caches, compiled, and scm related content
+prune */__pycache__
+prune **/.github
+prune **/.gitlab
+global-exclude *.o *.obj *.so *.dylib *.a *.pxd *.dll *.lib
+global-exclude *.py[cod] *.swp *~
+global-exclude .git .git-blame-ignore-revs .gitattributes .gitignore .gitmodules
+global-exclude .gitlab-ci.yml
 
 # Misc files needed for custom setuptools command
 include .gitignore
 include .gitmodules
 
-# Include test suites in SDist
-graft test
-include pytest.ini
-include .coveragerc
-
-# Prune generated/compiled files
-prune torchgen/packaged
-prune */__pycache__
-global-exclude *.o *.obj *.so *.a *.dylib *.pxd *.dll *.lib *.py[cod]
+# [1] Invalid symlinks for the purposes of Python source distributions are,
+# according to the source distribution format[2] links pointing outside the
+# destination directory or links with a `..` component, which is those of
+# concern here.
 
-prune */.git
-global-exclude .git *~ *.swp
+# [2] https://packaging.python.org/en/latest/specifications/source-distribution-format/#source-distribution-archive-features
diff --git a/docs/requirements.txt b/docs/requirements.txt
diff --git a/docs/requirements.txt b/docs/requirements.txt
@@ -0,0 +1,61 @@
+sphinx==5.3.0
+#Description: This is used to generate PyTorch docs
+#Pinned versions: 5.3.0
+-e git+https://github.com/pytorch/pytorch_sphinx_theme.git@pytorch_sphinx_theme2#egg=pytorch_sphinx_theme2
+
+# TODO: sphinxcontrib.katex 0.9.0 adds a local KaTeX server to speed up pre-rendering
+# but it doesn't seem to work and hangs around idly. The initial thought is probably
+# something related to Docker setup. We can investigate this later
+
+sphinxcontrib.katex==0.8.6
+#Description: This is used to generate PyTorch docs
+#Pinned versions: 0.8.6
+
+sphinxext-opengraph==0.9.1
+#Description: This is used to generate PyTorch docs
+#Pinned versions: 0.9.1
+
+sphinx_sitemap==2.6.0
+#Description: This is used to generate sitemap for PyTorch docs
+#Pinned versions: 2.6.0
+
+matplotlib==3.5.3 ; python_version < "3.13"
+matplotlib==3.6.3 ; python_version >= "3.13"
+#Description: This is used to generate PyTorch docs
+#Pinned versions: 3.6.3 if python > 3.12. Otherwise 3.5.3.
+
+tensorboard==2.13.0 ; python_version < "3.13"
+tensorboard==2.18.0 ; python_version >= "3.13"
+#Description: This is used to generate PyTorch docs
+#Pinned versions: 2.13.0
+
+breathe==4.34.0
+#Description: This is used to generate PyTorch C++ docs
+#Pinned versions: 4.34.0
+
+exhale==0.2.3
+#Description: This is used to generate PyTorch C++ docs
+#Pinned versions: 0.2.3
+
+docutils==0.16
+#Description: This is used to generate PyTorch C++ docs
+#Pinned versions: 0.16
+
+bs4==0.0.1
+#Description: This is used to generate PyTorch C++ docs
+#Pinned versions: 0.0.1
+
+IPython==8.12.0
+#Description: This is used to generate PyTorch functorch docs
+#Pinned versions: 8.12.0
+
+myst-nb==0.17.2
+#Description: This is used to generate PyTorch functorch docs
+#Pinned versions: 0.13.2
+
+# The following are required to build torch.distributed.elastic.rendezvous.etcd* docs
+python-etcd==0.4.5
+sphinx-copybutton==0.5.0
+sphinx-design==0.4.0
+sphinxcontrib-mermaid==1.0.0
+myst-parser==0.18.1
diff --git a/functorch/docs/source/notebooks b/functorch/docs/source/notebooks
diff --git a/functorch/notebooks/_src/plot_ensembling.py → .../source/notebooks/_src/plot_ensembling.py b/functorch/notebooks/_src/plot_ensembling.py → .../source/notebooks/_src/plot_ensembling.py
diff --git a/...books/_src/plot_jacobians_and_hessians.py → ...books/_src/plot_jacobians_and_hessians.py b/...books/_src/plot_jacobians_and_hessians.py → ...books/_src/plot_jacobians_and_hessians.py
diff --git a/...tebooks/_src/plot_per_sample_gradients.py → ...tebooks/_src/plot_per_sample_gradients.py b/...tebooks/_src/plot_per_sample_gradients.py → ...tebooks/_src/plot_per_sample_gradients.py
diff --git a/...otebooks/aot_autograd_optimizations.ipynb → ...otebooks/aot_autograd_optimizations.ipynb b/...otebooks/aot_autograd_optimizations.ipynb → ...otebooks/aot_autograd_optimizations.ipynb
diff --git a/functorch/notebooks/ensembling.ipynb → ...ch/docs/source/notebooks/ensembling.ipynb b/functorch/notebooks/ensembling.ipynb → ...ch/docs/source/notebooks/ensembling.ipynb
diff --git a/functorch/notebooks/jacobians_hessians.ipynb → ...source/notebooks/jacobians_hessians.ipynb b/functorch/notebooks/jacobians_hessians.ipynb → ...source/notebooks/jacobians_hessians.ipynb
diff --git a/functorch/notebooks/minifier.ipynb → ...orch/docs/source/notebooks/minifier.ipynb b/functorch/notebooks/minifier.ipynb → ...orch/docs/source/notebooks/minifier.ipynb
diff --git a/...ch/notebooks/neural_tangent_kernels.ipynb → ...ce/notebooks/neural_tangent_kernels.ipynb b/...ch/notebooks/neural_tangent_kernels.ipynb → ...ce/notebooks/neural_tangent_kernels.ipynb
diff --git a/functorch/notebooks/per_sample_grads.ipynb → ...s/source/notebooks/per_sample_grads.ipynb b/functorch/notebooks/per_sample_grads.ipynb → ...s/source/notebooks/per_sample_grads.ipynb
diff --git a/functorch/notebooks/whirlwind_tour.ipynb → ...ocs/source/notebooks/whirlwind_tour.ipynb b/functorch/notebooks/whirlwind_tour.ipynb → ...ocs/source/notebooks/whirlwind_tour.ipynb
diff --git a/functorch/notebooks b/functorch/notebooks
@@ -0,0 +1 @@
+docs/source/notebooks