From e6443d98323c2924de06169c5bd75e16da015d69 Mon Sep 17 00:00:00 2001 From: chengmo Date: Fri, 12 Jun 2020 11:24:41 +0800 Subject: [PATCH] update doc --- doc/design.md | 5 +---- doc/predict.md | 1 + doc/train.md | 5 ++++- 3 files changed, 6 insertions(+), 5 deletions(-) diff --git a/doc/design.md b/doc/design.md index dadc88bc..2a9d9453 100644 --- a/doc/design.md +++ b/doc/design.md @@ -111,7 +111,7 @@ Engine的自定义实现，可以参考[local_cluster.py](../core/engine/local_c 我们以GeneralTrainer为例，概览Trainer行为： ```python -class SingleTrainer(TranspileTrainer): +class GeneralTrainer(Trainer): def processor_register(self): print("processor_register begin") self.regist_context_processor('uninit', self.instance) @@ -229,9 +229,6 @@ class Reader(dg.MultiSlotDataGenerator): 完成reader的构建工作。 -Reader数据处理的逻辑，可以参考[criteo_reader.py](../../models/rank/../../paddlerec/models/rank/criteo_reader.py) - - ## Metric diff --git a/doc/predict.md b/doc/predict.md index 4957713d..c26fdf9a 100644 --- a/doc/predict.md +++ b/doc/predict.md @@ -13,6 +13,7 @@ runner: device: cpu # 执行在 cpu 上 init_model_path: "init_model" # 指定初始化模型的地址 print_interval: 10 # 预测信息的打印间隔，以batch为单位 + phases: phase_infer ``` 再定义具体的执行内容： diff --git a/doc/train.md b/doc/train.md index 3987bdc5..94cf8ac0 100644 --- a/doc/train.md +++ b/doc/train.md @@ -65,7 +65,7 @@ python -m paddlerec.run -m paddlerec.models.recall.word2vec - **`runner`** : runner是训练的引擎，亦可称之为运行器，在runner中定义执行设备（cpu、gpu），执行的模式（训练、预测、单机、多机等），以及运行的超参，例如训练轮数，模型保存地址等。 - **`phase`** : phase是训练中的阶段的概念，是引擎具体执行的内容，该内容是指：具体运行哪个模型文件，使用哪个reader。 -PaddleRec每次运行时，会执行一个运行器，通过`mode`指定`runner`的名字。每个运行器可以执行多个`phase`，所以PaddleRec支持一键启动多阶段的训练。 +PaddleRec每次运行时，会执行一个或多个运行器，通过`mode`指定`runner`的名字。每个运行器可以执行一个或多个`phase`，所以PaddleRec支持一键启动多阶段的训练。 ### 单机CPU训练 @@ -73,6 +73,7 @@ PaddleRec每次运行时，会执行一个运行器，通过`mode`指定`runner` ```yaml mode: single_cpu_train # 执行名为 single_cpu_train 的运行器 +# mode 也支持多个runner的执行，此处可以改为 mode: [single_cpu_train, single_cpu_infer] runner: - name: single_cpu_train # 定义 runner 名为 single_cpu_train @@ -88,6 +89,8 @@ runner: save_inference_fetch_varnames: [] # inference model 的fetch参数的名字 init_model_path: "" # 如果是加载模型热启，则可以指定初始化模型的地址 print_interval: 10 # 训练信息的打印间隔，以batch为单位 + phases: phase_train # 若没有指定phases，则会默认运行所有phase + # phase 也支持自定多个phase的执行，此处可以改为 phases: [phase_train, phase_infer] ``` 再定义具体的执行内容： -- GitLab