【Hackathon 10th Spring No.1】add param for MaxPool*D/max_pool*d #7724
+105
−16
Conversation
This file contains hidden or 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
jinyouzhi
requested review from
Echo-Nie,
mattheliu,
ooooo-create and
sunzhongkai588
as code owners
|
感谢你贡献飞桨文档，文档预览构建中，Docs-New 跑完后即可预览，预览链接：http://preview-pr-7724.paddle-docs-preview.paddlepaddle.org.cn/documentation/docs/zh/api/index_cn.html |
📚 本次 PR 文档预览链接（点击展开）
|
Contributor
There was a problem hiding this comment.
Pull request overview
This PR adds documentation for the dilation parameter to MaxPool operations in PaddlePaddle, synchronizing with changes introduced in PaddlePaddle/Paddle#77495.
Changes:
- Added
dilationparameter documentation to all MaxPool API variants (1D, 2D, 3D) - Minor punctuation fix in MaxPool3D padding parameter description
Reviewed changes
Copilot reviewed 6 out of 6 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| docs/api/paddle/nn/functional/max_pool3d_cn.rst | Added dilation parameter documentation for max_pool3d function |
| docs/api/paddle/nn/functional/max_pool2d_cn.rst | Added dilation parameter documentation for max_pool2d function |
| docs/api/paddle/nn/functional/max_pool1d_cn.rst | Added dilation parameter documentation for max_pool1d function |
| docs/api/paddle/nn/MaxPool3D_cn.rst | Added dilation parameter documentation and fixed missing period in padding description |
| docs/api/paddle/nn/MaxPool2D_cn.rst | Added dilation parameter documentation for MaxPool2D class |
| docs/api/paddle/nn/MaxPool1D_cn.rst | Added dilation parameter documentation for MaxPool1D class |
Comment on lines
20
to
+21
| - **padding** (str|int|list|tuple，可选) - 池化补零的方式。如果 padding 是一个字符串，则必须为 `SAME` 或者 `VALID`。如果是 tuple 或者 list 类型，若其长度为 1，则会在输入的两端都填充上长度为 padding[0] 的 0，若其长度为 2，则应是 `[pad_before, pad_after]` 形式。如果 padding 是一个非 0 整数，那么表示会在输入的两端都填充上同样长度的 0。如果 padding 是长度为 2 的序列组成的 list 或 tuple，则其中的每个元素表示在相应维度上的填充长度。注意：在 batch_size 维度和通道维度应该设置为 [0, 0] 或 (0, 0)。默认值为 0。 | ||
| - **dilation** (int|list|tuple，可选) - 空洞池化步长，如果 dilation 为 list 或 tuple 类型，其必须包含一个整数。默认值为 1。 |
There was a problem hiding this comment.
The padding parameter description contains inconsistent spacing around commas. Chinese punctuation should not have spaces after commas (顿号/逗号). For example, '字符串,则必须为' should be '字符串，则必须为'.
Suggested change
| - **padding** (str|int|list|tuple，可选) - 池化补零的方式。如果 padding 是一个字符串，则必须为 `SAME` 或者 `VALID`。如果是 tuple 或者 list 类型，若其长度为 1，则会在输入的两端都填充上长度为 padding[0] 的 0，若其长度为 2，则应是 `[pad_before, pad_after]` 形式。如果 padding 是一个非 0 整数，那么表示会在输入的两端都填充上同样长度的 0。如果 padding 是长度为 2 的序列组成的 list 或 tuple，则其中的每个元素表示在相应维度上的填充长度。注意：在 batch_size 维度和通道维度应该设置为 [0, 0] 或 (0, 0)。默认值为 0。 | |
| - **dilation** (int|list|tuple，可选) - 空洞池化步长，如果 dilation 为 list 或 tuple 类型，其必须包含一个整数。默认值为 1。 | |
| - **padding** (str|int|list|tuple，可选) - 池化补零的方式。如果 padding 是一个字符串则必须为 `SAME` 或者 `VALID`。如果是 tuple 或者 list 类型若其长度为 1，则会在输入的两端都填充上长度为 padding[0] 的 0，若其长度为 2，则应是 `[pad_before, pad_after]` 形式。如果 padding 是一个非 0 整数那么表示会在输入的两端都填充上同样长度的 0。如果 padding 是长度为 2 的序列组成的 list 或 tuple，则其中的每个元素表示在相应维度上的填充长度。注意：在 batch_size 维度和通道维度应该设置为 [0, 0] 或 (0, 0)。默认值为 0。 | |
| - **dilation** (int|list|tuple，可选) - 空洞池化步长，如果 dilation 为 list 或 tuple 类型其必须包含一个整数。默认值为 1。 |
| ::::::::: | ||
| - **x** (Tensor)：当前算子的输入，其是一个形状为 `[N, C, L]` 的 3-D Tensor。其中 `N` 是 batch size, `C` 是通道数，`L` 是输入特征的长度。其数据类型为 float32 或者 float64。 | ||
| ``别名：input`` | ||
| - **output_size** (int|list|tuple)：算子输出特征图的长度，其数据类型为 int 或 list，tuple。 |
There was a problem hiding this comment.
Trailing whitespace after the note directive. Remove the space at the end of line 14.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
dilationoption for MaxPool1D/2D/3D -part Paddle#77495MaxPool*D/FractionalMaxPool*Dparam alias -part Paddle#77681