xref: /aosp_15_r20/external/tensorflow/tensorflow/python/tpu/tpu_name_util.py (revision b6fb3261f9314811a0f4371741dbb8839866f948)
1# Copyright 2020 The TensorFlow Authors. All Rights Reserved.
2#
3# Licensed under the Apache License, Version 2.0 (the "License");
4# you may not use this file except in compliance with the License.
5# You may obtain a copy of the License at
6#
7#     http://www.apache.org/licenses/LICENSE-2.0
8#
9# Unless required by applicable law or agreed to in writing, software
10# distributed under the License is distributed on an "AS IS" BASIS,
11# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12# See the License for the specific language governing permissions and
13# limitations under the License.
14# ======================================
15"""Helper functions for TPU device names."""
16
17from typing import Text
18from tensorflow.python.util.tf_export import tf_export
19
20
21@tf_export(v1=["tpu.core"])
22def core(num: int) -> Text:
23  """Returns the device name for a core in a replicated TPU computation.
24
25  Args:
26    num: the virtual core number within each replica to which operators should
27    be assigned.
28  Returns:
29    A device name, suitable for passing to `tf.device()`.
30  """
31  return "device:TPU_REPLICATED_CORE:{}".format(num)
32