Add typing and type annotations for icbc #1453

hheei · 2023-08-21T23:48:36Z

creating an extra file called types.py, referred from torch.

Saransh-cpp

Some suggestions 🙂

Given that DeepXDE supports only Python 3.8+, we can use -

from __future__ import annotations

to stay up to date!

I have made a few suggestions regarding the comment above - the rest of the types can be revamped accordingly too!

Also, mypy should be added in the CI to make sure that the types are correct and are being respected throughout the codebase. You can add mypy's configuration in pyproject.toml. This can maybe go in another PR.

(PS: these are just suggestions, the final call would be of DeepXDE's maintainers.)

Saransh-cpp · 2023-08-22T22:46:02Z

deepxde/icbc/boundary_conditions.py

 import numbers
 from abc import ABC, abstractmethod
 from functools import wraps
+from typing import Any, Callable, List, Optional, overload, Tuple, Union


Given that DeepXDE supports Python 3.8+, you should use -

from __future__ import annotations from typing import Any, Callable, Optional, overload

Saransh-cpp · 2023-08-22T22:48:06Z

deepxde/icbc/boundary_conditions.py

+        outputs: Tensor,
+        beg: int,
+        end: int,
+        aux_var: Union[NDArray[np.float_], None] = None,


This should work once the suggestion above is applied.

Suggested change

aux_var: Union[NDArray[np.float_], None] = None,

aux_var: NDArray[np.float_] | None = None,

Saransh-cpp · 2023-08-22T22:48:36Z

deepxde/icbc/boundary_conditions.py

+        geom: Geometry,
+        func: Callable[[NDArray[np.float_]], NDArray[np.float_]],
+        on_boundary: Callable[[NDArray[Any], NDArray[Any]], NDArray[np.bool_]],
+        component: Union[List[int], int] = 0,


Suggested change

component: Union[List[int], int] = 0,

component: list[int] | int = 0,

Saransh-cpp · 2023-08-22T22:50:53Z

deepxde/types.py

+
+# Tensor from any backend
+Tensor = TypeVar("Tensor")
+TensorOrTensors = Union[Tensor, Sequence[Tensor]]


Suggested change

TensorOrTensors = Union[Tensor, Sequence[Tensor]]

TensorOrTensors = Tensor | Sequence[Tensor]

Saransh-cpp · 2023-08-22T22:51:40Z

deepxde/types.py

@@ -0,0 +1,7 @@
+import numpy as np
+from typing import Callable, Dict, List, Optional, Sequence, Tuple, Union, TypeVar


Suggested change

from typing import Callable, Dict, List, Optional, Sequence, Tuple, Union, TypeVar

from __future__ import annotations

from typing import Sequence, TypeVar

Thank you for your suggestions, I will change them later 👍

lululxvi · 2023-08-26T01:29:07Z

Good suggestions @Saransh-cpp

lululxvi · 2025-04-07T03:00:39Z

@supercgor @Saransh-cpp Any idea about this PR?

Saransh-cpp

@lululxvi this looks almost ready, but needs to be polished for merging. It would be great if @supercgor can pick this up again :)

Saransh-cpp · 2025-04-07T09:41:02Z

deepxde/backend/backend.py

+from ..types import Tensor, dtype, SparseTensor, TensorOrTensors
+from numpy.typing import NDArray, ArrayLike


These imports (the heavy ones) should be under an if typing.TYPE_CHECKING.

Saransh-cpp · 2025-04-07T09:42:48Z

deepxde/backend/backend.py



-def is_tensor(obj):
+def is_tensor(obj: object) -> bool:


Using object in type hints is not useful + not a very common practice. You would want to narrow this down ideally (because it is as helpful as not having a type hint at the moment).

Saransh-cpp · 2025-04-07T09:43:53Z

deepxde/geometry/geometry.py

+from numbers import Number

 import numpy as np
+from numpy.typing import NDArray


Should be moved in an if condition.

Saransh-cpp · 2025-04-07T09:44:50Z

deepxde/geometry/geometry_2d.py

+from typing import Any, Literal

 import numpy as np
+from numpy.typing import ArrayLike, NDArray


Saransh-cpp · 2025-04-07T09:45:02Z

deepxde/geometry/geometry_2d.py

 from .sampler import sample
 from .. import backend as bkd
 from .. import config
+from ..types import Tensor


Saransh-cpp · 2025-04-07T09:46:04Z

deepxde/geometry/geometry_2d.py

            self.x3_tensor = bkd.as_tensor(self.x3)

-        diff_x1_x2 = diff_x1_x3 = diff_x2_x3 = None
+        # diff_x1_x2 = diff_x1_x3 = diff_x2_x3 = 0.0


There are a couple of code (logic) changes in this PR, which should not be the case.

Saransh-cpp · 2025-04-07T09:47:08Z

deepxde/geometry/timedomain.py


-class GeometryXTime:
-    def __init__(self, geometry, timedomain):
+class GeometryXTime():


Suggested change

class GeometryXTime():

class GeometryXTime:

Saransh-cpp · 2025-04-07T09:48:54Z

deepxde/types.py

We should not call this file as types as types is a builtin Python module.

Saransh-cpp · 2025-04-07T09:49:14Z

pyproject.toml

+[mypy]
+python_version = 3.8
+strict = false
+ignore_missing_imports = true


Suggested change

ignore_missing_imports = true

ignore_missing_imports = true

hheei added 7 commits August 21, 2023 19:35

add typing and type annotations for ICBC

7d82528

update

25cd004

format

68a85fa

update

74cee5b

fix sequence

45e8ac9

rename as tensor

9f4c722

format fix

a491700

Saransh-cpp suggested changes Aug 22, 2023

View reviewed changes

hheei added 2 commits August 22, 2023 22:11

update annotation representation

3eacc22

a = b | c is only valid in py3.10

f8c2d99

hheei added 3 commits September 4, 2023 14:55

typing for geometry

19fdaed

testing

f81f4be

bug fix

2ef9831

Saransh-cpp suggested changes Apr 7, 2025

View reviewed changes

	aux_var: Union[NDArray[np.float_], None] = None,
	aux_var: NDArray[np.float_] \| None = None,

	component: Union[List[int], int] = 0,
	component: list[int] \| int = 0,

	TensorOrTensors = Union[Tensor, Sequence[Tensor]]
	TensorOrTensors = Tensor \| Sequence[Tensor]

		@@ -0,0 +1,7 @@
		import numpy as np
		from typing import Callable, Dict, List, Optional, Sequence, Tuple, Union, TypeVar

	from typing import Callable, Dict, List, Optional, Sequence, Tuple, Union, TypeVar
	from __future__ import annotations
	from typing import Sequence, TypeVar

		from ..types import Tensor, dtype, SparseTensor, TensorOrTensors
		from numpy.typing import NDArray, ArrayLike

Add typing and type annotations for icbc #1453

Are you sure you want to change the base?

Add typing and type annotations for icbc #1453

Uh oh!

Conversation

hheei commented Aug 21, 2023

Uh oh!

Saransh-cpp 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!

lululxvi commented Aug 26, 2023

Uh oh!

lululxvi commented Apr 7, 2025

Uh oh!

Saransh-cpp 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!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants