diff --git a/doc/design/api.md b/doc/design/api.md index dcf19451b116228bf131561759a1a889af5ec6d1..dd4341b32490dc61a16b5580900cbfaa0dd70e2a 100644 --- a/doc/design/api.md +++ b/doc/design/api.md @@ -1,4 +1,4 @@ -# PaddlePaddle API +# PaddlePaddle Design Doc ## Ingredients @@ -15,7 +15,7 @@ Evaluator = {Model*, activations} GradientMachine = {Evaluator*, gradients} - backward -Optimizer = {Model*, GradientMachine*} +Optimizer = {GradientMachine*} - train(cost, ...) - update - checkpoint @@ -96,7 +96,7 @@ e.g., momentum and the Adam SGD algorithm. We make `train` calls from `paddle.optimizer.SGD` by overrides only the `update` method. -## Programming +## Programming Interface A fictive example of PaddlePaddle program looks like the following: