Skip to content

Commit 13c59c5

Browse files
[Doc] Refine doc (#927)
* remove vtk for slim requirements.txt * fix document of ldc2d_steady.md * refine grad_norm * remove redundant profiler.py file * refine docs * fix gradnorm * restore gradnorm to original version * remove pyvista from requirements.txt
1 parent e54915d commit 13c59c5

File tree

6 files changed

+5
-161
lines changed

6 files changed

+5
-161
lines changed

docs/zh/examples/ldc2d_steady.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -205,13 +205,13 @@ $$
205205
### 3.1 模型构建
206206

207207
在 2D-LDC 问题中,每一个已知的坐标点 $(x, y)$ 都有自身的横向速度 $u$、纵向速度 $v$、压力 $p$
208-
三个待求解的未知量,我们在这里使用比较简单的 MLP(Multilayer Perceptron, 多层感知机) 来表示 $(x, y)$ 到 $(u, v, p)$ 的映射函数 $f: \mathbb{R}^2 \to \mathbb{R}^3$ ,即:
208+
三个待求解的未知量,我们在这里使用适合于 PINN 任务的 PirateNet 来表示 $(x, y)$ 到 $(u, v, p)$ 的映射函数 $f: \mathbb{R}^2 \to \mathbb{R}^3$ ,即:
209209

210210
$$
211211
u, v, p = f(x, y)
212212
$$
213213

214-
上式中 $f$ 即为 MLP 模型本身,用 PaddleScience 代码表示如下
214+
上式中 $f$ 即为 `PirateNet` 模型本身,用 PaddleScience 代码表示如下
215215

216216
``` py linenums="41"
217217
--8<--

docs/zh/quickstart.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -148,7 +148,7 @@ examples/quick_start/case1.py
148148

149149
虽然无法求出解析式直接构造监督数据,但往往可以利用相关数学知识,推导出目标拟合函数符合的某种数学关系,以训练模型以满足这种数学关系的方式,达到以“间接监督”的方式优化模型的目的。
150150

151-
假设我们不再使用 $u=\sin(x)$ 这一先验公式,因而无法计算标签数据 $u$。因此我们使用如下方程组,其含有一个偏微分方程和边界条件
151+
假设我们不再使用 $u=\sin(x)$ 这一先验公式,因而无法计算标签数据 $u$。因此使用如下方程组,其含有一个偏微分方程和边界条件
152152

153153
$$
154154
\begin{cases}

docs/zh/user_guide.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -492,7 +492,7 @@ PaddleScience 提供了多种推理配置组合,可通过命令行进行组合
492492
493493
=== "方式2: 修改代码"
494494
495-
因此我们只需要在 `Solver` 时指定 `checkpoint_path` 参数为 `latest.*` 的所在路径,即可自动载入上述的几个文件,并从 `latest` 中记录的 epoch 开始继续训练。
495+
只需要在 `Solver` 时指定 `checkpoint_path` 参数为 `latest.*` 的所在路径,即可自动载入上述的几个文件,并从 `latest` 中记录的 epoch 开始继续训练。
496496
497497
``` py hl_lines="7"
498498
import ppsci
@@ -993,7 +993,7 @@ TODO -->
993993
994994
## 3. 使用 Nsight 进行性能分析
995995
996-
Nsight是NVIDIA面相开发者提供的开发工具套件,能提供深入的跟踪、调试、评测和分析,以优化跨 NVIDIA GPU和CPU的复杂计算应用程序。详细文档可参考:[Nsight Systems Document](https://docs.nvidia.com/nsight-systems/index.html)
996+
Nsight是NVIDIA面向开发者提供的开发工具套件,能提供深入的跟踪、调试、评测和分析,以优化跨 NVIDIA GPU和CPU的复杂计算应用程序。详细文档可参考:[Nsight Systems Document](https://docs.nvidia.com/nsight-systems/index.html)
997997
998998
PaddleScience 初步支持使用 Nsight 进行性能分析,以 linux 开发环境 + laplace2d 案例为例,按照如下步骤使用 nsight 工具生成性能分析报告并查看分析结果。
999999

ppsci/utils/__init__.py

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,6 @@
1919
from ppsci.utils import initializer
2020
from ppsci.utils import logger
2121
from ppsci.utils import misc
22-
from ppsci.utils import profiler
2322
from ppsci.utils import reader
2423
from ppsci.utils import writer
2524
from ppsci.utils.checker import dynamic_import_to_globals
@@ -49,7 +48,6 @@
4948
"ema",
5049
"reader",
5150
"writer",
52-
"profiler",
5351
"load_csv_file",
5452
"load_mat_file",
5553
"load_npz_file",

ppsci/utils/profiler.py

Lines changed: 0 additions & 152 deletions
This file was deleted.

requirements.txt

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,6 @@ meshio==5.3.4
77
numpy>=1.20.0,<=1.23.1
88
pydantic>=2.5.0
99
pyevtk
10-
pyvista==0.37.0
1110
pyyaml
1211
scikit-learn<1.5.0
1312
scikit-optimize
@@ -16,5 +15,4 @@ seaborn
1615
sympy
1716
tqdm
1817
typing-extensions
19-
vtk
2018
wget

0 commit comments

Comments
 (0)