Update c++ readers doc #9352
Update c++ readers doc #9352
Conversation
| @@ -153,13 +153,17 @@ double_buffer_reader = create_double_buffer_op(batch_reader) | |||
| The forwarding ops of the corresponding `main_program` would be like this: | |||
|
|
|||
| ``` | |||
| while_op { | |||
| not_completed = true | |||
| pass_count = 0 | |||
There was a problem hiding this comment.
pass_count is a Python variable, not a ProgramDesc Var, does it work?
There was a problem hiding this comment.
not_completed and pass_count are both ProgramDesc Var. Sorry I didn't make it clear.
|
|
||
| ### Simplify Configuration by MultiPassReader | ||
|
|
||
| The Program configuration mentioned above is somehow complicated. Users need to be very similar to concepts of Program and Block to prevent making mistakes in their code. To make the usage of C++ readers more friendly to beginning users, we introduce `MultiPassReader`. |
There was a problem hiding this comment.
The Program -> The Program (please change two spaces to one space).
similar -> familiar
There was a problem hiding this comment.
above is somehow complicated -> above is complicated
There was a problem hiding this comment.
beginning users -> new users
| The forwarding part of the corresponding `main_program` would be like this: | ||
|
|
||
| ``` | ||
| not_completed = true |
There was a problem hiding this comment.
not_completed is a Python variable, not a ProgramDesc Var, does it work?
There was a problem hiding this comment.
They are Fluid Variables. See my above comment.
| @@ -113,7 +113,7 @@ To solve this problem, we introduce `ReaderHolder` as a wrapper. It acts as an e | |||
|
|
|||
| To create and invoke readers, some new ops are introduced: | |||
|
|
|||
| ### CreateReaderOp | |||
| ### Operators That Creates Readers | |||
|
|
||
| ### Simplify Configuration by MultiPassReader | ||
|
|
||
| The Program configuration mentioned above is somehow complicated. Users need to be very similar to concepts of Program and Block to prevent making mistakes in their code. To make the usage of C++ readers more friendly to beginning users, we introduce `MultiPassReader`. |
There was a problem hiding this comment.
above is somehow complicated -> above is complicated
|
|
||
| ### Simplify Configuration by MultiPassReader | ||
|
|
||
| The Program configuration mentioned above is somehow complicated. Users need to be very similar to concepts of Program and Block to prevent making mistakes in their code. To make the usage of C++ readers more friendly to beginning users, we introduce `MultiPassReader`. |
There was a problem hiding this comment.
beginning users -> new users
|
|
||
| The Program configuration mentioned above is somehow complicated. Users need to be very similar to concepts of Program and Block to prevent making mistakes in their code. To make the usage of C++ readers more friendly to beginning users, we introduce `MultiPassReader`. | ||
|
|
||
| `MultiPassReader` is a decorated reader. A multi-pass reader is used to continuously yield data for several pass training. It takes the number of passes to run as one of its attributes('pass_num') and maintains a counter to record how many passes it has completed. Each time its underlying reader reaches the EOF, the multi-pass reader checks whether it has completed the training of given number of pass. If not, the underlying reader will be re-initialized and starts a new pass automatically. Before completing the whole training, the return of MultiPassReader's `HasNext()` will always be `true`. |
There was a problem hiding this comment.
several pass training -> several training passes
This PR refines C++ readers doc according to @helinwang's comments of #9079:
Rename a section title from
CreateReaderOptoOperators That Creates Readers.Add the introduction of
MultiPassReaderand how to simplify program configurations with it.