[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
PaddlePaddle · Jun 17, 2024 · 13c59c5 · 13c59c5
1 parent e54915d
commit 13c59c5
Show file tree

Hide file tree

Showing 6 changed files with 5 additions and 161 deletions.
diff --git a/docs/zh/examples/ldc2d_steady.md b/docs/zh/examples/ldc2d_steady.md
@@ -205,13 +205,13 @@ $$
 ### 3.1 模型构建
 
 在 2D-LDC 问题中，每一个已知的坐标点 $(x, y)$ 都有自身的横向速度 $u$、纵向速度 $v$、压力 $p$
-三个待求解的未知量，我们在这里使用比较简单的 MLP(Multilayer Perceptron, 多层感知机) 来表示 $(x, y)$ 到 $(u, v, p)$ 的映射函数 $f: \mathbb{R}^2 \to \mathbb{R}^3$ ，即：
+三个待求解的未知量，我们在这里使用适合于 PINN 任务的 PirateNet 来表示 $(x, y)$ 到 $(u, v, p)$ 的映射函数 $f: \mathbb{R}^2 \to \mathbb{R}^3$ ，即：
 
 $$
 u, v, p = f(x, y)
 $$
 
-上式中 $f$ 即为 MLP 模型本身，用 PaddleScience 代码表示如下
+上式中 $f$ 即为 `PirateNet` 模型本身，用 PaddleScience 代码表示如下
 
 ``` py linenums="41"
 --8<--

diff --git a/docs/zh/quickstart.md b/docs/zh/quickstart.md
@@ -148,7 +148,7 @@ examples/quick_start/case1.py
 
 虽然无法求出解析式直接构造监督数据，但往往可以利用相关数学知识，推导出目标拟合函数符合的某种数学关系，以训练模型以满足这种数学关系的方式，达到以“间接监督”的方式优化模型的目的。
 
-假设我们不再使用 $u=\sin(x)$ 这一先验公式，因而无法计算标签数据 $u$。因此我们使用如下方程组，其含有一个偏微分方程和边界条件
+假设我们不再使用 $u=\sin(x)$ 这一先验公式，因而无法计算标签数据 $u$。因此使用如下方程组，其含有一个偏微分方程和边界条件
 
 $$
 \begin{cases}

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

diff --git a/ppsci/utils/__init__.py b/ppsci/utils/__init__.py
@@ -19,7 +19,6 @@
 from ppsci.utils import initializer
 from ppsci.utils import logger
 from ppsci.utils import misc
-from ppsci.utils import profiler
 from ppsci.utils import reader
 from ppsci.utils import writer
 from ppsci.utils.checker import dynamic_import_to_globals
@@ -49,7 +48,6 @@
     "ema",
     "reader",
     "writer",
-    "profiler",
     "load_csv_file",
     "load_mat_file",
     "load_npz_file",

diff --git a/ppsci/utils/profiler.py b/ppsci/utils/profiler.py
diff --git a/requirements.txt b/requirements.txt
@@ -7,7 +7,6 @@ meshio==5.3.4
 numpy>=1.20.0,<=1.23.1
 pydantic>=2.5.0
 pyevtk
-pyvista==0.37.0
 pyyaml
 scikit-learn<1.5.0
 scikit-optimize
@@ -16,5 +15,4 @@ seaborn
 sympy
 tqdm
 typing-extensions
-vtk
 wget