<br />

<button value="stable" default="">See Stable</button> <button value="nightly">See Nightly</button>

<br />

|---|
| [![](https://www.tensorflow.org/images/GitHub-Mark-32px.png) View source on GitHub](https://github.com/tensorflow/tensorflow/blob/v2.21.0/tensorflow/dtensor/python/mesh_util.py#L138-L237) |

Creates a distributed mesh.

    tf.experimental.dtensor.create_distributed_mesh(
        mesh_dims: Union[List[Tuple[str, int]], Dict[str, int]],
        mesh_name: str = '',
        local_devices: Optional[List[Union[tf_device.DeviceSpec, str]]] = None,
        device_type: Optional[str] = None,
        use_xla_spmd: bool = layout.USE_XLA_SPMD
    ) -> https://www.tensorflow.org/api_docs/python/tf/experimental/dtensor/Mesh

This is similar to `create_mesh`, but with a different set of arguments to
create a mesh that spans evenly across a multi-client DTensor cluster.

For CPU and GPU meshes, users can choose to use fewer local devices than what
is available `local_devices`.

For TPU, only meshes that uses all TPU cores is supported by the DTensor
runtime.

<br />

<br />

<br />

| ## Args ||
|---|---|
| `mesh_dims` | A dict of dim_name: dim_size, or a list of (dim_name, dim_size) tuples. e.g. `{'x' : 4, 'y' : 1}` or `[('x', 4), ('y', 1)]`. |
| `mesh_name` | Name of the created mesh. Defaults to ''. |
| `local_devices` | String representations of devices to use. This is the device part of tf.DeviceSpec, e.g. 'CPU:0'. Defaults to all available local logical devices. |
| `device_type` | Type of device to build the mesh for. Defaults to 'CPU'. Supported values are 'CPU', 'GPU', 'TPU'.6 |
| `use_xla_spmd` | Boolean when True, will use XLA SPMD instead of DTensor SPMD. |

<br />

<br />

<br />

<br />

| ## Returns ||
|---|---|
| A mesh that spans evenly across all DTensor clients in the cluster. ||

<br />