ソースからビルドする

TensorFlow pipパッケージをソースからビルドし、Ubuntu Linux および macOS にインストールします。手順は他のシステムでも機能する可能性がありますが、Ubuntu と macOS でのみテストおよびサポートされています。

LinuxとmacOSのセットアップ

開発環境を構成するには、次のビルド ツールをインストールします。

PythonとTensorFlowパッケージの依存関係をインストールする

sudo apt install python3-dev python3-pip

brew install python

TensorFlow pipパッケージの依存関係をインストールします (仮想環境を使用している場合は、 --user引数を省略します)。

pip install -U --user pip

Bazelをインストールする

TensorFlowをビルドするには、Bazelをインストールする必要があります。BazeliskはBazelを簡単にインストールする方法で、TensorFlowに適したBazelバージョンを自動的にダウンロードします。使いやすくするために、 PATHにbazel実行ファイルとしてBazeliskを追加してください。

Bazelisk が利用できない場合は、 Bazel を手動でインストールできます。TensorFlow の.bazelversionファイルに記載されている正しい Bazel バージョンをインストールしてください。

Clang をインストールする (推奨、Linux のみ)

Clangは、LLVMをベースにC++でコンパイルされるC/C++/Objective-Cコンパイラです。TensorFlow 2.13以降、TensorFlowのビルドにおけるデフォルトのコンパイラとなっています。現在サポートされているバージョンはLLVM/Clang 17です。

LLVM Debian/Ubuntu ナイトリーパッケージは、 Linux への自動インストールスクリプトと手動インストール用のパッケージを提供します。llvm apt リポジトリをパッケージソースに手動で追加する場合は、以下のコマンドを必ず実行してください。

sudo apt-get update && sudo apt-get install -y llvm-17 clang-17

この場合、 /usr/lib/llvm-17/bin/clang clang への実際のパスになります。

あるいは、事前にビルドされたClang + LLVM 17をダウンロードして解凍することもできます。

以下は、ダウンロードした Clang + LLVM 17 バイナリを Debian/Ubuntu オペレーティング システムにセットアップするための手順の例です。

1. 目的のディレクトリに移動します: cd <desired directory>

2. アーカイブ ファイルをロードして抽出します...(アーキテクチャに適したもの):

   wget https://github.com/llvm/llvm-project/releases/download/llvmorg-17.0.2/clang+llvm-17.0.2-x86_64-linux-gnu-ubuntu-22.04.tar.xz
   
   tar -xvf clang+llvm-17.0.2-x86_64-linux-gnu-ubuntu-22.04.tar.xz
   

3. 抽出した内容（ディレクトリとファイル）を/usrにコピーします（sudo 権限が必要になる場合があり、適切なディレクトリはディストリビューションによって異なる場合があります）。これにより、Clang と LLVM がインストールされ、パスに追加されます。以前のインストールがある場合は、以下のファイルを置き換えてください。

   cp -r clang+llvm-17.0.2-x86_64-linux-gnu-ubuntu-22.04/* /usr

4. 取得した Clang + LLVM 17 バイナリのバージョンを確認します。

   clang --version

5. これで、 /usr/bin/clang新しい clang への実際のパスになりました./configureスクリプトを実行するか、環境変数CCとBAZEL_COMPILERを手動でこのパスに設定してください。

GPU サポートをインストールする (オプション、Linux のみ)

macOS には GPU サポートがありません。

GPU サポートガイドを読んで、GPU で TensorFlow を実行するために必要なドライバーと追加ソフトウェアをインストールしてください。

TensorFlowのソースコードをダウンロードする

Gitを使用してTensorFlow リポジトリのクローンを作成します。

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

リポジトリはデフォルトでmaster開発ブランチに設定されています。リリースブランチをチェックアウトしてビルドすることもできます。

git checkout branch_name  # r2.2, r2.3, etc.

ビルドを構成する

TensorFlow ビルドは./configureリポジトリのルートディレクトリにある.bazelrcファイルによって構成されます。./configure または./configure.pyスクリプトを使用して、一般的な設定を調整できます。

リポジトリのルートディレクトリから./configureスクリプトを実行してください。このスクリプトは、TensorFlow の依存関係の場所と、追加のビルド設定オプション（コンパイラフラグなど）の入力を求めます。詳細はサンプルセッションのセクションをご覧ください。

./configure

このスクリプトのPython版である./configure.pyもあります。仮想環境を使用している場合、 python configure.py環境内のパスを優先し、 ./configure環境外のパスを優先します。どちらの場合も、デフォルトを変更できます。

サンプルセッション

以下は./configure configure スクリプトの実行サンプルを示しています (セッションによって異なる場合があります)。

./configure
You have bazel 6.1.0 installed.
Please specify the location of python. [Default is /Library/Frameworks/Python.framework/Versions/3.9/bin/python3]: 


Found possible Python library paths:
  /Library/Frameworks/Python.framework/Versions/3.9/lib/python3.9/site-packages
Please input the desired Python library path to use.  Default is [/Library/Frameworks/Python.framework/Versions/3.9/lib/python3.9/site-packages]

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

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

Do you want to use Clang to build TensorFlow? [Y/n]:
Clang will be used to compile TensorFlow.

Please specify the path to clang executable. [Default is /usr/lib/llvm-16/bin/clang]:

You have Clang 16.0.4 installed.

Please specify optimization flags to use during compilation when bazel option "--config=opt" is specified [Default is -Wno-sign-compare]:


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

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

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.

設定オプション

GPUサポート

バージョン2.18.0から

GPUサポートを利用するには、設定時にcuda=Yを設定し、必要に応じてCUDAとcuDNNのバージョンを指定します。BazelはCUDAおよびCUDNNパッケージを自動的にダウンロードするか、必要に応じてローカルファイルシステム上のCUDA/CUDNN/NCCL再配布パッケージを参照します。

バージョン2.18.0より前

GPUサポートを利用するには、設定時にcuda=Yを設定し、CUDAとcuDNNのバージョンを指定してください。システムに複数のバージョンのCUDAまたはcuDNNがインストールされている場合は、デフォルトではなく明示的にバージョンを指定してください。./configure ./configureシステムのCUDAライブラリへのシンボリックリンクを作成するため、CUDAライブラリのパスを更新した場合は、ビルド前にこの設定手順を再度実行する必要があります。

最適化

コンパイル最適化フラグについては、デフォルト（ -march=native ）では、生成されたコードをマシンのCPUタイプに合わせて最適化します。ただし、異なるCPUタイプ向けにTensorFlowをビルドする場合は、より具体的な最適化フラグの使用を検討してください。例については、 GCCマニュアルをご覧ください。

事前設定された構成

bazel buildコマンドに追加できる、事前構成されたビルド構成がいくつかあります。次に例を示します。

• --config=dbgデバッグ情報付きでビルドします。詳細はCONTRIBUTING.mdを参照してください。
• --config=mkl —Intel® MKL-DNNのサポート。
• --config=monolithic —ほぼ静的なモノリシック ビルドの構成。

pipパッケージをビルドしてインストールする

Bazelビルドオプション

ビルド オプションについては、Bazelコマンドライン リファレンスを参照してください。

TensorFlowをソースからビルドすると、大量のRAMが消費される可能性があります。システムのメモリ容量が限られている場合は、 --local_ram_resources=2048を指定してBazelのRAM使用量を制限してください。

公式 TensorFlow パッケージは、 manylinux2014 パッケージ標準に準拠した Clang ツールチェーンを使用して構築されています。

パッケージをビルドする

pip パッケージをビルドするには、 --repo_env=WHEEL_NAMEフラグを指定する必要があります。指定された名前に応じて、パッケージが作成されます。例:

Tensorflow CPU パッケージをビルドするには:

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

Tensorflow GPU パッケージをビルドするには:

bazel build //tensorflow/tools/pip_package:wheel --repo_env=USE_PYWRAP_RULES=1 --repo_env=WHEEL_NAME=tensorflow --config=cuda --config=cuda_wheel

Tensorflow TPU パッケージをビルドするには:

bazel build //tensorflow/tools/pip_package:wheel --repo_env=USE_PYWRAP_RULES=1 --repo_env=WHEEL_NAME=tensorflow_tpu --config=tpu

ナイトリー パッケージをビルドするには、 tensorflowの代わりにtf_nightly設定します。たとえば、CPU ナイトリー パッケージをビルドするには、次のようにします。

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

その結果、生成されたホイールは

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

Docker Linuxビルド

TensorFlow の Docker 開発イメージは、Linux パッケージをソースからビルドするための環境を簡単に構築できる方法です。これらのイメージには、TensorFlow のビルドに必要なソースコードと依存関係が既に含まれています。インストール手順と利用可能なイメージタグのリストについては、TensorFlow Docker ガイドをご覧ください。

CPUのみ

以下の例では、 :develイメージを使用して、最新の TensorFlow ソースコードから CPU のみのパッケージをビルドします。利用可能な TensorFlow の-develタグについては、 Docker ガイドをご覧ください。

最新の開発イメージをダウンロードし、 pipパッケージの構築に使用する Docker コンテナを起動します。

docker pull tensorflow/tensorflow:devel
docker run -it -w /tensorflow_src -v $PWD:/mnt -e HOST_PERMS="$(id -u):$(id -g)" \
    tensorflow/tensorflow:devel bash

git pull  # within the container, download the latest source code

上記のdocker runコマンドは、ソースツリーのルートである/tensorflow_srcディレクトリでシェルを起動します。ホストのカレントディレクトリをコンテナの/mntディレクトリにマウントし、ホストユーザーの情報を環境変数（権限設定に使用されますが、Docker ではこれが複雑になることがあります）を介してコンテナに渡します。

あるいは、コンテナ内に TensorFlow のホスト コピーを構築するには、コンテナの/tensorflowディレクトリにホスト ソース ツリーをマウントします。

docker run -it -w /tensorflow -v /path/to/tensorflow:/tensorflow -v $PWD:/mnt \
    -e HOST_PERMS="\\((id -u):\\)(id -g)" tensorflow/tensorflow:devel bash

ソースツリーをセットアップしたら、コンテナの仮想環境内で TensorFlow パッケージをビルドします。

1. オプション: ビルドを構成します。これにより、ユーザーはビルド構成に関する質問に回答するよう求められます。
2. pipパッケージをビルドします。
3. コンテナ外部のファイルの所有権権限を調整します。

./configure  # if necessary


bazel build //tensorflow/tools/pip_package:wheel \
--repo_env=USE_PYWRAP_RULES=1 --repo_env=WHEEL_NAME=tensorflow_cpu --config=opt

`
chown $HOST_PERMS bazel-bin/tensorflow/tools/pip_package/wheel_house/tensorflow-version-tags.whl

コンテナ内にパッケージをインストールして検証します。

pip uninstall tensorflow  # remove current version

pip install bazel-bin/tensorflow/tools/pip_package/wheel_house/tensorflow-version-tags.whl
cd /tmp  # don't import from source directory
python -c "import tensorflow as tf; print(tf.__version__)"

ホストマシンでは、TensorFlow pipパッケージは現在のディレクトリにあります (ホストユーザーの権限付き): ./tensorflow- version - tags .whl

GPUサポート

Dockerは、ホストマシンに必要なのはNVIDIA®ドライバーのみ（ NVIDIA® CUDA® Toolkitのインストールは不要）であるため、TensorFlowのGPUサポートを構築する最も簡単な方法です。nvidia -docker （Linuxのみ）の設定については、GPUサポートガイドとTensorFlow Dockerガイドを参照してください。

以下の例では、TensorFlow :devel-gpuイメージをダウンロードし、 nvidia-dockerを使用してGPU対応コンテナを実行します。この開発イメージは、GPUサポート付きのpipパッケージをビルドするように設定されています。

docker pull tensorflow/tensorflow:devel-gpu
docker run --gpus all -it -w /tensorflow -v $PWD:/mnt -e HOST_PERMS="$(id -u):$(id -g)" \
    tensorflow/tensorflow:devel-gpu bash
git pull  # within the container, download the latest source code

次に、コンテナの仮想環境内で、GPU サポート付きの TensorFlow パッケージをビルドします。

./configure  # if necessary


bazel build //tensorflow/tools/pip_package:wheel \
--repo_env=USE_PYWRAP_RULES=1 --repo_env=WHEEL_NAME=tensorflow --config=cuda \
--config=cuda_wheel --config=opt


chown $HOST_PERMS bazel-bin/tensorflow/tools/pip_package/wheel_house/tensorflow-version-tags.whl

コンテナ内にパッケージをインストールして検証し、GPU を確認します。

pip uninstall tensorflow  # remove current version

pip install bazel-bin/tensorflow/tools/pip_package/wheel_house/tensorflow-version-tags.whl
cd /tmp  # don't import from source directory
python -c "import tensorflow as tf; print(\"Num GPUs Available: \", len(tf.config.list_physical_devices('GPU')))"

テスト済みのビルド構成

リナックス

CPU

グラフィックプロセッサ

macOS

CPU

グラフィックプロセッサ