Files
paddlepaddle--paddle/python/paddle/amp/__init__.py
T
2026-07-13 12:40:42 +08:00

114 lines
3.0 KiB
Python

# 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 paddle.base import core
from paddle.base.framework import (
_current_expected_place,
_get_paddle_place,
)
from . import ( # noqa: F401
accuracy_compare,
debugging,
grad_scaler,
)
from .amp_lists import ( # noqa: F401
black_list,
white_list,
)
from .auto_cast import ( # noqa: F401
amp_decorate,
amp_guard,
auto_cast,
autocast,
decorate,
get_autocast_dtype,
is_autocast_enabled,
)
from .grad_scaler import ( # noqa: F401
AmpScaler,
GradScaler,
OptimizerState,
)
__all__ = [
'auto_cast',
'GradScaler',
'decorate',
'is_float16_supported',
'is_bfloat16_supported',
'is_autocast_enabled',
'get_autocast_dtype',
'get_autocast_cpu_dtype',
'get_autocast_gpu_dtype',
]
get_autocast_cpu_dtype = get_autocast_dtype
get_autocast_gpu_dtype = get_autocast_dtype
def is_float16_supported(device: str | None = None) -> bool:
"""
Determine whether the place supports float16 in the auto-mixed-precision training.
Args:
device (str|None, optional): Specify the running device.
It can be ``cpu``, ``gpu``, ``xpu``, ``gpu:x`` and ``xpu:x``,
where ``x`` is the index of the GPUs or XPUs. if device is None, the device is the current device. Default: None.
Examples:
.. code-block:: pycon
>>> import paddle
>>> paddle.amp.is_float16_supported() # True or False
False
"""
device = (
_current_expected_place()
if device is None
else _get_paddle_place(device)
)
return core.is_float16_supported(device)
def is_bfloat16_supported(device: str | None = None) -> bool:
"""
Determine whether the place supports bfloat16 in the auto-mixed-precision training.
Args:
device (str|None, optional): Specify the running device.
It can be ``cpu``, ``gpu``, ``xpu``, ``gpu:x`` and ``xpu:x``,
where ``x`` is the index of the GPUs or XPUs. if device is None, the device is the current device. Default: None.
Examples:
.. code-block:: pycon
>>> import paddle
>>> paddle.amp.is_bfloat16_supported() # True or False
True
"""
device = (
_current_expected_place()
if device is None
else _get_paddle_place(device)
)
return core.is_bfloat16_supported(device)