Skip to content

Commit 5a52180

Browse files
MrChengmofuyinno4
andauthored
Update doc & fix setup (#100)
* fix doc * fix setup Co-authored-by: wuzhihua <[email protected]>
1 parent 6c91b6a commit 5a52180

File tree

3 files changed

+7
-7
lines changed

3 files changed

+7
-7
lines changed

doc/custom_reader.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -77,7 +77,7 @@ Reader的逻辑需要一个单独的python文件进行描述。我们试写一
7777
```
7878
2. 创建一个子类,继承Reader的基类,训练所需Reader命名为`TrainerReader`
7979
```python
80-
class TrainerReader(Reader):
80+
class TrainerReader(ReaderBase):
8181
def init(self):
8282
pass
8383

doc/trainer_develop.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ class InstanceBase(object):
2626

2727
## network
2828

29-
network将在instanc后调用,执行模型的组网。network的官方实现位于[network.py](../core/trainers/framework/network.py),network基类定义如下:
29+
network将在instanc后调用,执行模型的组网。network的官方实现位于[network.py](../core/trainers/framework/network.py)network基类定义如下:
3030

3131
```python
3232
class NetworkBase(object):
@@ -37,7 +37,7 @@ class NetworkBase(object):
3737
pass
3838
```
3939

40-
可参照其他模式的实现方式,自定其中的部分步骤。您需要您需要继承`NetworkBase`并命名为`Network`,完成`build_network`的实现,通过上下文信息字典`context`拿到模型所需信息,并在context中保存模型的program与scope信息,例如:
40+
可参照其他模式的实现方式,实现其中的部分步骤。您需要继承`NetworkBase`并命名为`Network`,完成`build_network`的实现,通过上下文信息字典`context`拿到模型所需信息,并在context中保存模型的program与scope信息,例如:
4141

4242
```python
4343
context["model"][model_dict["name"]][
@@ -52,7 +52,7 @@ context["model"][model_dict["name"]][
5252

5353
## startup
5454

55-
startup执行网络参数的初始化,抑或模型的热启动,主要功能是执行`exe.run(fluid.default_startup_program())`。 startup的官方实现在[startup](../core/trainers/framework/startup.py)
55+
startup执行网络参数的初始化,或者模型的热启动,主要功能是执行`exe.run(fluid.default_startup_program())`。 startup的官方实现在[startup](../core/trainers/framework/startup.py)
5656

5757
```python
5858
class StartupBase(object):
@@ -75,7 +75,7 @@ class StartupBase(object):
7575
context["exe"], dirname, main_program=main_program)
7676
```
7777

78-
自定义startup流程,您需要您需要继承`StartupBase`并命名为`Startup`,实现该类型中startup成员函数。
78+
自定义startup流程,您需要继承`StartupBase`并命名为`Startup`,实现该类型中startup成员函数。
7979

8080
## runner
8181

@@ -113,7 +113,7 @@ class PSRunner(RunnerBase):
113113
context["status"] = "terminal_pass"
114114
```
115115

116-
自定义runner需要参照官方实现[runner.py](../core/trainers/framework/startup.py),继承基类`RunnerBase`,命名为`Runner`,并实现`run`成员函数。
116+
自定义runner需要参照官方实现[runner.py](../core/trainers/framework/runner.py),继承基类`RunnerBase`,命名为`Runner`,并实现`run`成员函数。
117117

118118
## terminal
119119

setup.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@
2222
import shutil
2323
import tempfile
2424

25-
requires = ["paddlepaddle >= 1.7.2", "PyYAML >= 5.1.1"]
25+
requires = ["paddlepaddle == 1.7.2", "PyYAML >= 5.1.1"]
2626

2727
about = {}
2828
about["__title__"] = "paddle-rec"

0 commit comments

Comments
 (0)