diff --git a/doc/api/overview.rst b/doc/api/overview.rst index 953d2db2b30c14c92c2d6d762294c3aebc6eda29..16b6cf42660c51feee09c689c671d5ef06663efb 100644 --- a/doc/api/overview.rst +++ b/doc/api/overview.rst @@ -1,4 +1,16 @@ -API Overview -============ +V2 API Overview +================ -TBD +The PaddlePaddle V2 API is designed to provide a modern user interface for PaddlePaddle V1(the original layer-based platform of PaddlePaddle), +it proposes some high-level concepts such as `Layers `_ , `Optimizer `_ , `Evaluator `_ and `Data Reader `_ to make the model configuration more familiar to users. + +A model is composed of the computation described by a group of `Layers`, with `Evaluator` to define the error, `Optimizer` to update the parameters and `Data Reader` to feed in the data. + +We also provide the `interface for Training and Inference `_ to help control the training and inference phrase, +it has several easy to use methods + +- `paddle.train` +- `paddle.test` +- `paddle.infer` + +to better expose the internal running details, different `events `_ are available to users by writing some callbacks.