chore: import upstream snapshot with attribution

python/paddle/framework/framework.py

@@ -0,0 +1,142 @@
+#   Copyright (c) 2020 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
+
+import numpy as np
+
+import paddle
+from paddle.base.data_feeder import convert_dtype
+from paddle.base.layer_helper_base import LayerHelperBase
+
+if TYPE_CHECKING:
+    from paddle._typing.dtype_like import DTypeLike, _DTypeLiteral
+
+__all__ = []
+
+
+def set_default_dtype(d: DTypeLike) -> None:
+    """
+    Set default dtype. The default dtype is initially float32.
+
+    Args:
+        d(string|paddle.dtype|np.dtype): the dtype to make the default. It only
+                            supports float16, bfloat16, float32 and float64.
+
+    Returns:
+        None.
+
+    Examples:
+        .. code-block:: pycon
+
+            >>> import paddle
+            >>> paddle.set_default_dtype("float32")
+
+    """
+    if isinstance(d, type):
+        # This branch is for np.dtype
+        if d in [np.float16, np.float32, np.float64]:
+            d = d.__name__
+        else:
+            raise TypeError(
+                "set_default_dtype only supports [float16, float32, float64] "
+                f", but received {d.__name__}"
+            )
+    else:
+        if isinstance(d, paddle.dtype):
+            d = convert_dtype(d)
+            # NOTE(Xuxinyi04) The underlying implementation type of
+            # paddle.bfloat16 is 'uint16'. In order to make the implementation
+            # transparent to users, it is artificially converted to 'bfloat16'.
+            d = 'bfloat16' if d == 'uint16' else d
+        # This branch is for str
+        if d in ['float16', 'float32', 'float64', 'bfloat16']:
+            # NOTE(SigureMo): Since the np.dtype object is not an instance of
+            # type, so it will not be handled by the previous branch. We need
+            # to convert it to str here.
+            d = str(d)
+        else:
+            raise TypeError(
+                "set_default_dtype only supports [float16, float32, float64, bfloat16] "
+                f", but received {d}"
+            )
+
+    LayerHelperBase.set_default_dtype(d)
+
+
+def set_default_tensor_type(t: DTypeLike | str, /) -> None:
+    """
+    Set the default tensor type.
+
+    .. warning::
+        This API is deprecated. Please use ``paddle.set_default_dtype`` instead.
+
+    Args:
+        t (dtype or str): The default tensor type. It can be a dtype like
+            ``paddle.float32`` or a string like ``"paddle.float32"`` or
+            ``"paddle.FloatTensor"``. Only float dtypes are supported.
+
+    Returns:
+        None.
+
+    Examples:
+        .. code-block:: pycon
+
+            >>> import paddle
+            >>> paddle.set_default_tensor_type("paddle.FloatTensor")
+            >>> paddle.set_default_tensor_type(paddle.FloatTensor)
+    """
+    if isinstance(t, type):
+        t = t.__name__
+
+    if isinstance(t, str):
+        t = t.replace('torch.', '').replace('paddle.', '').replace('cuda.', '')
+        dtype_map = {
+            "FloatTensor": "float32",
+            "DoubleTensor": "float64",
+            "HalfTensor": "float16",
+            "BFloat16Tensor": "bfloat16",
+        }
+        if t in dtype_map:
+            t = dtype_map[t]
+        else:
+            raise TypeError(
+                f"set_default_tensor_type only supports DtypeTensor, but received {t}"
+            )
+    else:
+        raise TypeError(
+            f"set_default_tensor_type only supports DtypeTensor or str, but received {t}"
+        )
+
+    set_default_dtype(t)
+
+
+def get_default_dtype() -> _DTypeLiteral:
+    """
+    Get the current default dtype. The default dtype is initially float32.
+
+    Args:
+        None.
+    Returns:
+        str, this global dtype only supports float16, float32, float64.
+
+    Examples:
+        .. code-block:: pycon
+
+            >>> import paddle
+            >>> paddle.get_default_dtype()
+    """
+    return LayerHelperBase.get_default_dtype()