Skip to content

Commit f269412

Browse files
committed
update format for sphinx
1 parent fa32516 commit f269412

File tree

1 file changed

+7
-4
lines changed

1 file changed

+7
-4
lines changed

doc/api/overview.rst

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,16 @@
1-
# V2 API Overview
1+
V2 API Overview
2+
================
23

3-
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](http://www.paddlepaddle.org/docs/develop/api/en/v2/config/layer.html),[Optimizer](http://www.paddlepaddle.org/docs/develop/api/en/v2/config/optimizer.html),[Evaluator](http://www.paddlepaddle.org/docs/develop/api/en/v2/config/evaluators.html) and [Data Reader](http://www.paddlepaddle.org/docs/develop/api/en/v2/data/data_reader.html) to make the model configuration more familiar to users.
4+
The PaddlePaddle V2 API is designed to provide a modern user interface for PaddlePaddle V1(the original layer-based platform of PaddlePaddle),
5+
it proposes some high-level concepts such as `Layers<http://www.paddlepaddle.org/docs/develop/api/en/v2/config/layer.html>`_ ,`Optimizer<http://www.paddlepaddle.org/docs/develop/api/en/v2/config/optimizer.html>`_ ,`Evaluator`<http://www.paddlepaddle.org/docs/develop/api/en/v2/config/evaluators.html>`_ and `Data Reader<http://www.paddlepaddle.org/docs/develop/api/en/v2/data/data_reader.html>`_ to make the model configuration more familiar to users.
46

57
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.
68

7-
We also provide the [interface for Training and Inference](http://www.paddlepaddle.org/docs/develop/api/en/v2/run_logic.html) to help control the training and inference phrase, it has several easy to use methods
9+
We also provide the `interface for Training and Inference`<http://www.paddlepaddle.org/docs/develop/api/en/v2/run_logic.html`_ to help control the training and inference phrase,
10+
it has several easy to use methods
811

912
- `paddle.train`
1013
- `paddle.test`
1114
- `paddle.infer`
1215

13-
to better expose the internal running details, different [Events](http://www.paddlepaddle.org/docs/develop/api/en/v2/run_logic.html#event) are available to users by writing some callbacks.
16+
to better expose the internal running details, different `Events<http://www.paddlepaddle.org/docs/develop/api/en/v2/run_logic.html#event>`_ are available to users by writing some callbacks.

0 commit comments

Comments
 (0)