【PPSCI Doc No.66-74】 #829

1want2sleep · 2024-04-01T14:13:26Z

PR types

Others

PR changes

Docs

Describe

补充了以下API的文档，包括功能介绍、输入参数描述、返回值描述、代码示例
ppsci.geometry.TimeDomain.on_initial
ppsci.geometry.TimeXGeometry.uniform_points
ppsci.geometry.TimeXGeometry.random_points
ppsci.geometry.TimeXGeometry.uniform_boundary_points
ppsci.geometry.TimeXGeometry.random_boundary_points
ppsci.geometry.TimeXGeometry.uniform_initial_points
ppsci.geometry.TimeXGeometry.random_initial_points
ppsci.geometry.TimeXGeometry.periodic_point
ppsci.geometry.TimeXGeometry.sample_initial_interior

… into dev_model

paddle-bot · 2024-04-01T14:13:32Z

Thanks for your contribution!

HydrogenSulfate

多处类似的问题可以一起修改

HydrogenSulfate · 2024-04-02T04:09:50Z

ppsci/geometry/timedomain.py

@@ -71,6 +71,24 @@ def __init__(
            self.num_timestamps = len(timestamps)

    def on_initial(self, t):
+        """Check if a specific time is on the initial time point


句子结尾加上英文句号"."

HydrogenSulfate · 2024-04-02T04:18:40Z

ppsci/geometry/timedomain.py

+        """Check if a specific time is on the initial time point
+
+        Args:
+            t (float): The time to be checked.


这里的t应该是一个np.ndarray

HydrogenSulfate · 2024-04-02T04:19:19Z

ppsci/geometry/timedomain.py

+        Examples:
+            >>> import paddle
+            >>> import ppsci
+            >>> paddle.set_default_dtype("float64")


paddle没必要设置dtype，因为几何模块用的是numpy后端

HydrogenSulfate · 2024-04-02T04:21:11Z

ppsci/geometry/timedomain.py

+            >>> check1 = geom.on_initial(0.00000001)
+            >>> check2 = geom.on_initial(0.6)
+            >>> print(check1, check2)


构造长度为5的np.ndarray，并且包含t0和非t0的元素用于检查，这样比测两次更简洁

HydrogenSulfate · 2024-04-02T04:34:13Z

ppsci/geometry/timedomain.py

@@ -71,6 +71,24 @@ def __init__(
            self.num_timestamps = len(timestamps)

    def on_initial(self, t):


加上type hint： t: np.ndarray

HydrogenSulfate · 2024-04-02T04:34:39Z

ppsci/geometry/timedomain.py

+            boundary (bool): Indicates whether boundary points are included, default is True.
+
+        Returns:
+            Ndarray: a set of spatial-temporal coordinate points 'tx' that represent sample points evenly distributed within the spatial-temporal domain.


使用np.ndarray代替Ndarray

HydrogenSulfate · 2024-04-02T04:38:16Z

ppsci/geometry/timedomain.py

@@ -112,9 +130,25 @@ def boundary_normal(self, x):

    def uniform_points(self, n, boundary=True):
        """Uniform points on the spatial-temporal domain.
-
+        Note: Before using this method, you need to specify time_step or timestamps.(See Examples)


可以在__init__内加上对time_step和timestamps的检查，然后这句话可以删除

HydrogenSulfate · 2024-04-02T04:38:55Z

ppsci/geometry/timedomain.py

+            >>> timedomain = ppsci.geometry.TimeDomain(0, 1)
+            >>> geom = ppsci.geometry.Rectangle((0, 0), (1, 1))
+            >>> time_geom = ppsci.geometry.TimeXGeometry(timedomain, geom)
+            >>> time_geom.timedomain.time_step = 0.001


time_step建议在TimeDomain构造时传入设置

HydrogenSulfate · 2024-04-02T04:39:17Z

ppsci/geometry/timedomain.py

+            >>> time_geom = ppsci.geometry.TimeXGeometry(timedomain, geom)
+            >>> time_geom.timedomain.time_step = 0.001
+            >>> ts = time_geom.uniform_points(1000)
+


打印一下ts的形状

… into dev_model

1want2sleep · 2024-04-02T11:11:26Z

多处类似的问题可以一起修改

Done.

HydrogenSulfate

感谢提交PR，有几处再略微修改一下即可

HydrogenSulfate · 2024-04-03T14:16:38Z

ppsci/geometry/timedomain.py

+        if self.timedomain.time_step is None and self.timedomain.timestamps is None:
+            raise ValueError("Either time_step or timestamps must be provided.")


这里好像可以删除这个检查，因为两者可以都不设置，下方第三个分支就是处理这种情况的

HydrogenSulfate · 2024-04-03T14:18:13Z

ppsci/geometry/timedomain.py

        x = self.geometry.random_points(n, random=random)
        t = self.timedomain.t0
        return np.hstack((np.full([n, 1], t, dtype=paddle.get_default_dtype()), x))

-    def periodic_point(self, x, component):
+    def periodic_point(self, x: dict[str, np.ndarray], component: int):


dict类型的typehint统一使用 typing模块下的Dict

HydrogenSulfate · 2024-04-03T14:18:23Z

ppsci/geometry/timedomain.py

+            component (int): Specifies the components or dimensions of specific spatial coordinates that are periodically processed.
+
+        Returns:
+            dict[str, np.ndarray] : contains the original timestamps and the coordinates of the spatial point after periodic processing.


同上，应该是大写的D

HydrogenSulfate · 2024-04-03T14:18:41Z

ppsci/geometry/timedomain.py

+        y (1000, 1)
+        normal_x (1000, 1)
+        normal_y (1000, 1)
+


多余空行可以删除

HydrogenSulfate · 2024-04-03T14:18:58Z

ppsci/geometry/timedomain.py

@@ -544,11 +701,36 @@ def sample_initial_interior(
        self,
        n: int,
        random: str = "pseudo",
-        criteria=None,
-        evenly=False,
+        criteria: callable = None,


callable同理使用typing下的Callable

HydrogenSulfate · 2024-04-03T14:19:12Z

ppsci/geometry/timedomain.py

+            x (1000, 1)
+            y (1000, 1)
+            sdf (1000, 1)
+


同上，删除空行

HydrogenSulfate · 2024-04-03T14:20:18Z

ppsci/geometry/timedomain.py

@@ -350,7 +423,31 @@ def uniform_boundary_points(self, n, criteria=None):
            tx = tx[:n]
        return tx

-    def random_boundary_points(self, n, random="pseudo", criteria=None):
+    def random_boundary_points(
+        self, n: int, random: str = "pseudo", criteria: callable = None


使用typing下的Callable

默认值为None的参数需要用Optional嵌套在原类型上：Optional[Callble]

HydrogenSulfate · 2024-04-03T14:20:34Z

ppsci/geometry/timedomain.py

+        Args:
+            n (int): The total number of spatial-temporal points generated on a given geometry boundary.
+            random (string): Controls the way to generate random points. Default is "pseudo".
+            criteria (method): Used to filter the generated boundary points, only points that meet certain conditions are retained. Default is None.


docstring内的类型也对应修改一下

… into dev_model

into dev_model

HydrogenSulfate

LGTM

* ppsci.equation.PDE.parameters/state_dict/set_state_dict api fix * ppsci.equation.PDE.parameters/state_dict/set_state_dict api fix * fix api docs in the timedomain * fix api docs of timedomain * fix api docs of timedomain --------- Co-authored-by: krp <2934631798@qq.com> Co-authored-by: HydrogenSulfate <490868991@qq.com>

UnityLiker added 5 commits March 28, 2024 22:53

ppsci.equation.PDE.parameters/state_dict/set_state_dict api fix

aad358e

ppsci.equation.PDE.parameters/state_dict/set_state_dict api fix

dbddb1b

Merge branch 'develop' of https://github.com/PaddlePaddle/PaddleScience…

e327bcd

… into dev_model

fix api docs in the timedomain

4c4f631

Merge branch 'develop' of https://github.com/PaddlePaddle/PaddleScience…

5e35cd9

… into dev_model

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

luotao1 mentioned this pull request Apr 1, 2024

【快乐开源】科学计算 API 文档补全 #686

Closed

Merge branch 'develop' into dev_model

1610d18

luotao1 added the HappyOpenSource 快乐开源活动issue与PR label Apr 2, 2024

luotao1 assigned luotao1 and HydrogenSulfate Apr 2, 2024

HydrogenSulfate requested changes Apr 2, 2024

View reviewed changes

UnityLiker added 2 commits April 2, 2024 19:08

fix api docs of timedomain

c547533

Merge branch 'develop' of https://github.com/PaddlePaddle/PaddleScience…

a302cd8

… into dev_model

1want2sleep closed this Apr 2, 2024

1want2sleep reopened this Apr 2, 2024

Merge branch 'develop' into dev_model

d22ba53

HydrogenSulfate requested changes Apr 3, 2024

View reviewed changes

UnityLiker added 3 commits April 3, 2024 23:38

fix api docs of timedomain

4cf16b4

Merge branch 'develop' of https://github.com/PaddlePaddle/PaddleScience…

62941da

… into dev_model

Merge branch 'dev_model' of https://github.com/1want2sleep/PaddleScience

0b4d04a

into dev_model

HydrogenSulfate approved these changes Apr 4, 2024

View reviewed changes

HydrogenSulfate merged commit fcb277c into PaddlePaddle:develop Apr 4, 2024
3 of 4 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

【PPSCI Doc No.66-74】 #829

【PPSCI Doc No.66-74】 #829

1want2sleep commented Apr 1, 2024

paddle-bot bot commented Apr 1, 2024

HydrogenSulfate left a comment

HydrogenSulfate Apr 2, 2024

1want2sleep Apr 2, 2024 •

edited

Loading

HydrogenSulfate Apr 2, 2024

HydrogenSulfate Apr 2, 2024

HydrogenSulfate Apr 2, 2024

HydrogenSulfate Apr 2, 2024

HydrogenSulfate Apr 2, 2024

HydrogenSulfate Apr 2, 2024

HydrogenSulfate Apr 2, 2024

HydrogenSulfate Apr 2, 2024

1want2sleep commented Apr 2, 2024

HydrogenSulfate left a comment

HydrogenSulfate Apr 3, 2024

1want2sleep Apr 3, 2024

HydrogenSulfate Apr 3, 2024

HydrogenSulfate Apr 3, 2024

HydrogenSulfate Apr 3, 2024

HydrogenSulfate Apr 3, 2024

HydrogenSulfate Apr 3, 2024

HydrogenSulfate Apr 3, 2024

HydrogenSulfate Apr 3, 2024

HydrogenSulfate left a comment

		@@ -71,6 +71,24 @@ def __init__(
		self.num_timestamps = len(timestamps)

		def on_initial(self, t):

		if self.timedomain.time_step is None and self.timedomain.timestamps is None:
		raise ValueError("Either time_step or timestamps must be provided.")

【PPSCI Doc No.66-74】 #829

【PPSCI Doc No.66-74】 #829

Conversation

1want2sleep commented Apr 1, 2024

PR types

PR changes

Describe

paddle-bot bot commented Apr 1, 2024

HydrogenSulfate left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

1want2sleep Apr 2, 2024 • edited Loading

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

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

1want2sleep commented Apr 2, 2024

HydrogenSulfate left a 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

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

HydrogenSulfate left a comment

Choose a reason for hiding this comment

1want2sleep Apr 2, 2024 •

edited

Loading