mindspore.hal.get_device_properties
===================================

.. image:: https://mindspore-website.obs.cn-north-4.myhuaweicloud.com/website-images/master/resource/_static/logo_source.svg
    :target: https://gitee.com/mindspore/mindspore/blob/master/docs/api/api_python/hal/mindspore.hal.get_device_properties.rst
    :alt: 查看源文件


.. py:function:: mindspore.hal.get_device_properties(device_id, device_target=None)

    返回指定卡号设备的设备属性信息。

    .. note::
        - 若用户不指定 `device_target` ，将此参数设置为当前已经设置的后端类型。
        - 对于CPU后端，固定返回1。
        - 对于Ascend后端，必须等待后端初始化完成后，调用此接口才有信息返回，否则属性信息中的 `total_memory` 以及 `free_memory` 都为0。
        - `device_id` 在Ascend后端下会被忽略，只返回当前已占用的卡属性。

    参数：
        - **device_id** (int) - 要查询的设备id。
        - **device_target** (str，可选) - 默认值：None，必须是 ``"CPU"`` ， ``"GPU"`` 以及 ``"Ascend"`` 的其中一个。

    返回：
        - GPU后端，返回 `cudaDeviceProp` :

          .. code-block::

              cudaDeviceProp {
                  name(str),
                  major(int),
                  minor(int),
                  is_multi_gpu_board(int),
                  is_integrated(int),
                  multi_processor_count(int),
                  total_memory(int),
                  warp_size(int)
              }

        - Ascend后端，返回 `AscendDeviceProperties` :

          .. code-block::

              AscendDeviceProperties {
                  name(str),
                  total_memory(int),
                  free_memory(int)
              }

        - CPU后端，返回None。