[CodeStyle][Xdoctest][8,12,15,16,18-20,22-26,29-40,42,43,45-48,50,51,60-65,75,80,82,83,85-87,89-94,99-141,143,145,147-167,169-187,207-220,257,258,260-275,277-313,315-325][API Compatibility] Update shape output format in documentation examples by LittleHeroZZZX · Pull Request #76574 · PaddlePaddle/Paddle

LittleHeroZZZX · 2025-11-24T11:07:25Z

PR Category

User Experience

PR Types

Docs

Description

#76361 后，Paddle 的 shape 类型从 List 变成 paddle.Size。

本 PR 扫描了 Python 目录下含有 .shape 语句的 sample 代码，并将输出的 List 修改为 Paddle.Size

paddle-bot · 2025-11-24T11:07:31Z

你的PR提交成功，感谢你对开源项目的贡献!
请关注后续CI自动化测试结果，详情请参考Paddle-CI手册。
Your PR has been submitted. Thanks for your contribution!
Please wait for the result of CI firstly. See Paddle CI Manual for details.

codecov-commenter · 2025-11-24T16:40:27Z

Codecov Report

❌ Patch coverage is 87.50000% with 1 line in your changes missing coverage. Please review.
⚠️ Please upload report for BASE (develop@fa5e056). Learn more about missing BASE report.

Files with missing lines	Patch %	Lines
python/paddle/nn/layer/norm.py	0.00%	1 Missing ⚠️

❌ Your patch status has failed because the patch coverage (87.50%) is below the target coverage (90.00%). You can increase the patch coverage or adjust the target coverage.

Additional details and impacted files

@@            Coverage Diff             @@
##             develop   #76574   +/-   ##
==========================================
  Coverage           ?   87.50%           
==========================================
  Files              ?        5           
  Lines              ?        8           
  Branches           ?        0           
==========================================
  Hits               ?        7           
  Misses             ?        1           
  Partials           ?        0

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

zhwesky2010 · 2025-11-25T06:30:26Z

python/paddle/autograd/autograd.py

+            paddle.Size([3, 3])
            >>> print(H_y_x1_x2.shape)
-            [3, 4]
+            paddle.Size([3, 4]


有些后面没有括号

先不 Review，替换脚本还不够完善，并且也没按照 #76545 的要求修改为 pycon

SigureMo

有几处因为 magic trailing comma 的存在格式化的不太好看，麻烦删掉这些 comma 后重新格式化下（ruff format .）

SigureMo · 2025-11-25T14:33:34Z

python/paddle/autograd/autograd.py

-            >>> x2 = paddle.randn([3, ])
+            >>> x1 = paddle.randn(
+            ...     [
+            ...         3,


这个格式化后太难看了，麻烦把后面的 , 删掉，这样格式化后的就正常了

SigureMo · 2025-11-25T14:33:41Z

python/paddle/autograd/autograd.py

+            ... )
+            >>> x2 = paddle.randn(
+            ...     [
+            ...         3,


SigureMo · 2025-11-25T14:33:53Z

python/paddle/autograd/autograd.py

+            ...     [
+            ...         4,
+            ...     ]
+            ... )


SigureMo · 2025-11-25T14:34:23Z

python/paddle/distribution/bernoulli.py

-                >>> rsample = rv.rsample([3, ])
+                >>> rsample = rv.rsample(
+                ...     [
+                ...         3,


SigureMo · 2025-11-25T14:34:31Z

python/paddle/distribution/bernoulli.py

+                ...     paddle.nn.functional.sigmoid(
+                ...         rv.rsample(
+                ...             [
+                ...                 1000,


SigureMo · 2025-11-25T14:34:41Z

python/paddle/distribution/bernoulli.py

+                ...     paddle.nn.functional.sigmoid(
+                ...         rv.rsample(
+                ...             [
+                ...                 1000,


SigureMo · 2025-11-25T14:37:18Z

python/paddle/incubate/nn/functional/variable_length_memory_efficient_attention.py

+            ... )
+            >>> seq_lens = paddle.to_tensor(
+            ...     [
+            ...         seq_len,


SigureMo · 2025-11-25T14:40:43Z

python/paddle/nn/functional/sparse_attention.py

+            ...             [
+            ...                 [
+            ...                     0,
+            ...                     1,


这里也是，辛苦删掉 1 后面的这个 , 再格式化下

SigureMo · 2025-11-25T15:02:48Z

另外辛苦在 pyproject.toml 里修改一下 line-length 吧，因为这是第一个大 PR，能反映出来整体 format 的一些问题，现在看起来明显有不少不必要的折行，我们可以把 line-length 调大些

 [tool.ruff.format]
 # Prevent change to double quotes by some users use ruff format
 quote-style = "preserve"
 docstring-code-format = true
+docstring-code-line-length = 120

辛苦调整后跑一次 ruff format . 全量格式化下～

cc. @ooooo-create 如果后续有其他 PR，需要先等这个 PR merge

LittleHeroZZZX · 2025-11-25T15:34:45Z

辛苦在 pyproject.toml 里修改一下 line-length 吧

Done. static check 还没过，应该存在一些正确性问题，明天再改

Copilot

Pull request overview

This PR updates documentation examples across the Paddle codebase to reflect a change in the shape output format. Following PR #76361, the .shape attribute now returns paddle.Size([...]) instead of a plain list [...]. The changes ensure that documentation examples accurately reflect this new output format.

Key Changes:

Updated shape output format in documentation from [3, 2, 4] to paddle.Size([3, 2, 4])
Changed code block type from python to pycon to match the doctest format
Added docstring-code-line-length = 120 to pyproject.toml for better formatting control
Minor code style improvements (spacing, line breaks) for better readability

Reviewed changes

Copilot reviewed 81 out of 81 changed files in this pull request and generated no comments.

Show a summary per file

File	Description
pyproject.toml	Added docstring code line length configuration (120 characters)
test/legacy_test/nets.py	Reformatted multi-line function calls to single lines
python/paddle/vision/transforms/transforms.py	Updated shape outputs and changed code blocks to pycon format
python/paddle/vision/transforms/functional.py	Updated shape outputs to paddle.Size format
python/paddle/vision/ops.py	Updated shape outputs in vision operation examples
python/paddle/vision/models/*.py	Updated shape outputs for VGG, ResNet, MobileNet, and other model examples
python/paddle/tensor/*.py	Updated shape outputs in tensor manipulation, math, linalg, and creation functions
python/paddle/nn/layer/*.py	Updated shape outputs in pooling, conv, norm, RNN, and transformer layer examples
python/paddle/nn/functional/*.py	Updated shape outputs in functional API examples
python/paddle/sparse/*.py	Updated shape outputs in sparse tensor examples
python/paddle/signal.py	Updated shape outputs in signal processing examples
python/paddle/incubate/*.py	Updated shape outputs in incubator module examples
python/paddle/distribution/*.py	Updated shape outputs in distribution examples
python/paddle/autograd/autograd.py	Updated shape outputs in autograd examples

The changes are consistent and appropriate throughout the codebase. All documentation examples now correctly reflect the new paddle.Size output format, ensuring users have accurate expectations when running code examples.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

zhwesky2010 added the API Compatibility label Nov 25, 2025

zhwesky2010 reviewed Nov 25, 2025

View reviewed changes

all

5b38593

LittleHeroZZZX force-pushed the apis/size branch from f5a1768 to 5b38593 Compare November 25, 2025 08:07

ooooo-create mentioned this pull request Nov 25, 2025

📝 文档示例代码修复任务 #76545

Closed

SigureMo reviewed Nov 25, 2025

View reviewed changes

LittleHeroZZZX added 2 commits November 25, 2025 15:17

Set docstring-code-line-length to 120 in pyproject.toml and reformat

75bdd7e

Remove unnessary magic comma

5711c5d

LittleHeroZZZX requested a review from gouzil as a code owner November 25, 2025 15:32

SigureMo added 2 commits November 26, 2025 00:39

fix missing paddle.Size() wrapper

52e024e

refine matrix format

321d6ea

SigureMo requested a review from Copilot November 25, 2025 16:50

Copilot started reviewing on behalf of SigureMo November 25, 2025 16:51 View session

Copilot finished reviewing on behalf of SigureMo November 25, 2025 16:51

SigureMo approved these changes Nov 25, 2025

View reviewed changes

Copilot AI reviewed Nov 25, 2025

View reviewed changes

swgu98 added the skip-ci: approval label Nov 26, 2025

SigureMo merged commit c769ecb into PaddlePaddle:develop Nov 26, 2025
83 of 88 checks passed

Conversation

LittleHeroZZZX commented Nov 24, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

PR Category

PR Types

Description

Uh oh!

paddle-bot bot commented Nov 24, 2025

Uh oh!

codecov-commenter commented Nov 24, 2025

Codecov Report

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

SigureMo left a comment

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!

SigureMo commented Nov 25, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

LittleHeroZZZX commented Nov 25, 2025

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

LittleHeroZZZX commented Nov 24, 2025 •

edited

Loading

SigureMo commented Nov 25, 2025 •

edited

Loading