tilelang.utils.target
=====================

.. py:module:: tilelang.utils.target


Attributes
----------

.. autoapisummary::

   tilelang.utils.target.SUPPORTED_TARGETS


Functions
---------

.. autoapisummary::

   tilelang.utils.target.describe_supported_targets
   tilelang.utils.target.check_cuda_availability
   tilelang.utils.target.check_hip_availability
   tilelang.utils.target.check_metal_availability
   tilelang.utils.target.determine_target
   tilelang.utils.target.target_is_cuda
   tilelang.utils.target.target_is_hip
   tilelang.utils.target.target_is_volta
   tilelang.utils.target.target_is_turing
   tilelang.utils.target.target_is_ampere
   tilelang.utils.target.target_is_hopper
   tilelang.utils.target.target_is_sm120
   tilelang.utils.target.target_is_cdna
   tilelang.utils.target.target_has_async_copy
   tilelang.utils.target.target_has_ldmatrix
   tilelang.utils.target.target_has_stmatrix
   tilelang.utils.target.target_has_bulk_copy
   tilelang.utils.target.target_get_warp_size


Module Contents
---------------

.. py:data:: SUPPORTED_TARGETS
   :type:  dict[str, str]

.. py:function:: describe_supported_targets()

   Return a mapping of supported target names to usage descriptions.


.. py:function:: check_cuda_availability()

   Check if CUDA is available on the system by locating the CUDA path.
   :returns: True if CUDA is available, False otherwise.
   :rtype: bool


.. py:function:: check_hip_availability()

   Check if HIP (ROCm) is available on the system by locating the ROCm path.
   :returns: True if HIP is available, False otherwise.
   :rtype: bool


.. py:function:: check_metal_availability()

.. py:function:: determine_target(target = 'auto', return_object = False)

   Determine the appropriate target for compilation (CUDA, HIP, or manual selection).

   :param target: User-specified target.
                  - If "auto", the system will automatically detect whether CUDA or HIP is available.
                  - If a string or Target, it is directly validated.
   :type target: Union[str, Target, Literal["auto"]]

   :returns: The selected target ("cuda", "hip", or a valid Target object).
   :rtype: Union[str, Target]

   :raises ValueError: If no CUDA or HIP is available and the target is "auto".
   :raises AssertionError: If the target is invalid.


.. py:function:: target_is_cuda(target)

.. py:function:: target_is_hip(target)

.. py:function:: target_is_volta(target)

.. py:function:: target_is_turing(target)

.. py:function:: target_is_ampere(target)

.. py:function:: target_is_hopper(target)

.. py:function:: target_is_sm120(target)

.. py:function:: target_is_cdna(target)

.. py:function:: target_has_async_copy(target)

.. py:function:: target_has_ldmatrix(target)

.. py:function:: target_has_stmatrix(target)

.. py:function:: target_has_bulk_copy(target)

.. py:function:: target_get_warp_size(target)