mindspore.ckpt_to_safetensors
======================================

.. 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/mindspore/mindspore.ckpt_to_safetensors.rst
    :alt: 查看源文件


.. py:function:: mindspore.ckpt_to_safetensors(file_path, save_path=None, name_map=None, file_name_regex=None, processes_num=1)

    将 MindSpore 的 checkpoint 文件转换为 safetensors 格式并保存到 `save_path`。
    safetensors 是 Huggingface 推出的一种可靠、易移植的机器学习模型存储格式，用于安全地存储Tensor，而且存储速度较快（零拷贝）。

    .. note::
        多进程设置数量与主机规模有关，不推荐设置太大，否则容易导致卡死。
        safetensors格式不支持enc校验功能，若ckpt为开启enc校验保存，执行转换时会报错。
        safetensors格式暂不支持crc校验功能，若ckpt包含crc校验信息，转换为safetensors过后crc校验信息会丢失。

    参数：
        - **file_path** (str) - 包含 checkpoint 文件的目录路径或单个 checkpoint 文件 (.ckpt) 的路径。
        - **save_path** (str, 可选) - 保存 safetensors 文件的目录路径。默认值：``None``。
        - **name_map** (dict, 可选) - 映射原始参数名到新参数名的字典。默认值：``None``。
        - **file_name_regex** (str, 可选) - 用于匹配需要转换的文件的正则表达式。默认值：``None``。
        - **processes_num** (int, 可选) - 控制并行处理的进程数量。默认值： ``1``。

    异常：
        - **ValueError** - 如果输入路径无效，或 save_path 不是目录，或 file_path 不以 '.ckpt' 结尾。