[Doc] Update paddle version to release/3.0 (#1127)

* update paddle release/3.0

* update externals/paddle_scatter submodule commit

* update color logger from cyan to bold_cyan

* fix phycrnet

* fix plot

* update more document

Author: HydrogenSulfate

README.md

@@ -157,7 +157,7 @@ PaddleScience 是一个基于深度学习框架 PaddlePaddle 开发的科学计
 ### 安装 PaddlePaddle
 
 <!-- --8<-- [start:paddle_install] -->
-请在 [PaddlePaddle](https://www.paddlepaddle.org.cn/install/quick?docurl=/documentation/docs/zh/develop/install/pip/linux-pip.html) 官网按照您的运行环境，安装 <font color="red"><b>3.0-beta 或 develop</b></font> 版的 PaddlePaddle。
+请根据您的运行环境，访问 [PaddlePaddle](https://www.paddlepaddle.org.cn/install/quick?docurl=/documentation/docs/zh/develop/install/pip/linux-pip.html) 官网，安装 <font color="red"><b>3.0 或 develop</b></font> 版的 PaddlePaddle。
 
 安装完毕之后，运行以下命令，验证 Paddle 是否安装成功。
 
@@ -216,7 +216,7 @@ python -c "import paddle; paddle.utils.run_check()"
 
     - 设置 PYTHONPATH 并手动安装 requirements
 
-        如果在您的环境中，上述两种方式都无法正常安装，则可以选择本方式，在终端内将环境变量 `PYTHONPATH` 临时设置为 `PaddleScience` 的**绝对路径**，如下所示。
+        如果在您的环境中，上述两种方式都无法正常安装，则可以选择本方式，在终端内临时将环境变量 `PYTHONPATH` 设置为 PaddleScience 的**绝对路径**，如下所示。
 
         ``` shell
         cd PaddleScience
@@ -270,7 +270,7 @@ python -c "import paddle; paddle.utils.run_check()"
 <!-- --8<-- [start:support] -->
 ## 💬支持与建议
 
-如使用过程中遇到问题或想提出开发建议，欢迎在 [**Discussion**](https://github.com/PaddlePaddle/PaddleScience/discussions/new?category=general) 提出建议，或者在 [**Issue**](https://github.com/PaddlePaddle/PaddleScience/issues/new/choose) 页面新建 issue，会有专业的研发人员进行解答。
+如在使用过程中遇到问题或想提出开发建议，欢迎在 [**Discussion**](https://github.com/PaddlePaddle/PaddleScience/discussions/new?category=general) 中提出，或者在 [**Issue**](https://github.com/PaddlePaddle/PaddleScience/issues/new/choose) 页面新建 issue，会有专业的研发人员进行解答。
 <!-- --8<-- [end:support] -->
 
 <!-- --8<-- [start:contribution] -->

docs/zh/api/visualize.md

@@ -15,6 +15,7 @@
         - VisualizerWeather
         - save_plot_from_1d_dict
         - save_plot_from_3d_dict
+        - save_vtp_from_dict
         - save_vtu_from_dict
         - save_vtu_to_mesh
       show_root_heading: true

docs/zh/examples/allen_cahn.md

@@ -208,19 +208,19 @@ examples/allen_cahn/allen_cahn_piratenet.py:132:136
 
 在训练过程中通常会按一定轮数间隔，用验证集（测试集）评估当前模型的训练情况，因此使用 `ppsci.validate.SupervisedValidator` 构建评估器。
 
-``` py linenums="138"
+``` py linenums="146"
 --8<--
-examples/allen_cahn/allen_cahn_piratenet.py:138:156
+examples/allen_cahn/allen_cahn_piratenet.py:146:164
 --8<--
 ```
 
 ### 3.8 模型训练、评估与可视化
 
 完成上述设置之后，只需要将上述实例化的对象按顺序传递给 `ppsci.solver.Solver`，然后启动训练、评估、可视化。
 
-``` py linenums="158"
+``` py linenums="166"
 --8<--
-examples/allen_cahn/allen_cahn_piratenet.py:158:184
+examples/allen_cahn/allen_cahn_piratenet.py:166:192
 --8<--
 ```
 
@@ -247,3 +247,4 @@ examples/allen_cahn/allen_cahn_piratenet.py
 
 - [PIRATENETS: PHYSICS-INFORMED DEEP LEARNING WITHRESIDUAL ADAPTIVE NETWORKS](https://arxiv.org/pdf/2402.00326.pdf)
 - [Allen-Cahn equation](https://github.com/PredictiveIntelligenceLab/jaxpi/blob/main/examples/allen_cahn/README.md)
+- [Gradient Alignment in Physics-informed Neural Networks: A Second-Order Optimization Perspective](https://arxiv.org/abs/2502.00604)

docs/zh/examples/phycrnet.md

@@ -7,7 +7,6 @@
     ``` sh
     # linux
     wget -nc https://paddle-org.bj.bcebos.com/paddlescience/datasets/PhyCRNet/burgers_1501x2x128x128.mat -P ./data/
-
     # windows
     # curl https://paddle-org.bj.bcebos.com/paddlescience/datasets/PhyCRNet/burgers_1501x2x128x128.mat --create-dirs -o ./data/burgers_1501x2x128x128.mat
 
@@ -24,6 +23,7 @@
 
     python main.py mode=eval DATA_PATH=./data/burgers_1501x2x128x128.mat EVAL.pretrained_model_path=https://paddle-org.bj.bcebos.com/paddlescience/models/phycrnet/phycrnet_burgers.pdparams
     ```
+
 | 预训练模型  | 指标 |
 |:--| :--|
 | [phycrnet_burgers_pretrained.pdparams](https://paddle-org.bj.bcebos.com/paddlescience/models/phycrnet/phycrnet_burgers.pdparams) | a-RMSE: 3.20e-3 |
@@ -81,9 +81,9 @@ $$K_s = \begin{bmatrix}
 
 ![image](https://paddle-org.bj.bcebos.com/paddlescience/docs/phycrnet/Hard_IC_BC.png)
 
-``` py linenums="43"
+``` py linenums="15"
 --8<--
-examples/phycrnet/main.py:43:45
+examples/phycrnet/main.py:15:37
 --8<--
 ```
 
@@ -96,39 +96,39 @@ examples/phycrnet/conf/burgers_equations.yaml:34:42
 ### 3.2 数据载入
 我们使用RK4或者谱方法生成的数据（初值为使用正态分布生成），需要从.mat文件中将其读入，：
 
-``` py linenums="54"
+``` py linenums="38"
 --8<--
-examples/phycrnet/main.py:54:72
+examples/phycrnet/main.py:38:63
 --8<--
 ```
 
 ### 3.3 约束构建
 
 设置约束以及相关损失函数：
 
-``` py linenums="74"
+``` py linenums="65"
 --8<--
-examples/phycrnet/main.py:74:90
+examples/phycrnet/main.py:65:82
 --8<--
 ```
 
 ### 3.4 评估器构建
 
 设置评估数据集和相关损失函数：
 
-``` py linenums="92"
+``` py linenums="84"
 --8<--
-examples/phycrnet/main.py:92:109
+examples/phycrnet/main.py:84:102
 --8<--
 ```
 
 ### 3.6 优化器构建
 
 训练过程会调用优化器来更新模型参数，此处选择 `Adam` 优化器并设定 `learning_rate`
 
-``` py linenums="112"
+``` py linenums="104"
 --8<--
-examples/phycrnet/main.py:112:116
+examples/phycrnet/main.py:104:106
 --8<--
 ```
 
@@ -142,33 +142,33 @@ $$
 
 这一步需要通过设置外界函数来进行，因此在训练过程中，我们使用`function.transform_out`来进行训练
 
-``` py linenums="47"
+``` py linenums="38"
 --8<--
-examples/phycrnet/main.py:47:51
+examples/phycrnet/main.py:38:42
 --8<--
 ```
 
 而在评估过程中，我们使用`function.tranform_output_val`来进行评估，并生成累计均方根误差。
 
-``` py linenums="142"
+``` py linenums="124"
 --8<--
-examples/phycrnet/main.py:142:142
+examples/phycrnet/main.py:124:125
 --8<--
 ```
 
 完成上述设置之后，只需要将上述实例化的对象按顺序传递给 `ppsci.solver.Solver`。
 
-``` py linenums="117"
+``` py linenums="108"
 --8<--
-examples/phycrnet/main.py:117:129
+examples/phycrnet/main.py:108:120
 --8<--
 ```
 
 最后启动训练、评估即可：
 
-``` py linenums="132"
+``` py linenums="122"
 --8<--
-examples/phycrnet/main.py:132:140
+examples/phycrnet/main.py:122:126
 --8<--
 ```
 

docs/zh/install_setup.md

@@ -10,7 +10,7 @@
     # pull image
     docker pull hydrogensulfate/paddlescience
 
-    # create a container named 'paddlescience_container' based on pulled image
+    # create a container named 'paddlescience_container' using the pulled image
     ## docker version < 19.03
     nvidia-docker run --name paddlescience_container --network=host -it --shm-size 64g hydrogensulfate/paddlescience:latest /bin/bash
 
@@ -40,7 +40,7 @@
 
 如果你还没有 python 环境或者 python 版本小于 3.9，则推荐使用 Anaconda 安装并配置 python 环境，否则可以忽略本步骤。
 
-1. 根据系统环境，从 [https://repo.anaconda.com/archive/](https://repo.anaconda.com/archive/) 中下载对应的 Anaconda3 安装包，并手动安装。
+1. 根据系统环境，从 [https://repo.anaconda.com/archive/](https://repo.anaconda.com/archive/) 中下载对应的 Anaconda3 安装包并手动安装。
 2. 创建 python 3.9 环境，并进入该环境。
 
     ``` sh
@@ -113,7 +113,7 @@
 
 PaddleScience 提供了两种复杂几何类型，如下所示：
 
-| API 名称 | 支持文件类型 | 安装方式 | 使用方式 |
+| API 名称 | 支持的文件类型 | 安装方式 | 使用方式 |
 | -- | -- | -- | -- |
 |[`ppsci.geometry.Mesh`](./api/geometry.md#ppsci.geometry.Mesh) | `.obj`, `.ply`, `.off`, `.stl`, `.mesh`, `.node`, `.poly` and `.msh`| 参考下方的 "PyMesh 安装命令"| `ppsci.geometry.Mesh(mesh_path)`|
 |[`ppsci.geometry.SDFMesh`](./api/geometry.md#ppsci.geometry.SDFMesh "实验性功能") | `.stl` | `pip install warp-lang 'numpy-stl>=2.16,<2.17'` | `ppsci.geometry.SDFMesh.from_stl(stl_path)` |
@@ -144,7 +144,7 @@ PaddleScience 提供了两种复杂几何类型，如下所示：
 === "PyMesh 安装命令"
 
     在安装 PyMesh 之前，首先需通过 `cmake --version` 确认环境中是否已安装 cmake。
-    如未安装，可按照下列命令下载、解压 cmake 包，并添加到 `PATH` 变量中即可完成安装。
+    如果未安装，可以按照下列命令下载并解压 cmake 包，然后将其添加到 PATH 变量中以完成安装。
 
     ``` sh
     wget -nc https://paddle-org.bj.bcebos.com/paddlescience/cmake-3.23.0-linux-x86_64.tar.gz
@@ -158,7 +158,7 @@ PaddleScience 提供了两种复杂几何类型，如下所示：
     # CMake suite maintained and supported by Kitware (kitware.com/cmake).
     ```
 
-    PyMesh 库需要以 setup 的方式进行安装，命令如下：
+    推荐以 setup 的方式安装 PyMesh 库，命令如下：
 
     ``` sh
     wget -nc https://paddle-org.bj.bcebos.com/paddlescience/PyMesh.tar.gz
@@ -238,7 +238,7 @@ PaddleScience 提供了多种第三方库供用户在开发时使用，这些库
     ``` python
     >>> from ppsci import externals
     >>> print(externals.__all__)
-    ['deepali', 'open3d', 'paddle_harmonics', 'tensorly', 'warp']
+    ['deepali', 'open3d', 'paddle_harmonics', 'paddle_scatter', 'tensorly', 'warp']
 
     >>> tl = externals.tensorly
     >>> tl.set_backend("paddle")

docs/zh/tutorials.md

@@ -2,5 +2,7 @@
 
 ## 教程课件
 
+- [飞桨AI for Science代码入门](https://space.bilibili.com/476867757/lists/4215120?type=season)
+- [飞桨AI for Science前沿讲座](https://space.bilibili.com/476867757/lists/4215252?type=season)
 - [深度学习技术与科学计算](https://aistudio.baidu.com/course/introduce/29929?sharedType=1&sharedUserId=438690&ts=1705731573142)
 - [飞桨AI for Science流体力学公开课第一期](https://aistudio.baidu.com/course/introduce/27926?sharedType=1&sharedUserId=438690&ts=1705892946215)

docs/zh/user_guide.md

@@ -24,7 +24,7 @@ pip install hydra-core
 
 !!! warning
 
-    注意本教程内的打印运行配置方法**只作为调试使用**，hydra 默认在打印完配置后会立即结束程序。因此在正常运行程序时请勿加上 `-c job` 参数。
+    请注意，本教程中的打印运行配置方法**仅用于调试**，hydra 默认在打印完配置后会立即结束程序。因此，在正常运行程序时请勿加上 `-c job` 参数。
 
 以 bracket 案例为例，其正常运行命令为：`python bracket.py`。若在其运行命令末尾加上  `-c job`，则可以打印出从运行配置文件 `conf/bracket.yaml` 中解析出的配置参数，如下所示。
 
@@ -78,7 +78,7 @@ TRAIN:
     python bracket.py {++TRAIN.lr_scheduler.learning_rate=0.002++}
     ```
 
-    这种方式通过命令行参数临时重载运行配置，而不会对 `bracket.yaml` 文件本身进行修改，能灵活地控制运行时的配置，保证不同实验之间互不干扰。
+    这种方式通过命令行参数临时重载运行配置，而不会修改 bracket.yaml 文件本身，能够灵活地控制运行时的配置，确保不同实验之间互不干扰。
 
 !!! tip "设置含转义字符的参数值"
 
@@ -211,7 +211,7 @@ ppsci MESSAGE: Inference model has been exported to: ./inference/aneurysm, inclu
 
 !!! Warning
 
-    Paddle 在 3.0 以及之后的版本中将 PIR 设置为默认的静态图执行模式，因此移除了 `*.pdmodel` 和 `*.pdiparams` 格式的文件，而由 `*.json` 文件代替。
+    在 Paddle 3.0 及之后的版本中，PIR 被设置为默认的静态图执行模式，因此 `*.pdmodel` 格式的文件被移除，改由 `*.json` 文件代替。
     为此 PaddleScience 进行了适配([deploy/python_infer/base.py](https://github.com/PaddlePaddle/PaddleScience/blob/develop/deploy/python_infer/base.py#L105-L107))，用户无需关心后缀格式，会根据 Paddle 版本是否支持 PIR，在加载上述文件时，自动替换为正确的后缀名。
 
 #### 1.2.2 ONNX 推理模型导出
@@ -370,6 +370,7 @@ PaddleScience 提供了多种推理配置组合，可通过命令行进行组合
 
 |  | Native | ONNX | TensorRT | macaRT | MKLDNN |
 | :--- | :--- | :--- | :--- | :--- | :--- |
+| Intel(CPU) | ✅ | ✅ | / | / | ✅ |
 | NVIDIA | ✅ | ✅ | ✅ | / | / |
 | MetaX | ✅ | ✅ | / | ✅ | / |
 
@@ -831,7 +832,7 @@ hydra 的自动化实验功能可以与 [optuna](https://optuna.readthedocs.io/e
     3. `direction: minimize`：这指定了优化的目标方向。minimize 表示我们希望最小化目标函数（例如模型的验证损失）。如果我们希望最大化某个指标（例如准确率），则可以设置为 maximize。
     4. `study_name: viv_optuna`：这设置了 Optuna 研究（Study）的名称。这个名称用于标识和引用特定的研究，有助于在以后的分析或继续优化时跟踪结果。
     5. `n_trials: 20`：这指定了要运行的总试验次数。在这个例子中，Optuna 将执行 20 次独立的试验来寻找最佳的超参数组合。
-    6. `n_jobs: 1`：这设置了可以并行运行的试验数量。值为 1 意味着试验将依次执行，而不是并行。如果你的系统有多个 CPU 核心，并且希望并行化以加速搜索过程，可以将这个值设置为更高的数字或 -1（表示使用所有可用的 CPU 核心）。
+    6. `n_jobs: 1`：这设置了可并行运行的试验数量。值为 1 表示试验将顺序执行，而不是并行。如果你的系统有多个 CPU 核心，并且希望并行化以加速搜索过程，可以将这个值设置为更高的数字或 -1（表示使用所有可用的 CPU 核心）。
     7. `params:`： 这一节定义了要优化的超参数以及它们的搜索空间。
     8. `MODEL.num_layers: choice(2, 3, 4, 5, 6, 7)`：这指定了模型层数的可选值。choice 函数表示 Optuna 在 2, 3, 4, 5, 6, 和 7 中随机选择一个值。
     9. `TRAIN.lr_scheduler.learning_rate: interval(0.0001, 0.005)`：这指定了学习率的搜索范围。interval 表示学习率的值将在 0.0001 和 0.005 之间均匀分布地选择。
@@ -895,7 +896,7 @@ best_value: 0.02460772916674614
 
 #### 2.2.1 数据并行
 
-接下来以 `examples/pipe/poiseuille_flow.py` 为例，介绍如何正确使用 PaddleScience 的数据并行功能。分布式训练细节可以参考：[Paddle-使用指南-分布式训练-快速开始-数据并行](https://www.paddlepaddle.org.cn/documentation/docs/zh/develop/guides/06_distributed_training/cluster_quick_start_collective_cn.html)。
+接下来以 `examples/pipe/poiseuille_flow.py` 为例，介绍如何正确使用 PaddleScience 的数据并行功能进行训练。分布式训练细节可以参考：[Paddle-使用指南-分布式训练-快速开始-数据并行](https://www.paddlepaddle.org.cn/documentation/docs/zh/develop/guides/06_distributed_training/cluster_quick_start_collective_cn.html)。
 
 1. 在 constraint 实例化完毕后，将 `ITERS_PER_EPOCH` 重新赋值为经过自动多卡数据切分后的 `dataloader` 的长度（一般情况下其长度等于单卡 dataloader 的长度除以卡数，向上取整），如代码中高亮行所示。
 
@@ -923,8 +924,8 @@ best_value: 0.02460772916674614
 
     # wrap constraints together
     constraint = {pde_constraint.name: pde_constraint}
-
-    EPOCHS = 3000 if not args.epochs else args.epochs
+    ...
+    ...
     ```
 
 2. 使用分布式训练命令启动训练，以 4 卡数据并行训练为例

examples/phycrnet/main.py

@@ -2,24 +2,16 @@
 PhyCRNet for solving spatiotemporal PDEs
 Reference: https://github.com/isds-neu/PhyCRNet/
 """
-from os import path as osp
-
 import functions
 import hydra
 import paddle
 import scipy.io as scio
 from omegaconf import DictConfig
 
 import ppsci
-from ppsci.utils import logger
 
 
 def train(cfg: DictConfig):
-    # set random seed for reproducibility
-    ppsci.utils.misc.set_random_seed(cfg.seed)
-    # initialize logger
-    logger.init_logger("ppsci", osp.join(cfg.output_dir, f"{cfg.mode}.log"), "info")
-
     # set initial states for convlstm
     NUM_CONVLSTM = cfg.num_convlstm
     (h0, c0) = (paddle.randn((1, 128, 16, 16)), paddle.randn((1, 128, 16, 16)))
@@ -79,6 +71,7 @@ def _transform_out(_in, _out):
             },
             "batch_size": 1,
             "num_workers": 0,
+            "auto_collation": True,
         },
         ppsci.loss.FunctionalLoss(functions.train_loss_func),
         {
@@ -97,6 +90,7 @@ def _transform_out(_in, _out):
             },
             "batch_size": 1,
             "num_workers": 0,
+            "auto_collation": True,
         },
         ppsci.loss.FunctionalLoss(functions.val_loss_func),
         {
@@ -107,10 +101,11 @@ def _transform_out(_in, _out):
     )
     validator_pde = {sup_validator_pde.name: sup_validator_pde}
 
-    # initialize solver
+    # initialize optimizer & scheduler
     scheduler = ppsci.optimizer.lr_scheduler.Step(**cfg.TRAIN.lr_scheduler)()
-
     optimizer = ppsci.optimizer.Adam(scheduler)(model)
+
+    # initialize solver
     solver = ppsci.solver.Solver(
         model,
         constraint_pde,
@@ -132,11 +127,6 @@ def _transform_out(_in, _out):
 
 
 def evaluate(cfg: DictConfig):
-    # set random seed for reproducibility
-    ppsci.utils.misc.set_random_seed(cfg.seed)
-    # initialize logger
-    logger.init_logger("ppsci", osp.join(cfg.output_dir, f"{cfg.mode}.log"), "info")
-
     # set initial states for convlstm
     NUM_CONVLSTM = cfg.num_convlstm
     (h0, c0) = (paddle.randn((1, 128, 16, 16)), paddle.randn((1, 128, 16, 16)))

ppsci/externals/__init__.py

@@ -7,6 +7,7 @@
     "neuraloperator",
     "open3d",
     "paddle_harmonics",
+    "paddle_scatter",
     "tensorly",
     "warp",
 ]