New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[Typing][A-5] Add type annotations for `paddle/tensor/linalg.py` #65274

Merged

SigureMo merged 8 commits into PaddlePaddle:develop from gouzil:typehint/tensor_linalg

Jun 24, 2024

Member

gouzil commented Jun 19, 2024

PR Category

User Experience

PR Types

Improvements

Description

类型标注：

paddle/tensor/linalg.py

Related links

[Type Hints] 为公开 API 标注类型提示信息 #65008

@SigureMo @megemini


          [Typing][A-5] Add type annotations for paddle/tensor/linalg.py

20f1356

paddle-bot bot commented Jun 19, 2024

你的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.

paddle-bot bot added the contributor label

gouzil requested review from SigureMo and removed request for SigureMo

June 19, 2024 05:06

gouzil changed the title ~~[Typing][A-5] Add type annotations for paddle/tensor/linalg.py~~ [WIP][Typing][A-5] Add type annotations for paddle/tensor/linalg.py

fix

e347d2e

gouzil changed the title ~~[WIP][Typing][A-5] Add type annotations for paddle/tensor/linalg.py~~ [Typing][A-5] Add type annotations for paddle/tensor/linalg.py

gouzil requested a review from SigureMo

June 19, 2024 05:09

SigureMo reviewed

View reviewed changes

python/paddle/tensor/linalg.py Outdated

               __all__ = []
               # Consistent with kDefaultDim from C++ Backend
               K_DEFAULT_DIM = 9
-              def transpose(x, perm, name=None):
+              def transpose(
+                  x: Tensor, perm: list[int] | tuple[int, ...], name: str | None = None

Member

SigureMo Jun 19, 2024

Suggested change

      
                x: Tensor, perm: list[int] | tuple[int, ...], name: str | None = None
          
                x: Tensor, perm: Sequence[int], name: str | None = None

python/paddle/tensor/linalg.py Outdated

+              def vector_norm(
+                  x: Tensor,
+                  p: float = 2.0,
+                  axis: int | list[int] | tuple[int, ...] | None = None,

Member

SigureMo Jun 19, 2024

同上

python/paddle/tensor/linalg.py Outdated

-              def norm(x, p=None, axis=None, keepdim=False, name=None):
+              def norm(
+                  x: paddle.Tensor,
+                  p: float | Literal['fro', 'nuc'] | None = None,

Member

SigureMo Jun 19, 2024

这个 Literal 出现了多次，是否可以提取成一个 TypeAlias？

python/paddle/tensor/linalg.py Outdated

    
            @@ -1389,7 +1442,7 @@ def mat_norm(input, porder=1.0, axis=None):
          
                              )

                          return out

                  def fro_norm(input, porder=2, axis=[-1]):

                  def fro_norm(input: Tensor, porder: float = 2, axis=[-1]) -> Tensor:

Member

SigureMo Jun 19, 2024

axis 的类型？

python/paddle/tensor/linalg.py Outdated

+              def cross(
+                  x: Tensor,
+                  y: Tensor,
+                  axis: int | list[int] | tuple[int, ...] = 9,

Member

SigureMo Jun 19, 2024

用 Sequence

python/paddle/tensor/linalg.py Outdated

@@ @@ -2927,7 +3030,9 @@ def qr(x, mode="reduced", name=None): @@
                           return q, r
-              def lu(x, pivot=True, get_infos=False, name=None):
+              def lu(
+                  x, pivot: bool = True, get_infos: bool = False, name: str | None = None

Member

SigureMo Jun 19, 2024

x 的类型？

python/paddle/tensor/linalg.py Outdated

-              def lu(x, pivot=True, get_infos=False, name=None):
+              def lu(
+                  x, pivot: bool = True, get_infos: bool = False, name: str | None = None
+              ) -> Tensor | tuple[Tensor, Tensor] | tuple[Tensor, Tensor, Tensor]:

Member

SigureMo Jun 19, 2024

输出元素个数是静态可区分的吗？比如是否可以根据输入签名确定输出的元素个数，如果可以的话，使用 @overload，因为输出是 Union 对于下游来说是非常不友好的（往往需要 assert/if isinstance check）

fix

2ee981e

megemini mentioned this pull request

[Type Hints] 为公开 API 标注类型提示信息 #65008

Closed

megemini reviewed

View reviewed changes

python/paddle/tensor/linalg.py Outdated

+              if TYPE_CHECKING:
+                  from paddle import Tensor
+                  _Porder: TypeAlias = Literal['fro', 'nuc']

Contributor

megemini Jun 19, 2024

Suggested change

      
                _Porder: TypeAlias = Literal['fro', 'nuc']
          
                _POrder: TypeAlias = Literal['fro', 'nuc']

python/paddle/tensor/linalg.py Outdated

-              def matrix_norm(x, p='fro', axis=[-2, -1], keepdim=False, name=None):
+              def matrix_norm(
+                  x: Tensor,
+                  p: float | str = 'fro',

Contributor

megemini Jun 19, 2024

这里也是 _POrder 吧？

python/paddle/tensor/linalg.py Outdated

-                  def p_matrix_norm(input, porder=1.0, axis=axis, keepdim=False, name=None):
+                  def p_matrix_norm(
+                      input: Tensor,
+                      porder: float | str = 1.0,

Contributor

megemini Jun 19, 2024

_POrder ?

python/paddle/tensor/linalg.py Outdated

Comment on lines 984 to 990

+              def norm(
+                  x: paddle.Tensor,
+                  p: float | _Porder | None = None,
+                  axis: int | list[int] | tuple[int, int] | None = None,
+                  keepdim: bool = False,
+                  name: str | None = None,
+              ) -> paddle.Tensor:

Contributor

megemini Jun 19, 2024

统一用 Tensor 吧～

python/paddle/tensor/linalg.py Outdated

-              def pinv(x, rcond=1e-15, hermitian=False, name=None):
+              def pinv(
+                  x: Tensor,
+                  rcond: Tensor = 1e-15,

Contributor

megemini Jun 19, 2024

float | Tensor

python/paddle/tensor/linalg.py Outdated

Comment on lines 3058 to 3062

+              @overload
+              def lu(
+                  x: Tensor, pivot: bool = ..., get_infos: bool = ..., name: str | None = None
+              ) -> tuple[Tensor, Tensor] | tuple[Tensor, Tensor, Tensor]:
+                  ...

Contributor

megemini Jun 19, 2024

这一段是不是没啥必要？通过 get_infos 分流，这里相当于上面两个的 union，就重复了？

另外，如果使用了 @overload 的话，下面具体 def lu 就不用再重复标注了～

python/paddle/tensor/linalg.py Outdated

Comment on lines 2969 to 2973

+              def qr(
+                  x: Tensor,
+                  mode: Literal['reduced', 'complete', 'r'] = "reduced",
+                  name: str | None = None,
+              ) -> tuple[Tensor, Tensor] | Tensor:

Contributor

megemini Jun 19, 2024

这里貌似也可以根据 mode 分流？

SigureMo reviewed

View reviewed changes

python/paddle/tensor/linalg.py Outdated

+                  x: Tensor,
+                  pivot: bool = ...,
+                  get_infos: Literal[False] = ...,
+                  name: str | None = None,

Member

SigureMo Jun 19, 2024

Suggested change

      
                name: str | None = None,
          
                name: str | None = ...,

纯类型标注的签名这里用 ...

gouzil added 2 commits

June 19, 2024 20:08


          fix review

2c1a71f


          fix ascii

70e9b37

Member

SigureMo commented Jun 20, 2024

static-check 需要看下

SigureMo mentioned this pull request

[Typing][A-12] Add type annotations for paddle/tensor/stat.py #65337

Merged

gouzil added 2 commits

June 21, 2024 00:18


          fix overload

fa4cb0f


          clean overload

b982801

SigureMo previously approved these changes

View reviewed changes

Member

SigureMo left a comment

LGTMeow

Member

SigureMo commented Jun 21, 2024

看样子给 PR-CI-Paddle-Doc-Preview 搞挂了，得看看

Member

SigureMo commented Jun 21, 2024

http://preview-paddle-pr-65274.paddle-docs-preview.paddlepaddle.org.cn/documentation/docs/en/api/paddle/linalg/lu_en.html


          * -> \*

a5001e6

gouzil dismissed SigureMo’s stale review via

a5001e6

June 21, 2024 07:55

gouzil requested a review from SigureMo

June 21, 2024 15:36

SigureMo approved these changes

View reviewed changes

SigureMo approved these changes

View reviewed changes

SigureMo added the HappyOpenSource label

SigureMo self-assigned this

SigureMo mentioned this pull request

[Typing][A-7] Add type annotations for paddle/tensor/manipulation.py #65351

Merged

tianshuo78520a approved these changes

View reviewed changes

SigureMo merged commit 4c84c13 into PaddlePaddle:develop

32 of 33 checks passed

co63oc pushed a commit to co63oc/Paddle that referenced this pull request


          [Typing][A-5] Add type annotations for paddle/tensor/linalg.py (Pad…

e49cd26

…dlePaddle#65274)

co63oc pushed a commit to co63oc/Paddle that referenced this pull request


          [Typing][A-5] Add type annotations for paddle/tensor/linalg.py (Pad…

7214fef

…dlePaddle#65274)

gouzil deleted the typehint/tensor_linalg branch

July 20, 2024 05:29

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

contributor HappyOpenSource