在 Windows 上从源代码构建

从源代码构建 TensorFlow pip 包并将其安装在 Windows 上。

Windows 环境设置

安装以下构建工具以配置您的 Windows 开发环境。

安装 Python 和 TensorFlow 软件包依赖项

安装 适用于 Windows 的 Python 3.9+ 64 位版本。选择 pip 作为可选功能，并将其添加到您的 %PATH% 环境变量中。

安装 TensorFlow pip 软件包依赖项

pip3 install -U pip
pip3 install -U six numpy wheel packaging
pip3 install -U keras_preprocessing --no-deps

依赖项列表位于 REQUIRED_PACKAGES 下的 setup.py 文件中。

安装 Bazel

安装 Bazel，这是用于编译 TensorFlow 的构建工具。有关 Bazel 版本，请参阅 Windows 的 已测试构建配置。配置 Bazel 以 构建 C++。

将 Bazel 可执行文件的位置添加到您的 %PATH% 环境变量中。

安装 MSYS2

安装 MSYS2 以获取构建 TensorFlow 所需的 bin 工具。如果 MSYS2 安装在 C:\msys64，请将 C:\msys64\usr\bin 添加到您的 %PATH% 环境变量中。然后，使用 cmd.exe 运行

pacman -Syu (requires a console restart)
pacman -S git patch unzip
pacman -S git patch unzip rsync

安装 Visual C++ Build Tools 2022

安装 Visual C++ build tools 2022。此工具随 Visual Studio Community 2022 一起提供，也可以单独安装。

1. 前往 Visual Studio 下载页面，
2. 选择 Visual Studio 或其他工具、框架和可再发行组件的工具，
3. 下载并安装
   • Visual Studio 2022 构建工具
   • 适用于 Visual Studio 2022 的 Microsoft Visual C++ 可再发行组件

安装 LLVM

1. 前往 LLVM 下载页面，
2. 下载并安装 Windows 兼容的 LLVM（例如 LLVM-17.0.6-win64.exe），安装路径设为 C:/Program Files/LLVM

安装 GPU 支持（可选）

请参阅 Windows GPU 支持 指南，以安装在 GPU 上运行 TensorFlow 所需的驱动程序和其他软件。

下载 TensorFlow 源代码

使用 Git 克隆 TensorFlow 仓库（git 随 MSYS2 一起安装）

git clone https://github.com/tensorflow/tensorflow.git
cd tensorflow

仓库默认使用 master 开发分支。您也可以检出 发布分支 进行构建。

git checkout branch_name  # r1.9, r1.10, etc.

可选：环境变量设置

在运行构建命令之前，请运行以下命令以避免软件包创建过程中出现问题：（如果在安装软件包时已设置了以下命令，请忽略）。运行 set 以检查所有路径是否设置正确，运行 echo %环境变量%（例如 echo %BAZEL_VC%）以检查特定环境变量的路径设置。

Python 路径设置问题 tensorflow:issue#59943,tensorflow:issue#9436,tensorflow:issue#60083

set PATH=path/to/python;%PATH% # [e.g. (C:/Python311)]
set PATH=path/to/python/Scripts;%PATH% # [e.g. (C:/Python311/Scripts)] 
set PYTHON_BIN_PATH=path/to/python_virtualenv/Scripts/python.exe 
set PYTHON_LIB_PATH=path/to/python virtualenv/lib/site-packages 
set PYTHON_DIRECTORY=path/to/python_virtualenv/Scripts 

Bazel/MSVC/CLANG 路径设置问题 tensorflow:issue#54578

set BAZEL_SH=C:/msys64/usr/bin/bash.exe 
set BAZEL_VS=C:/Program Files/Microsoft Visual Studio/2022/BuildTools 
set BAZEL_VC=C:/Program Files/Microsoft Visual Studio/2022/BuildTools/VC 
set Bazel_LLVM=C:/Program Files/LLVM (explicitly tell Bazel where LLVM is installed by BAZEL_LLVM, needed while using CLANG)
set PATH=C:/Program Files/LLVM/bin;%PATH% (Optional, needed while using CLANG as Compiler)

可选：配置构建

TensorFlow 构建通过仓库根目录下的 .bazelrc 文件进行配置。./configure 或 ./configure.py 脚本可用于调整常用设置。

如果您需要更改配置，请从仓库根目录运行 ./configure 脚本。

python ./configure.py

此脚本会提示您输入 TensorFlow 依赖项的位置，并询问其他构建配置选项（例如编译器标志）。以下是 python ./configure.py 的示例运行（您的会话可能有所不同）

python ./configure.py
You have bazel 6.5.0 installed.
Please specify the location of python. [Default is C:\Python311\python.exe]:

Found possible Python library paths:
C:\Python311\lib\site-packages
Please input the desired Python library path to use.  Default is [C:\Python311\lib\site-packages]

Do you wish to build TensorFlow with ROCm support? [y/N]:
No ROCm support will be enabled for TensorFlow.

Warning: Cannot build with CUDA support on Windows.
Starting in TF 2.11, CUDA build is not supported for Windows. To use TensorFlow GPU on Windows, you will need to build/install TensorFlow in WSL2.

Do you want to use Clang to build TensorFlow? [Y/n]:
Add "--config=win_clang" to compile TensorFlow with CLANG.

Please specify the path to clang executable. [Default is C:\Program Files\LLVM\bin\clang.EXE]:

You have Clang 17.0.6 installed.

Please specify optimization flags to use during compilation when bazel option "--config=opt" is specified [Default is /arch:AVX]:

Would you like to override eigen strong inline for some C++ compilation to reduce the compilation time? [Y/n]:
Eigen strong inline overridden.

Would you like to interactively configure ./WORKSPACE for Android builds? [y/N]:
Not configuring the WORKSPACE for Android builds.

Preconfigured Bazel build configs. You can use any of the below by adding "--config=<>" to your build command. See .bazelrc for more details.
        --config=mkl            # Build with MKL support.
        --config=mkl_aarch64    # Build with oneDNN and Compute Library for the Arm Architecture (ACL).
        --config=monolithic     # Config for mostly static monolithic build.
        --config=numa           # Build with NUMA support.
        --config=dynamic_kernels        # (Experimental) Build kernels into separate shared objects.
        --config=v1             # Build with TensorFlow 1 API instead of TF 2 API.
Preconfigured Bazel build configs to DISABLE default on features:
        --config=nogcp          # Disable GCP support.
        --config=nonccl         # Disable NVIDIA NCCL support.

构建并安装 pip 软件包

pip 软件包的构建分为两步。bazel build 命令会创建一个“软件包构建器”程序。然后，您运行该构建器来创建软件包。

构建软件包构建器

tensorflow:master 仓库已更新为默认构建 2.x。安装 Bazel 并使用 bazel build 创建 TensorFlow 软件包构建器。

bazel build //tensorflow/tools/pip_package:wheel

仅 CPU

使用 bazel 构建仅支持 CPU 的 TensorFlow 软件包构建器

使用 MSVC 构建

bazel build --config=opt --repo_env=TF_PYTHON_VERSION=3.11 //tensorflow/tools/pip_package:wheel --repo_env=WHEEL_NAME=tensorflow_cpu

使用 CLANG 构建

使用 --config=win_clang 以使用 CLANG 编译器构建 TensorFlow

bazel build --config=win_clang --repo_env=TF_PYTHON_VERSION=3.11 //tensorflow/tools/pip_package:wheel --repo_env=WHEEL_NAME=tensorflow_cpu

GPU 支持

构建支持 GPU 的 TensorFlow 软件包构建器

bazel build --config=opt --config=cuda --define=no_tensorflow_py_deps=true //tensorflow/tools/pip_package:build_pip_package

清理 bazel 缓存以解决因无效或过时缓存数据导致的错误的命令。bazel clean 配合 --expunge 标志可永久删除文件。

bazel clean 
bazel clean --expunge  

Bazel 构建选项

构建时使用此选项以避免软件包创建过程中出现问题：tensorflow:issue#22390

--define=no_tensorflow_py_deps=true

有关 构建选项，请参阅 Bazel 命令行参考。

从源代码构建 TensorFlow 可能会消耗大量内存。如果您的系统内存受限，请使用 --local_ram_resources=2048 限制 Bazel 的内存使用量。

如果使用 GPU 支持进行构建，请添加 --copt=-nvcc_options=disable-warnings 以抑制 nvcc 警告消息。

构建软件包

要构建 pip 软件包，您需要指定 --repo_env=WHEEL_NAME 标志。根据提供的名称，将创建相应的软件包。例如

构建 tensorflow CPU 软件包

bazel build //tensorflow/tools/pip_package:wheel --repo_env=WHEEL_NAME=tensorflow_cpu

要构建 nightly 软件包，请设置 tf_nightly 而不是 tensorflow，例如构建 CPU nightly 软件包

bazel build //tensorflow/tools/pip_package:wheel --repo_env=WHEEL_NAME=tf_nightly_cpu

结果，生成的 wheel 将位于

bazel-bin/tensorflow/tools/pip_package/wheel_house/

安装软件包

生成的 .whl 文件名取决于 TensorFlow 版本和您的平台。使用 pip install 安装该软件包，例如

pip install bazel-bin/tensorflow/tools/pip_package/wheel_house/tensorflow-version-tags.whl

使用 MSYS shell 构建

也可以使用 MSYS shell 构建 TensorFlow。请按如下方式进行更改，然后遵循之前有关 Windows 原生命令行 (cmd.exe) 的说明。

禁用 MSYS 路径转换

MSYS 会自动将看起来像 Unix 路径的参数转换为 Windows 路径，这在 bazel 中无法正常工作。（标签 //path/to:bin 因为以斜杠开头而被视为 Unix 绝对路径。）

export MSYS_NO_PATHCONV=1
export MSYS2_ARG_CONV_EXCL="*"

设置 PATH

将 Bazel 和 Python 安装目录添加到您的 $PATH 环境变量中。如果 Bazel 安装在 C:\tools\bazel.exe，Python 安装在 C:\Python\python.exe，则设置 PATH 为

# Use Unix-style with ':' as separator
export PATH="/c/tools:$PATH"
export PATH="/c/path/to/Python:$PATH"

对于 GPU 支持，将 CUDA 和 cuDNN 的 bin 目录添加到您的 $PATH

export PATH="/c/Program Files/NVIDIA GPU Computing Toolkit/CUDA/v11.0/bin:$PATH"
export PATH="/c/Program Files/NVIDIA GPU Computing Toolkit/CUDA/v11.0/extras/CUPTI/libx64:$PATH"
export PATH="/c/tools/cuda/bin:$PATH"

已测试的构建配置

CPU

GPU