.. _cn_api_paddle_profiler_export_protobuf:

export_protobuf
---------------------

.. py:function:: paddle.profiler.export_protobuf(dir_name: str, worker_name: Optional[str]=None)

返回一个回调函数，用于将采集的性能数据保存到 protobuf 格式的文件。
输出的文件将会保存在目录 ``dir_name`` 中，文件名的前缀将会被设置成 ``worker_name`` 。
如果 ``worker_name`` 没有被设置，默认名字为 [hostname]_[pid]。

参数
:::::::::

    - **dir_name** (str) - 性能数据导出所保存到的文件夹路径。
    - **worker_name** (str，可选) - 性能数据导出所保存到的文件名前缀，默认是[hostname]_[pid]。

返回
:::::::::

回调函数（callable)，该函数会接收一个参数 prof(Profiler 对象），调用 prof 的 export 方法保存采集到的性能数据到 protobuf 文件。

代码示例
::::::::::

用于 :ref:`性能分析器 <cn_api_paddle_profiler_Profiler>` 的 on_trace_ready 参数。

COPY-FROM: paddle.profiler.export_protobuf
