install.md

TensorFlow Federated をインストールする

TensorFlow Federated（TFF）を使用するための環境は、いくつかの方法でセットアップできます。

• TFF を最も簡単に学習して使用するにはインストールの必要はありません。Google Colaboratory を使用してブラウザで直接 TensorFlow Federated チュートリアルを実行することができます。

• ローカルマシンで TensorFlow Federated を使用するには、Python のpip パッケージマネージャを使って TFF をインストールします。

• 固有のマシン構成を使用する場合は、ソースから TFF パッケージを構築します。

pip を使用して TensorFlow Federated をインストールする

1. Python 開発環境をインストールする

sudo apt update
sudo apt install python3-dev python3-pip  # Python 3

2. 仮想環境を作成する

python3 -m venv "venv"
source "venv/bin/activate"
pip install --upgrade "pip"

注意: 仮想環境を終了するには、deactivate を実行してください。

3. リリースされている TensorFlow Federated Python パッケージをインストールする

pip install --upgrade tensorflow-federated

4. Tensorflow Federated をテストする

python -c "import tensorflow_federated as tff; print(tff.federated_computation(lambda: 'Hello World')())"

成功: 最新の TensorFlow Federated Python パッケージがインストールされました。

ソースから TensorFlow Federated Python パッケージを構築する

ソースから TensorFlow Federated Python パッケージを構築すると、次の項目を行う場合に役立ちます。

• TensorFlow Federated に変更を適用し、それらの変更が送信またはリリースされる前に、TensorFlow Federated を使用するコンポーネントでテストする。

• TensorFlow Federated に送信されたがリリースされていない変更を使用する。

1. Python 開発環境をインストールする

sudo apt update
sudo apt install python3-dev python3-pip  # Python 3

2. Bazel をインストールする

Bazel をインストールします。これは、Tensorflow Federated をコンパイルするために使用するビルドツールです。

3. TensorFlow Federated リポジトリをクローンする

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

4. 仮想環境を作成する

python3 -m venv "venv"
source "venv/bin/activate"
pip install --upgrade "pip"
pip install numpy

5. TensorFlow Federated Python パッケージをビルドする

mkdir "/tmp/tensorflow_federated"
bazel run //tensorflow_federated/tools/python_package:build_python_package -- \
    --output_dir="/tmp/tensorflow_federated"

6. 仮想環境を終了する

deactivate

7. 新しいプロジェクトを作成する

mkdir "/tmp/project"
cd "/tmp/project"

8. 新しい仮想環境を作成する

python3 -m venv "venv"
source "venv/bin/activate"
pip install --upgrade "pip"

注意: 仮想環境を終了するには、deactivate を実行してください。

9. TensorFlow Federated Python パッケージをインストールする

pip install --upgrade "/tmp/tensorflow_federated/"*".whl"

10. Tensorflow Federated をテストする

python -c "import tensorflow_federated as tff; print(tff.federated_computation(lambda: 'Hello World')())"

成功: TensorFlow Federated Python パッケージがソースから構築されてインストールされました。