TensorFlow 2.0 Beta is available Learn more

tff.simulation.ClientData

Class ClientData

Object to hold a dataset and a mapping of clients to examples.

Defined in python/simulation/client_data.py.

Properties

client_ids

The list of string identifiers for clients in this dataset.

output_shapes

Returns the shape of each component of an element of the client datasets.

Any tf.data.Dataset constructed by this class is expected to have matching tf.data.Dataset.output_shapes properties.

Returns:

A nested structure of tf.TensorShape objects corresponding to each component of an element of the client datasets.

output_types

Returns the type of each component of an element of the client datasets.

Any tf.data.Dataset constructed by this class is expected have matching tf.data.Dataset.output_types properties.

Returns:

A nested structure of tf.DType objects corresponding to each component of an element of the client datasets.

Methods

create_tf_dataset_for_client

create_tf_dataset_for_client(client_id)

Creates a new tf.data.Dataset containing the client training examples.

Args:

  • client_id: The string client_id for the desired client.

Returns:

A tf.data.Dataset object.

create_tf_dataset_from_all_clients

create_tf_dataset_from_all_clients(seed=None)

Creates a new tf.data.Dataset containing all client examples.

NOTE: the returned tf.data.Dataset is not serializable and runnable on other devices, as it uses tf.py_func internally.

Currently, the implementation produces a dataset that contains all examples from a single client in order, and so generally additional shuffling should be performed.

Args:

  • seed: Optional, a seed to determine the order in which clients are processed in the joined dataset.

Returns:

A tf.data.Dataset object.