【PPSCI Doc No.41-57】 #833
Merged
【PPSCI Doc No.41-57】 #833
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Thanks for your contribution! |
HydrogenSulfate
requested changes
Apr 6, 2024
There was a problem hiding this comment.
- 函数的参数可以加上和typehint，与docstring保持一（当类型注解为类自身时，建议加上双引号，比如
geom: "Geometry"） - docstring的 Returns 类型外面好像不需要套上小括号？
ppsci/geometry/geometry.py
Outdated
| where D is the number of dimension of geometry. | ||
|
|
||
| Returns: | ||
| (np.ndarray): Boolean array where x is inside the geometry. The shape is [N, 1]. |
There was a problem hiding this comment.
实测输出形状应该是[N]，下面类似的可以一起改一下
ppsci/geometry/geometry.py
Outdated
| [ 0.25868416]], dtype=float32), 'sdf__y': array([[-0. ], | ||
| [ 0.74118376]], dtype=float32)} | ||
| >>> cuboid = ppsci.geometry.Cuboid((0, 0, 0), (1, 1, 1)) | ||
| >>> cuboid.sample_interior(2,"pseudo", None, True, True) |
Closed
HydrogenSulfate
requested changes
Apr 7, 2024
ppsci/geometry/geometry.py
Outdated
| n, | ||
| random="pseudo", | ||
| n: int, | ||
| random: str = "pseudo", | ||
| criteria=None, |
There was a problem hiding this comment.
criteria的类型注解是Optional[Callable]
There was a problem hiding this comment.
默认值为None的类型注解需要在原类型外面加上Optional，比如Optional[bool]
ppsci/geometry/geometry.py
Outdated
| def sample_boundary(self, n, random="pseudo", criteria=None, evenly=False): | ||
| """Compute the random points in the geometry and return those meet criteria.""" | ||
| def sample_boundary( | ||
| self, n: int, random: str = "pseudo", criteria=None, evenly=False |
There was a problem hiding this comment.
比如，这里可以改为：criteria: Optional[Callable]和evenly: bool = False
HydrogenSulfate
requested changes
Apr 7, 2024
There was a problem hiding this comment.
文件开头加一下：
from typing import Callable
from typing import Dict
ppsci/geometry/geometry.py
Outdated
Comment on lines
137
to
139
| np.ndarray: Random points in the geometry. The shape is [N, D]. | ||
| their signed distance function. The shape is [N]. | ||
| their derivatives of SDF(optional). The shape is [N]. |
There was a problem hiding this comment.
- 返回值是Dict[str, np.ndarray]，而不是np.ndarray
- their signed distance function. The shape is [N, 1].
- their derivatives of SDF(optional). The shape is [N, D].
ppsci/geometry/geometry.py
Outdated
Comment on lines
227
to
230
| Returns: | ||
| np.ndarray: Random points in the geometry. The shape is [N, D]. | ||
| their normal vectors. The shape is [N, D]. | ||
| their area. The shape is [N].(only if the geometry is a mesh) |
ppsci/geometry/geometry.py
Outdated
| """Compute the random points in the geometry and return those meet criteria.""" | ||
| def sample_boundary( | ||
| self, n: int, random: str = "pseudo", criteria: Optional[Callable] = None, evenly: bool = False | ||
| ) -> np.ndarray: |
ppsci/geometry/geometry.py
Outdated
| compute_sdf_derivatives: bool = False, | ||
| ): | ||
| """Sample random points in the geometry and return those meet criteria.""" | ||
| ) -> np.ndarray: |
There was a problem hiding this comment.
返回值类型改为Dict[str, np.ndarray]
ppsci/geometry/geometry.py
Outdated
Comment on lines
349
to
354
| def uniform_boundary_points(self, n: int): | ||
| """Compute the equi-spaced points on the boundary.""" | ||
| """Compute the equi-spaced points on the boundary(not implemented). | ||
|
|
||
| Warings: | ||
| This function is not implemented, please use random_boundary_points instead. | ||
| """ |
|
hi, @wufei2
|
huohuohuohuohuo123
pushed a commit
to huohuohuohuohuo123/PaddleScience
that referenced
this pull request
Aug 12, 2024
* fix docs bugs * fix docs bugs * fix codestyle bug * fix codestyle bugs * fix codestyle bugs * fix some bugs * fix codetype error * fix other bugs * fix typehint bugs * fix other bugs * fix codestyle bug * fix codestyle bug
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
PR types
Others
PR changes
Others
Describe
对以下文档进行了补全:
ppsci.geometry.Geometry.and
ppsci.geometry.Geometry.or
ppsci.geometry.Geometry.sub
ppsci.geometry.Geometry.str
ppsci.geometry.Geometry.difference
ppsci.geometry.Geometry.intersection
ppsci.geometry.Geometry.is_inside
ppsci.geometry.Geometry.on_boundary
ppsci.geometry.Geometry.periodic_point
ppsci.geometry.Geometry.random_boundary_points
ppsci.geometry.Geometry.random_points
ppsci.geometry.Geometry.sample_boundary
ppsci.geometry.Geometry.sample_interior
ppsci.geometry.Geometry.sdf_derivatives
ppsci.geometry.Geometry.uniform_boundary_points
ppsci.geometry.Geometry.uniform_points
ppsci.geometry.Geometry.union