chore: import upstream snapshot with attribution

python/paddle/device/gpgpu_backend.py

@@ -0,0 +1,98 @@
+# Copyright (c) 2021 PaddlePaddle Authors. All Rights Reserved.
+#
+# 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
+#
+#     http://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.
+from __future__ import annotations
+
+from typing import TYPE_CHECKING, TypeAlias
+
+from paddle.base import core
+
+if TYPE_CHECKING:
+    from paddle import CustomPlace
+    from paddle.base.libpaddle import _customDeviceProperties
+
+    _CustomPlaceLike: TypeAlias = CustomPlace | str | int
+
+__all__ = [
+    'get_device_properties',
+]
+
+
+def get_device_properties(
+    device: _CustomPlaceLike | None = None,
+) -> _customDeviceProperties:
+    """
+    Return the properties of given custom device.
+
+    Args:
+        device (CustomPlace|str|int|None, optional): The device, the id of the device or
+            the string name of device like 'metax_gpu:x' which to get the properties of the
+            device from. Notice that this api only supports gpgpu backend. If device is None, the device is the current device.
+            Default: None.
+
+    Returns:
+        _customDeviceProperties: The properties of the device which include device name,
+            major compute capability, minor compute capability, global memory available
+            and the number of multiprocessors on the device.
+
+    Examples:
+        .. code-block:: pycon
+
+            >>> import paddle
+            >>> paddle.device.get_device_properties('metax_gpu:0')
+            >>> paddle.device.get_device_properties(0)
+            >>> paddle.device.get_device_properties(paddle.CustomPlace('metax_gpu', 0))
+    """
+    if device is not None:
+        if isinstance(device, int):
+            device_id = device
+            # Use default custom device type
+            dev_types = core.get_all_custom_device_type()
+            if not dev_types:
+                raise ValueError("No custom device types available")
+            device_name = dev_types[0]
+        elif isinstance(device, core.CustomPlace):
+            device_name = device.get_device_type()
+            device_id = device.get_device_id()
+        elif isinstance(device, str):
+            colon_idx = device.rfind(':')
+            if colon_idx == -1:
+                device_name = device
+                device_id = 0
+            else:
+                device_name = device[:colon_idx]
+                device_id_str = device[colon_idx + 1 :]
+
+                if not device_id_str.isdigit():
+                    raise ValueError(
+                        f"Invalid device ID '{device_id_str}'. "
+                        f"After colon must be digits only. "
+                        "Example: 'metax_gpu:0'"
+                    )
+
+                device_id = int(device_id_str)
+        else:
+            raise ValueError(
+                f"The device type {device} is not expected. Because paddle.device."
+                "get_device_properties only support int, str or CustomPlace. "
+                "Please input appropriate device again!"
+            )
+    else:
+        # Use default custom device type and device id
+        dev_types = core.get_all_custom_device_type()
+        if not dev_types:
+            raise ValueError("No custom device types available")
+        device_name = dev_types[0]
+        device_id = 0
+
+    return core.get_device_properties(device_name, device_id)