pytorch/scripts
Xuehai Pan 4dce5b71a0 [build] modernize build-frontend: python setup.py develop/install -> [uv ]pip install --no-build-isolation [-e ]. (#156027)
Modernize the development installation:

```bash
# python setup.py develop
python -m pip install --no-build-isolation -e .

# python setup.py install
python -m pip install --no-build-isolation .
```

Now, the `python setup.py develop` is a wrapper around `python -m pip install -e .` since `setuptools>=80.0`:

- pypa/setuptools#4955

`python setup.py install` is deprecated and will emit a warning during run. The warning will become an error on October 31, 2025.

- 9c4d383631/setuptools/command/install.py (L58-L67)

> ```python
> SetuptoolsDeprecationWarning.emit(
>     "setup.py install is deprecated.",
>     """
>     Please avoid running ``setup.py`` directly.
>     Instead, use pypa/build, pypa/installer or other
>     standards-based tools.
>     """,
>     see_url="https://blog.ganssle.io/articles/2021/10/setup-py-deprecated.html",
>     due_date=(2025, 10, 31),
> )
> ```

- pypa/setuptools#3849

Additional Resource:

- [Why you shouldn't invoke setup.py directly](https://blog.ganssle.io/articles/2021/10/setup-py-deprecated.html)

Pull Request resolved: https://github.com/pytorch/pytorch/pull/156027
Approved by: https://github.com/ezyang
2025-07-09 11:24:27 +00:00
..
analysis
compile_tests [dynamo][ci] update PYTORCH_TEST_WITH_DYNAMO xfail/skips script for 3.13 (#155570) 2025-06-11 19:09:29 +00:00
export [BE][CI] bump ruff to 0.9.2: multiline assert statements (#144546) 2025-02-27 20:46:16 +00:00
fbcode-dev-setup
jit [BE] fix typos in functorch/ and scripts/ (#156081) 2025-06-21 02:47:40 +00:00
onnx [build] modernize build-frontend: python setup.py develop/install -> [uv ]pip install --no-build-isolation [-e ]. (#156027) 2025-07-09 11:24:27 +00:00
release [release] delete tag-docker-images.sh as not required anymore (#156737) 2025-06-25 15:17:06 +00:00
release_notes [BE] fix typos in functorch/ and scripts/ (#156081) 2025-06-21 02:47:40 +00:00
add_apache_header.sh
apache_header.txt
apache_python.txt
build_android_gradle.sh
build_android.sh [BE] fix typos in functorch/ and scripts/ (#156081) 2025-06-21 02:47:40 +00:00
build_host_protoc.sh
build_ios.sh
build_local.sh
build_mobile.sh [BE] fix typos in functorch/ and scripts/ (#156081) 2025-06-21 02:47:40 +00:00
build_pytorch_android.sh
build_raspbian.sh
build_tegra_x1.sh
build_tizen.sh Fix broken URLs (#152237) 2025-04-27 09:56:42 +00:00
build_windows.bat
diagnose_protobuf.py
get_python_cmake_flags.py
install_triton_wheel.sh [XPU] Simplify XPU make triton by install from PyTorch source (#155675) 2025-06-12 13:02:23 +00:00
lint_urls.sh Update lint_urls.sh (#154838) 2025-06-02 14:50:34 +00:00
lint_xrefs.sh Re-enable link linter (#153280) 2025-05-23 20:56:25 +00:00
proto.ps1
README.md
remove_apache_header.sh
temp.sh
xcode_build.rb Update XNNPACK Version (#139913) 2024-11-18 18:16:31 +00:00

This directory contains the useful tools.

build_android.sh

This script is to build PyTorch/Caffe2 library for Android. Take the following steps to start the build:

  • set ANDROID_NDK to the location of ndk
export ANDROID_NDK=YOUR_NDK_PATH
  • run build_android.sh
#in your PyTorch root directory
bash scripts/build_android.sh

If succeeded, the libraries and headers would be generated to build_android/install directory. You can then copy these files from build_android/install to your Android project for further usage.

You can also override the cmake flags via command line, e.g., following command will also compile the executable binary files:

bash scripts/build_android.sh -DBUILD_BINARY=ON

build_ios.sh

This script is to build PyTorch/Caffe2 library for iOS, and can only be performed on macOS. Take the following steps to start the build:

  • Install Xcode from App Store, and configure "Command Line Tools" properly on Xcode.
  • Install the dependencies:
brew install cmake automake libtool
  • run build_ios.sh
#in your PyTorch root directory
bash scripts/build_ios.sh

If succeeded, the libraries and headers would be generated to build_ios/install directory. You can then copy these files to your Xcode project for further usage.