Add custom device en docs #4706
Merged
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
|
Thanks for your contribution! |
windstamp
force-pushed
the
plugin_device_en
branch
2 times, most recently
from
efbbea5 to
3adbfd1
Compare
windstamp
force-pushed
the
plugin_device_en
branch
from
3adbfd1 to
38bcc3d
Compare
windstamp
force-pushed
the
plugin_device_en
branch
from
34a4216 to
97686dd
Compare
qili93
reviewed
May 5, 2022
| @@ -0,0 +1,462 @@ | |||
| # Example of Device Access | |||
There was a problem hiding this comment.
这里改成 CustomDevice Tutorial 或者是 CustomDevice Example吧，一般很少有"Device Access"这样的说法
There was a problem hiding this comment.
Done, thanks.
改成了 CustomDevice Example。
| @@ -0,0 +1,462 @@ | |||
| # Example of Device Access | |||
|
|
|||
| This section will talk about how to implement a CustomDevice plug-in and add a new device backend for PaddlePaddle. How to compile, package, install, and use the backend will also be introduced. | |||
There was a problem hiding this comment.
In this section we will walk through the steps required to extend a fake hardware backend for PaddlePaddle by implementing a fake device named CustomCPU.
| > Note： | ||
| > - Please make sure that you have correctly installed the latest version of [Paddle develop](https://github.com/PaddlePaddle/Paddle). | ||
| > - Only `Linux` is supported | ||
| > - PaddlePaddle can have the custom kernel code and registration of open functional statements in heder files. |
There was a problem hiding this comment.
这里第三条可以中英文都去掉，这个用户自己没有办法检查，我们自己来保证WHL包的交付就行
| ``` | ||
|
|
||
| > Note： | ||
| > 1. When the backend is accessed through the custom runtime, the backend parameter must be the same as its name. |
There was a problem hiding this comment.
accessed 改成 registered 或者 extended
There was a problem hiding this comment.
Done, thanks.
改成了 registered。
| @@ -0,0 +1,19 @@ | |||
| ############################# | |||
| Custom Device Access Guide | |||
| Custom Device Access Guide | ||
| ############################# | ||
|
|
||
| The custom device access decouples the framework from the device and makes it available to extend the backend of the PaddlePaddle device via plug-ins. In this way, developers can make a plug-in for PaddlePaddle only by implementing the standard API and compiling it into a dynamic-link library, instead of by modifying the code of PaddlePaddle. Now it is easier to develop hardware backends for PaddlePaddle. |
There was a problem hiding this comment.
Done, thanks.
把第7行的也一起改了一下。
|
|
||
| - `Custom Runtime <./custom_runtime_en.html>`_ : Introduction of custom runtime of the PaddlePaddle framework | ||
| - `Custom Kernel <./custom_kernel_en.html>`_ : Introduction of custom kernel of the PaddlePaddle framework | ||
| - `Example of Device Access <./custom_device_example_en.html>`_ : To demonstrate how to connect new custom devices to PaddlePaddle |
There was a problem hiding this comment.
这里的title也对应改一下，To demonstrate how to connect new custom devices to PaddlePaddle 改成 The tutorial of add a new custom device to PaddlePaddle
|
|
||
| The custom device access decouples the framework from the device and makes it available to extend the backend of the PaddlePaddle device via plug-ins. In this way, developers can make a plug-in for PaddlePaddle only by implementing the standard API and compiling it into a dynamic-link library, instead of by modifying the code of PaddlePaddle. Now it is easier to develop hardware backends for PaddlePaddle. | ||
|
|
||
| The custom device access is composed of custom runtime and custom kernel. With the two modules, users can connect new custom devices to PaddlePaddle according to their own needs. |
TCChenlong
added a commit
to TCChenlong/docs
that referenced
this pull request
May 13, 2022
* Add custom device en docs * Update index_en.rst * Update index_en.rst * Fix _cn to _en, and ##### to short * optimieze Co-authored-by: Chen Long <1300851984@qq.com>
TCChenlong
added a commit
that referenced
this pull request
May 13, 2022
* Add custom device en docs (#4706) * Add custom device en docs * Update index_en.rst * Update index_en.rst * Fix _cn to _en, and ##### to short * optimieze Co-authored-by: Chen Long <1300851984@qq.com> * Update guides index (#4747) * Update release_note_cn.md * Update release_note_en.md * Update release_note_en.md * Update release_note_cn.md * Update release_note_cn.md * Update release_note_en.md * update guides index * update guides index * update guides index * fix api docs bugs test=document_fix * update release note Co-authored-by: furnace <34057289+windstamp@users.noreply.github.com>
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.
Add custom device en docs