【映射文档】新增与维护部分映射文档 #6494

RedContritio · 2024-01-31T20:53:29Z

修复了此前类构造方法签名不一致的问题：均不使用 class
新增了部分映射文档，基于 PaConvert 已实现的 api 映射

剩余已实现的 api 文档正在整理中

思考：
考虑维护问题的话，或许可以考虑给所有的映射文档一个更统一规范的模板？
包括但不限于：
- 映射文档中函数签名不同行的缩进与空格使用等
- 网址格式是否使用锚点
- 参数对比表格格式中字体强调色、表格空格使用数量、表格分割线格式等
- 同级别的映射类型同时存在时，映射类型选择与映射类型描述的规范等（如，参数名不一致 + paddle 参数更多）

zhwesky2010

注意内容详细得当，这个文档的核心是 突出torch->paddle的差异，其他无差异的地方应省尽省

docs/guides/model_convert/convert_from_pytorch/api_difference/Tensor/torch.Tensor.addmm.md

docs/guides/model_convert/convert_from_pytorch/api_difference/Tensor/torch.Tensor.amax.md

docs/guides/model_convert/convert_from_pytorch/api_difference/Tensor/torch.Tensor.amin.md

docs/guides/model_convert/convert_from_pytorch/api_difference/Tensor/torch.Tensor.argmax.md

docs/guides/model_convert/convert_from_pytorch/api_difference/ops/torch.amax.md

docs/guides/model_convert/convert_from_pytorch/api_difference/ops/torch.alpha_dropout.md

docs/guides/model_convert/convert_from_pytorch/api_difference/ops/torch.amin.md

docs/guides/model_convert/convert_from_pytorch/api_difference/ops/torch.angle.md

zhwesky2010 · 2024-02-06T03:44:10Z

修复了此前类构造方法签名不一致的问题：均不使用 class

新增了部分映射文档，基于 PaConvert 已实现的 api 映射

剩余已实现的 api 文档正在整理中

思考：
考虑维护问题的话，或许可以考虑给所有的映射文档一个更统一规范的模板？
包括但不限于：

映射文档中函数签名不同行的缩进与空格使用等

网址格式是否使用锚点

参数对比表格格式中字体强调色、表格空格使用数量、表格分割线格式等

同级别的映射类型同时存在时，映射类型选择与映射类型描述的规范等（如，参数名不一致 + paddle 参数更多）

后面可以考虑进一步规范，但是历史存量修改问题会比较多

zhwesky2010 · 2024-02-06T03:46:39Z

docs/guides/model_convert/convert_from_pytorch/api_difference/Tensor/torch.Tensor.addmm.md

+| mat1 |      x       | 表示输入的 Tensor，仅参数名不一致。 |
+| mat2 |      y       | 表示输入的 Tensor，仅参数名不一致。 |
+| beta  |    beta     | 乘以 input 的标量。|
+| alpha |   alpha     | 乘以 x*y 的标量。|


这个是乘以x还是乘以y？

反馈，参考 paddle.addmm，out=alpha∗x∗y+beta∗input，乘以 x*y

docs/guides/model_convert/convert_from_pytorch/api_difference/Tensor/torch.Tensor.logit.md

docs/guides/model_convert/convert_from_pytorch/api_difference/Tensor/torch.Tensor.matmul.md

zhwesky2010 · 2024-02-06T03:52:41Z

docs/guides/model_convert/convert_from_pytorch/api_difference/Tensor/torch.Tensor.matmul.md

+### [paddle.Tensor.matmul](https://www.paddlepaddle.org.cn/documentation/docs/zh/develop/api/paddle/Tensor_cn.html#matmul-y-transpose-x-false-transpose-y-false-name-none)
+
+```python
+paddle.Tensor.matmul(y, transpose_x=False, transpose_y=False, name=None)


关于：参数名不一致 + paddle参数更多多种类型的后面确实可以整体考虑优化下，目前按规范写的是仅paddle参数更多

zhwesky2010 · 2024-02-06T03:55:23Z

...convert_from_pytorch/api_difference/utils/torch.utils.data.distributed.DistributedSampler.md

+| dataset       | dataset      | 所用的数据集。 |
+| num_replicas  | num_replicas | 进程数量。    |
+| rank          | rank         | num_replicas 个进程中的进程序号。 |
+| shuffle       | shuffle      | 是否打乱。PyTorch 默认值为 True， 默认值为 False。Paddle 需设置为与 PyTorch 一致。 |


paddle默认值为False

zhwesky2010 · 2024-02-18T12:08:40Z

docs/guides/model_convert/convert_from_pytorch/api_difference/Tensor/torch.Tensor.argmax.md

+| PyTorch | PaddlePaddle | 备注                               |
+| ------- | ------------ | ------------------                 |
+| dim     | axis         | 指定对输入 Tensor 进行运算的轴，仅参数名不一致。  |
+| keepdim | keepdim      | 是否在输出 Tensor 中保留减小的维度。 |


paddle的dtype没写，下个PR补上

zhwesky2010 · 2024-02-18T12:09:08Z

docs/guides/model_convert/convert_from_pytorch/api_difference/Tensor/torch.Tensor.argmin.md

+| PyTorch | PaddlePaddle | 备注                               |
+| ------- | ------------ | ------------------                 |
+| dim     | axis         | 指定对输入 Tensor 进行运算的轴，仅参数名不一致。  |
+| keepdim | keepdim      | 是否在输出 Tensor 中保留减小的维度。 |


paddle的dtype没写，下个PR补上

zhwesky2010 · 2024-02-18T12:25:23Z

docs/guides/model_convert/convert_from_pytorch/api_difference/Tensor/torch.Tensor.nanmedian.md

+| PyTorch | PaddlePaddle | 备注 |
+| ------- | ------------ | -- |
+| dim     | axis         | 指定对 x 进行计算的轴，仅参数名不一致。 |
+| keepdim | keepdim      | 是否在输出 Tensor 中保留减小的维度，PyTorch 默认值为 False，Paddle 默认值为 True。Paddle 需设置为与 PyTorch 一致。 |


这个我记得修改过来了，下个PR改

确实，已经改过来了，只是在官网页面上仍然没改。

zhwesky2010 · 2024-02-18T12:33:31Z

...convert_from_pytorch/api_difference/utils/torch.utils.data.distributed.DistributedSampler.md

@@ -1,29 +1,37 @@
-## [ 参数不一致 ]torch.utils.data.distributed.DistributedSampler
+## [ torch 参数更多 ]torch.utils.data.distributed.DistributedSampler


torch多的seed可直接删除，这样是不是就不用算torch参数更多，可以看下其他的这样情况是怎么处理的

这个有不同的写法，如 #5989 的 torch.utils.data.WeightedRandomSampler 作为参数一致处理，而 #6285 的 torch.utils.data.SubsetRandomSampler 作为 torch 参数更多 处理，考虑到后者更新且都属于 Sampler，因此作为参数更多处理先。

SigureMo · 2024-03-15T18:05:21Z

docs/guides/model_convert/convert_from_pytorch/validate_mapping_in_api_difference.py

    )
    paddle_pattern = re.compile(
-        r"^### +\[ *(?P<paddle_api>paddle.[^\]]+)\]\((?P<url>[^\)]+)$"
+        r"^### +\[ *(?P<paddle_api>paddle.[^\]]+)\](?P<url>\([^\)]*\))?$"


@RedContritio

为什么 () 被包含在了 group url 里？这样提取的 url 全部包含 ()，最后生成的链接也是错的

已在 #6522 修复

RedContritio force-pushed the add_classes branch from 32669cc to b7d254c Compare January 31, 2024 20:56

paddle-bot bot added the contributor label Feb 1, 2024

RedContritio force-pushed the add_classes branch from 71e0e99 to 9609972 Compare February 4, 2024 11:59

RedContritio added 2 commits February 4, 2024 20:51

update scripts

2810d97

add some docs

0a4d8ed

zhwesky2010 reviewed Feb 5, 2024

View reviewed changes

RedContritio force-pushed the add_classes branch 2 times, most recently from 607124c to adef7f6 Compare February 5, 2024 14:53

update some docs

c2956af

RedContritio force-pushed the add_classes branch from adef7f6 to c2956af Compare February 5, 2024 14:54

zhwesky2010 reviewed Feb 6, 2024

View reviewed changes

fix docs

c14985b

zhwesky2010 approved these changes Feb 18, 2024

View reviewed changes

zhwesky2010 merged commit 0fef3b3 into PaddlePaddle:develop Feb 18, 2024

RedContritio deleted the add_classes branch February 19, 2024 01:16

SigureMo reviewed Mar 15, 2024

View reviewed changes

SigureMo mentioned this pull request Mar 15, 2024

Fix paddle url pattern in api mapping #6522

Merged

		@@ -1,29 +1,37 @@
		## [ 参数不一致 ]torch.utils.data.distributed.DistributedSampler
		## [ torch 参数更多 ]torch.utils.data.distributed.DistributedSampler

【映射文档】新增与维护部分映射文档 #6494

【映射文档】新增与维护部分映射文档 #6494

Uh oh!

Conversation

RedContritio commented Jan 31, 2024

Uh oh!

zhwesky2010 left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

zhwesky2010 commented Feb 6, 2024

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants