【PaddlePaddle Hackathon 3】16 新增 API paddle.take #5099

S-HuaBomb · 2022-07-30T04:12:58Z

增加 paddle.take 的中文文档。

更新后的 RFC 的链接为：20220714_api_design_for_take.md
该算子的实现 PR 链接为：PaddlePaddle/Paddle#44741
PADDLEPADDLE_PR=44741

paddle-bot · 2022-07-30T04:13:02Z

感谢你贡献飞桨文档，文档预览构建中，Docs-New 跑完后即可预览，预览链接：http://preview-pr-5099.paddle-docs-preview.paddlepaddle.org.cn/documentation/docs/zh/api/index_cn.html
预览工具的更多说明，请参考：[Beta]飞桨文档预览工具

Ligoml · 2022-08-05T08:07:27Z

docs/api/paddle/take_cn.rst

+take
+-------------------------------
+
+.. py:function:: paddle.take(input, index, name)


take(input, index, name=None)

Ligoml · 2022-08-05T08:10:08Z

docs/api/paddle/take_cn.rst

+返回
+:::::::::
+
+- `Tensor` - 返回一个新的 Tensor，其中包含给定索引处的输入元素。结果与 `index` 的形状相同。


Tensor和index为什么要使用斜体？

已经改回正体，
Done

SigureMo · 2022-08-05T15:37:10Z

docs/api/paddle/Tensor_cn.rst

@@ -2412,3 +2412,12 @@ erfinv(x, name=None)
 对输入 x 进行逆误差函数计算

 请参考 :ref:`cn_api_paddle_tensor_erfinv`
+
+take(input, index, name=None)


作为 Tensor 的方法应该不需要第一个参数～

docs/api/paddle/take_cn.rst

SigureMo · 2022-08-05T15:41:41Z

docs/api/paddle/vision/models/alexnet_cn.rst

@@ -1,18 +1,17 @@
-.. _cn_api_paddle_vision_models_alexnet:
+.. _cn_api_paddle_vision_models_AlexNet:


注意不要把没有修改的文件提交了哦，这是 PaddlePaddle/Paddle#44671 提到的问题，暂时还没办法解决，也确实容易误操作，不过暂时先自己注意一下吧～如果可以的话尽可能恢复下～（大小写不敏感文件系统可能不太好处理，如果不能直接恢复的话，可以试试比如 revert 的命令来恢复，实在不行的话只能重新提 PR 了）

感谢建议。这个问题的确很令人困扰，可以按照你们的方案避免同名。
Done

这个问题现在有团队在解决了，预期Q3完成~

SigureMo · 2022-08-05T16:18:04Z

docs/api/paddle/Tensor_cn.rst

+take(input, index, name=None)
+:::::::::
+
+返回：一个新的 Tensor，其中包含给定索引处的输入元素。结果与 `index` 的形状相同


这里还有一个用 ` 包裹的，也许我们应该用

:attr:`arg_name`

这样？目前 Paddle 文档中引用某一个参数经常会使用这个，比如 argmax 源码和渲染分别为

这里看起来虽然与普通行内代码块一样，但应该仅仅是 Paddle 前端没有为两者样式做区分，比如 sphinx-rtd-theme 两者区别就是比较明显的

@BrilliantYuKaimin 有什么建议嘛？

在 rst 中用一个 ` 包裹的表示斜体，用两个 ` 包裹的表示代码块。既然 :attr:`arg_name` 和 ``arg_name`` 确实可以渲染出不同的效果，那么当然应该使用 :attr:`arg_name`。

「仅仅是 Paddle 前端没有为两者样式做区分」
给前端加一个需求吧

Co-authored-by: Nyakku Shigure <sigure.qaq@gmail.com>

This reverts commit 6d7633e.

This reverts commit e2d5299. fix e2d5299#

SigureMo · 2022-08-07T20:34:18Z

看样子还有些代码风格检查没有过，需要本地安装 pre-commit（这个 repo 里也需要初始化下），之后相应的文件随便加点什么后 commit 以触发 pre-commit 的自动修复（最好是些没什么影响的，比如在某一行后加些空格，这些之后会在触发 pre-commit 后自动删除，如果没有自动删的话手动记得删一下 😂）

S-HuaBomb · 2022-08-08T01:24:29Z

看样子还有些代码风格检查没有过，需要本地安装 pre-commit（这个 repo 里也需要初始化下），之后相应的文件随便加点什么后 commit 以触发 pre-commit 的自动修复（最好是些没什么影响的，比如在某一行后加些空格，这些之后会在触发 pre-commit 后自动删除，如果没有自动删的话手动记得删一下 😂）

很奇怪，我修改 take_cn.rst 之后 commit 却没有触发 pre-commit，环境中已经安装了。不过 take_cn.rst 的问题应该是最后空了两行，我手动删了一行。
THX，done

Ligoml · 2022-08-08T06:47:21Z

看样子还有些代码风格检查没有过，需要本地安装 pre-commit（这个 repo 里也需要初始化下），之后相应的文件随便加点什么后 commit 以触发 pre-commit 的自动修复（最好是些没什么影响的，比如在某一行后加些空格，这些之后会在触发 pre-commit 后自动删除，如果没有自动删的话手动记得删一下 😂）

很奇怪，我修改 take_cn.rst 之后 commit 却没有触发 pre-commit，环境中已经安装了。不过 take_cn.rst 的问题应该是最后空了两行，我手动删了一行。 THX，done

因为这个格式检查的pr上周五合入的， @SigureMo 贡献的pr。目前看来CI还是会卡住，再检查一下吧~

S-HuaBomb · 2022-08-08T07:26:51Z

在新的仓库中使用 pre-commit 需要先运行 pre-commit install。

我用 pre-cpmmit 会有这个问题：

它检查了之前提到的由于大小写出问题的文件，因为它们一直被标为修改文件在暂存区，restore 也没有用。我删除了空了两行的地方，这次应该好了。
Thx，done

SigureMo · 2022-08-08T08:03:47Z

在新的仓库中使用 pre-commit 需要先运行 pre-commit install。

嗯嗯，首先全局用 pip install pre-commit 是全局安装这个工具（一次即可）

之后每个 repo 都需要 pre-commit install 将 git hooks 注册到具体的这一个 repo

我用 pre-commit 会有这个问题：

嗯对的，我本地也用不了 pre-commit，现在都是在 codespace 上修改文档开发的（那个 issue 里我也有说），就很麻烦……

SigureMo · 2022-08-08T08:06:36Z

docs/api/paddle/Overview_cn.rst

@@ -136,6 +136,7 @@ tensor 数学操作
    " :ref:`paddle.acosh <cn_api_fluid_layers_acosh>` ", "反双曲余弦函数"
    " :ref:`paddle.asinh <cn_api_fluid_layers_asinh>` ", "反双曲正弦函数"
    " :ref:`paddle.atanh <cn_api_fluid_layers_atanh>` ", "反双曲正切函数"
+    " :ref:`paddle.take <cn_api_tensor_take>` ", "输出给定索引处的输入元素，结果与 index 的形状相同" 


还有问题，这个是说在句尾多了一个空格

…ew-api

SigureMo · 2022-08-23T12:40:06Z

docs/api/paddle/take_cn.rst

+- **mode**  (str，可选) - 索引越界处理，可选 ``'raise'``，``'wrap'``，``'clip'``，默认为 ``'raise'``。
+    - ``raise``：直接抛出错误；
+    - ``wrap``：通过取余数来约束超出范围的索引；
+    - ``clip``：将超出范围的索引剪裁到允许的最小（大）范围；


嵌套列表需要上下各空一行。可参考 reStructuredText Primer（Lists and Quote-like blocks）

英文这里保持一致格式吧，也用列表的形式，不过可能也需要注意添加空行

Ligoml

good job！LGTM

* add docs for paddle.take * fix docs * fix conflict * fix conflict * Update docs/api/paddle/take_cn.rst Co-authored-by: Nyakku Shigure <sigure.qaq@gmail.com> * fix docs * revert commit 498c668 * fix revert 498c668 * Revert "fix conflict" This reverts commit 6d7633e. * Revert "Revert "fix conflict"" This reverts commit e2d5299. fix e2d5299# * fix docs * fix take_cn by pre-commit * fix take_cn by pre-commit * fix take_cn by pre-commit * fix take_cn by pre-commit * fix take_cn.rst by pre-commit * fix Overview_cn.rst * fix doc, add param 'mode' * fix 嵌套列表 Co-authored-by: Nyakku Shigure <sigure.qaq@gmail.com>

add docs for paddle.take

e5c7771

paddle-bot bot added contributor status: proposed labels Jul 30, 2022

S-HuaBomb mentioned this pull request Jul 30, 2022

【PaddlePaddle Hackathon 3 No.16】为 Paddle 新增 API paddle.take PaddlePaddle/Paddle#44741

Merged

Ligoml reviewed Aug 5, 2022

View reviewed changes

S-HuaBomb added 4 commits August 5, 2022 16:43

fix docs

c40cb85

fix conflict

498c668

fix conflict

1d37f73

fix conflict

6d7633e

SigureMo requested changes Aug 5, 2022

View reviewed changes

S-HuaBomb and others added 8 commits August 7, 2022 11:43

Update docs/api/paddle/take_cn.rst

b8fdee5

Co-authored-by: Nyakku Shigure <sigure.qaq@gmail.com>

fix docs

a555df0

Merge branch 'new-api' of github.com:S-HuaBomb/docs into new-api

6aada7e

revert commit 498c668

013d01f

fix revert 498c668

93cf5a6

Revert "fix conflict"

e2d5299

This reverts commit 6d7633e.

Revert "Revert "fix conflict""

68f3627

This reverts commit e2d5299. fix e2d5299#

fix docs

f6239a7

S-HuaBomb added 4 commits August 8, 2022 09:15

fix take_cn by pre-commit

12b3da6

fix take_cn by pre-commit

9b24ee2

fix take_cn by pre-commit

67f3e60

fix take_cn by pre-commit

f87a792

fix take_cn.rst by pre-commit

4404d50

SigureMo reviewed Aug 8, 2022

View reviewed changes

S-HuaBomb added 3 commits August 8, 2022 16:46

fix Overview_cn.rst

6cbc27c

Merge branch 'develop' of https://github.com/PaddlePaddle/docs into n…

677189d

…ew-api

fix doc, add param 'mode'

38801a1

SigureMo requested changes Aug 23, 2022

View reviewed changes

fix 嵌套列表

083cf1a

Ligoml approved these changes Aug 25, 2022

View reviewed changes

luotao1 merged commit e249d63 into PaddlePaddle:develop Aug 30, 2022

BrilliantYuKaimin mentioned this pull request Aug 31, 2022

飞桨 API 文档的不规范之处及其规范化方案汇总 #5234

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

【PaddlePaddle Hackathon 3】16 新增 API paddle.take #5099

【PaddlePaddle Hackathon 3】16 新增 API paddle.take #5099

S-HuaBomb commented Jul 30, 2022 •

edited

paddle-bot bot commented Jul 30, 2022

Ligoml Aug 5, 2022

S-HuaBomb Aug 5, 2022

Ligoml Aug 5, 2022

S-HuaBomb Aug 5, 2022

SigureMo Aug 5, 2022

S-HuaBomb Aug 7, 2022

SigureMo Aug 5, 2022 •

edited

S-HuaBomb Aug 7, 2022

S-HuaBomb Aug 7, 2022

Ligoml Aug 8, 2022

SigureMo Aug 5, 2022 •

edited

BrilliantYuKaimin Aug 7, 2022

S-HuaBomb Aug 7, 2022

Ligoml Aug 11, 2022

SigureMo commented Aug 7, 2022

S-HuaBomb commented Aug 8, 2022

Ligoml commented Aug 8, 2022 •

edited

S-HuaBomb commented Aug 8, 2022

SigureMo commented Aug 8, 2022 •

edited

SigureMo Aug 8, 2022

S-HuaBomb Aug 8, 2022

SigureMo Aug 23, 2022

S-HuaBomb Aug 24, 2022

Ligoml left a comment

		@@ -1,18 +1,17 @@
		.. _cn_api_paddle_vision_models_alexnet:
		.. _cn_api_paddle_vision_models_AlexNet:

【PaddlePaddle Hackathon 3】16 新增 API paddle.take #5099

【PaddlePaddle Hackathon 3】16 新增 API paddle.take #5099

Conversation

S-HuaBomb commented Jul 30, 2022 • edited

paddle-bot bot commented Jul 30, 2022

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

SigureMo Aug 5, 2022 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

SigureMo Aug 5, 2022 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

SigureMo commented Aug 7, 2022

S-HuaBomb commented Aug 8, 2022

Ligoml commented Aug 8, 2022 • edited

S-HuaBomb commented Aug 8, 2022

SigureMo commented Aug 8, 2022 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Ligoml left a comment

Choose a reason for hiding this comment

S-HuaBomb commented Jul 30, 2022 •

edited

SigureMo Aug 5, 2022 •

edited

SigureMo Aug 5, 2022 •

edited

Ligoml commented Aug 8, 2022 •

edited

SigureMo commented Aug 8, 2022 •

edited