federated_select.ipynb

Kernel: Python 3

Copyright 2021 The TensorFlow Authors.

#@title Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# https://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

TensorFlow.org で表示

Google Colab で実行

GitHubでソースを表示

ノートブックをダウンロード

tff.federated_select を使用して特定のクライアントに異なるデータを送信する

このチュートリアルでは、TFF でさまざまなクライアントにさまざまなデータを送信する必要がある場合にカスタム連合アルゴリズムを実装する方法を実演します。サーバーに配置された単一の値をすべてのクライアントに送信する tff.federated_broadcast については既にご存知かもしれません。このチュートリアルでは、サーバーベースの値のさまざまな部分がさまざまなクライアントに送信される場合について見ていきます。モデル全体が単一のクライアントに送信されないように、モデルの一部を異なるクライアントに分割する場合に役立ちます。

まず、tensorflow と tensorflow_federated をインポートします。

#@test {"skip": true}
!pip install --quiet --upgrade tensorflow-federated

import tensorflow as tf
import tensorflow_federated as tff
tff.backends.native.set_sync_local_cpp_execution_context()

クライアントデータに基づいて異なる値を送信する

サーバーに配置されたリストがあり、そこからクライアントに配置されたデータに基づいて各クライアントにいくつかの要素を送信する場合を検討してみます。たとえば、サーバー上およびクライアント上の文字列のリスト、ダウンロードするインデックスのコンマ区切りのリストは、次のように実装できます。

list_of_strings_type = tff.TensorType(tf.string, [None])
# We only ever send exactly two values to each client. The number of keys per
# client must be a fixed number across all clients.
number_of_keys_per_client = 2
keys_type = tff.TensorType(tf.int32, [number_of_keys_per_client])
get_size = tff.tf_computation(lambda x: tf.size(x))
select_fn = tff.tf_computation(lambda val, index: tf.gather(val, index))
client_data_type = tf.string

# A function from our client data to the indices of the values we'd like to
# select from the server.
@tff.tf_computation(client_data_type)
@tff.check_returns_type(keys_type)
def keys_for_client(client_string):
  # We assume our client data is a single string consisting of exactly three
  # comma-separated integers indicating which values to grab from the server.
  split = tf.strings.split([client_string], sep=',')[0]
  return tf.strings.to_number([split[0], split[1]], tf.int32)

@tff.tf_computation(tff.SequenceType(tf.string))
@tff.check_returns_type(tf.string)
def concatenate(values):
  def reduce_fn(acc, item):
    return tf.cond(tf.math.equal(acc, ''),
                   lambda: item,
                   lambda: tf.strings.join([acc, item], ','))
  return values.reduce('', reduce_fn)

@tff.federated_computation(tff.type_at_server(list_of_strings_type), tff.type_at_clients(client_data_type))
def broadcast_based_on_client_data(list_of_strings_at_server, client_data):
  keys_at_clients = tff.federated_map(keys_for_client, client_data)
  max_key = tff.federated_map(get_size, list_of_strings_at_server)
  values_at_clients = tff.federated_select(keys_at_clients, max_key, list_of_strings_at_server, select_fn)
  value_at_clients = tff.federated_map(concatenate, values_at_clients)
  return value_at_clients

次に、サーバーに配置された文字列のリストと各クライアントの文字列データを提供することで、計算をシミュレートできます。

client_data = ['0,1', '1,2', '2,0']
broadcast_based_on_client_data(['a', 'b', 'c'], client_data)

[<tf.Tensor: shape=(), dtype=string, numpy=b'a,b'>,
 <tf.Tensor: shape=(), dtype=string, numpy=b'b,c'>,
 <tf.Tensor: shape=(), dtype=string, numpy=b'c,a'>]

ランダム化された要素を各クライアントに送信する

または、サーバーデータのランダムな要素を各クライアントに送信すると便利な場合があります。これを実装するには、最初に各クライアントでランダムキーを生成し、上記と同様の選択プロセスに従います。

@tff.tf_computation(tf.int32)
@tff.check_returns_type(tff.TensorType(tf.int32, [1]))
def get_random_key(max_key):
  return tf.random.uniform(shape=[1], minval=0, maxval=max_key, dtype=tf.int32)

list_of_strings_type = tff.TensorType(tf.string, [None])
get_size = tff.tf_computation(lambda x: tf.size(x))
select_fn = tff.tf_computation(lambda val, index: tf.gather(val, index))

@tff.tf_computation(tff.SequenceType(tf.string))
@tff.check_returns_type(tf.string)
def get_last_element(sequence):
  return sequence.reduce('', lambda _initial_state, val: val)

@tff.federated_computation(tff.type_at_server(list_of_strings_type))
def broadcast_random_element(list_of_strings_at_server):
  max_key_at_server = tff.federated_map(get_size, list_of_strings_at_server)
  max_key_at_clients = tff.federated_broadcast(max_key_at_server)
  key_at_clients = tff.federated_map(get_random_key, max_key_at_clients)
  random_string_sequence_at_clients = tff.federated_select(
      key_at_clients, max_key_at_server, list_of_strings_at_server, select_fn)
  # Even though we only passed in a single key, `federated_select` returns a
  # sequence for each client. We only care about the last (and only) element.
  random_string_at_clients = tff.federated_map(get_last_element, random_string_sequence_at_clients)
  return random_string_at_clients

broadcast_random_element 関数はクライアントに配置されたデータを取り込めないため、TFF シミュレーションランタイムで使用するクライアントのデフォルト数を構成する必要があります。

tff.backends.native.set_sync_local_cpp_execution_context(default_num_clients=3)

次に、選択をシミュレートします。上記の default_num_clients と以下の文字列のリストを変更してさまざまな結果を生成します。または、計算を再実行してさまざまなランダム出力を生成します。

broadcast_random_element(tf.convert_to_tensor(['foo', 'bar', 'baz']))