Update index_en.rst #9286
Merged
Update index_en.rst #9286
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Update en version
abhinavarora
suggested changes
Mar 22, 2018
doc/v2/howto/capi/index_en.rst
Outdated
| @@ -1,6 +1,23 @@ | |||
| C-API Prediction Library | |||
| ======================== | |||
|
|
|||
| After we trained a neural network model, then we use it to make predictions. Prediction is a process of preparing input data and processing the model to get the result. | |||
There was a problem hiding this comment.
I think we should replace the word prediction with Inference. The title can also read C-API Inference Library.
There was a problem hiding this comment.
The sentence should be as follows:
After we train a neural network, we use it to do inference. Inference is the process of preparing input data and propagating it through the model to produce the result.
doc/v2/howto/capi/index_en.rst
Outdated
|
|
||
| Compared with model training, prediction has the following features: | ||
|
|
||
| #. Prediction does not require backpropagation and parameter updates during training. |
There was a problem hiding this comment.
Inference does not require backpropagation and parameter updates, as required during training.
doc/v2/howto/capi/index_en.rst
Outdated
|
|
||
| Therefore, the model prediction SDK needs to be designed separately and has the following features: | ||
|
|
||
| #. The predictive SDK does not include reverse propagation and parameter updates to reduce the size of the SDK. |
There was a problem hiding this comment.
reverse propagation -> backpropagation
doc/v2/howto/capi/index_en.rst
Outdated
| #. The predictive SDK does not include reverse propagation and parameter updates to reduce the size of the SDK. | ||
| #. The predictive SDK needs a simple user interface for ease of use. | ||
| #. Since the input data may have a variety of structures, the format of the input data is clearly and compactly packaged. | ||
| #. In order to be compatible with the user's system, the SDK's interface must conform to the C-standard interface. |
There was a problem hiding this comment.
with the user's system -> with user's system
doc/v2/howto/capi/index_en.rst
Outdated
| #. Since the input data may have a variety of structures, the format of the input data is clearly and compactly packaged. | ||
| #. In order to be compatible with the user's system, the SDK's interface must conform to the C-standard interface. | ||
|
|
||
| PaddlePaddle provides C-API to solve the above problem. The use of C-API, we provide the following guidelines: |
There was a problem hiding this comment.
Following are the guidelines to use the C-API:
Update refer to commits and thank you for the suggestion.
|
Thank you so much! @abhinavarora |
mikeseven
added a commit
to mikeseven/Paddle
that referenced
this pull request
Mar 22, 2018
* commit '9c35b0dc1ba0ace5acf721685802a21045ea1249': (36 commits) Fix dist compile error (PaddlePaddle#9320) Fix bug for backward tanspiler when using parallel_do operator. (PaddlePaddle#9282) update fix transpiler bug Update index_en.rst (PaddlePaddle#9286) "fix mixed_vector bug" (PaddlePaddle#9319) Update index_en.rst (PaddlePaddle#9280) Adjust some contents in write_docs_en.rst for Contribue Documentation (PaddlePaddle#9147) CMake refine for HIP support. Fix CI. Reuduce memory copy when communication between trainer and pserver. (PaddlePaddle#9271) Modified build.sh and remove build_doc.sh fix doc Enhance device context pool (PaddlePaddle#9293) Device blobs are created only in training. Added testing attribute Shrink batch_norm_grad's inputs updates prepare and create op before run wip small fix initial commit ... # Conflicts: # cmake/external/eigen.cmake
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Update en version
fix #8915