xref: /aosp_15_r20/external/tensorflow/tensorflow/python/client/device_lib.py (revision b6fb3261f9314811a0f4371741dbb8839866f948)
1# Copyright 2016 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"""A Python interface for creating TensorFlow servers."""
16
17from tensorflow.core.framework import device_attributes_pb2
18# pylint: disable=invalid-import-order, g-bad-import-order, wildcard-import, unused-import, undefined-variable
19from tensorflow.python import pywrap_tensorflow
20from tensorflow.python.client import _pywrap_device_lib
21
22
23def list_local_devices(session_config=None):
24  """List the available devices available in the local process.
25
26  Args:
27    session_config: a session config proto or None to use the default config.
28
29  Returns:
30    A list of `DeviceAttribute` protocol buffers.
31  """
32  def _convert(pb_str):
33    m = device_attributes_pb2.DeviceAttributes()
34    m.ParseFromString(pb_str)
35    return m
36
37  serialized_config = None
38  if session_config is not None:
39    serialized_config = session_config.SerializeToString()
40  return [
41      _convert(s) for s in _pywrap_device_lib.list_devices(serialized_config)
42  ]
43