Skip to content

Commit f257bae

Browse files
committed
fix doc
Signed-off-by: tanmingchao <[email protected]>
1 parent 91f65f7 commit f257bae

File tree

2 files changed

+4
-4
lines changed

2 files changed

+4
-4
lines changed

doc/develop_guide.rst

+2-2
Original file line numberDiff line numberDiff line change
@@ -256,15 +256,15 @@ In this section, we describe how to do 3-5. Many common interfaces are provided
256256
Step 5. Define the protobuf file required for model saving
257257
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
258258

259-
To use the trained model through different platform, FATE use protobuf files to save the parameters and model result of a task. When developing your own module, you are supposed to create two proto files which defined your model content in `this folder <..python/federatedml/protobuf/proto>`_.
259+
To use the trained model through different platform, FATE use protobuf files to save the parameters and model result of a task. When developing your own module, you are supposed to create two proto files which defined your model content in `this folder <../python/federatedml/protobuf/proto>`_.
260260

261261
For more details of protobuf, please refer to `this tutorial <https://developers.google.com/protocol-buffers/docs/pythontutorial>`_
262262

263263
The two proto files are
264264
1. File with "meta" as suffix: Save the parameters of a task.
265265
2. File with "param" as suffix: Save the model result of a task.
266266

267-
After defining your proto files, you can use the following script named `generate_py.sh <..python/fate_arch/protobuf/generate_py.sh>`_ to create the corresponding python file:
267+
After defining your proto files, you can use the following script named `generate_py.sh <../python/fate_arch/protobuf/generate_py.sh>`_ to create the corresponding python file:
268268

269269
.. code-block:: bash
270270

doc/develop_guide_zh.rst

+2-2
Original file line numberDiff line numberDiff line change
@@ -261,13 +261,13 @@ fate_flow_client 模块的运行规则是:
261261
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
262262

263263
定义模型保存所需的protobuf文件:
264-
为了方便模型跨平台保存和读取模型,FATE使用protobuf文件定义每个模型所需的参数和模型内容。当您开发自己的模块时,需要定义本模块中需要保存的内容并创建相应的protobuf文件。protobuf文件所在的位置为 `这个目录 <..python/federatedml/protobuf/proto>`_ 。
264+
为了方便模型跨平台保存和读取模型,FATE使用protobuf文件定义每个模型所需的参数和模型内容。当您开发自己的模块时,需要定义本模块中需要保存的内容并创建相应的protobuf文件。protobuf文件所在的位置为 `这个目录 <../python/federatedml/protobuf/proto>`_ 。
265265

266266
更多使用protobuf的细节,请参考 `这个教程 <https://developers.google.com/protocol-buffers/docs/pythontutorial>`_
267267

268268
每个模型一般需要两个proto文件,其中后缀为meta的文件中保存某一次任务的配置,后缀为param的文件中保存某次任务的模型结果。
269269

270-
在完成proto文件的定义后,可执行protobuf目录下的 `generate_py.sh文件 <..python/fate_arch/protobuf/generate_py.sh>`_ 生成对应的python文件。之后,您可在自己的项目中引用自己设计的proto类型,并进行保存:
270+
在完成proto文件的定义后,可执行protobuf目录下的 `generate_py.sh文件 <../python/fate_arch/protobuf/generate_py.sh>`_ 生成对应的python文件。之后,您可在自己的项目中引用自己设计的proto类型,并进行保存:
271271

272272
.. code-block:: bash
273273

0 commit comments

Comments
 (0)