Skip to content

Commit 820d794

Browse files
[Doc] Fix url link in docs and update index.md (#998)
* update toolkit support * update(test=document_fix)
1 parent bb3001a commit 820d794

File tree

7 files changed

+24
-35
lines changed

7 files changed

+24
-35
lines changed

README.md

Lines changed: 14 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@ PaddleScience 是一个基于深度学习框架 PaddlePaddle 开发的科学计
5454
| 光孤子 | [Optical soliton](https://paddlescience-docs.readthedocs.io/zh-cn/latest/zh/examples/nlsmb) | 机理驱动 | MLP | 无监督学习 | - | [Paper](https://doi.org/10.1007/s11071-023-08824-w)|
5555
| 光纤怪波 | [Optical rogue wave](https://paddlescience-docs.readthedocs.io/zh-cn/latest/zh/examples/nlsmb) | 机理驱动 | MLP | 无监督学习 | - | [Paper](https://doi.org/10.1007/s11071-023-08824-w)|
5656
| 域分解 | [XPINN](https://paddlescience-docs.readthedocs.io/zh-cn/latest/zh/examples/xpinns) | 机理驱动 | MLP | 无监督学习 | - | [Paper](https://doi.org/10.4208/cicp.OA-2020-0164)|
57-
| 布鲁塞尔扩散系统 | [3D-Brusselator](https://paddlescience-docs.readthedocs.io/zh-cn/latest/zh/examples/brusselator.md) | 数据驱动 | LNO | 监督学习 | - | [Paper](https://arxiv.org/abs/2303.10528)|
57+
| 布鲁塞尔扩散系统 | [3D-Brusselator](https://paddlescience-docs.readthedocs.io/zh-cn/latest/zh/examples/brusselator3d) | 数据驱动 | LNO | 监督学习 | - | [Paper](https://arxiv.org/abs/2303.10528)|
5858

5959
<br>
6060
<p align="center"><b>技术科学(AI for Technology)</b></p>
@@ -238,10 +238,19 @@ python -c "import paddle; paddle.utils.run_check()"
238238

239239
请参考 [**快速开始**](https://paddlescience-docs.readthedocs.io/zh-cn/latest/zh/quickstart/)
240240

241-
## 🎈其他领域支持
241+
## 🎈生态工具
242242

243243
<!-- --8<-- [start:adaptation] -->
244-
除 PaddleScience 套件外,Paddle 框架还支持了 [Modulus-sym](https://github.com/PaddlePaddle/modulus-sym/tree/paddle?tab=readme-ov-file#modulus-symbolic-betapaddle-backend)、[DeepXDE](https://github.com/lululxvi/deepxde/tree/master?tab=readme-ov-file#deepxde) 的所有案例,分子动力学套件 [DeepMD-kit](https://github.com/deepmodeling/deepmd-kit/tree/paddle2?tab=readme-ov-file#deepmd-kitpaddlepaddle-backend) 部分案例和功能。
244+
除 PaddleScience 外,Paddle 框架同时支持了科学计算领域相关的研发套件和基础工具:
245+
246+
| 工具 | 简介 | 支持情况 |
247+
| -- | -- | -- |
248+
| [Modulus-sym](https://github.com/PaddlePaddle/modulus-sym/tree/paddle?tab=readme-ov-file#modulus-symbolic-betapaddle-backend) | AI仿真套件 | 全量支持 |
249+
| [DeepXDE](https://github.com/lululxvi/deepxde/tree/master?tab=readme-ov-file#deepxde) | 方程求解套件 | 全量支持 |
250+
| [DeepMD-kit](https://github.com/deepmodeling/deepmd-kit/tree/paddle#deepmd-kitpaddlepaddle-backend) | 分子动力学套件 | 部分支持 |
251+
| [TensorLy](https://tensorly.org/dev/index.html) | 张量计算库 | 全量支持 |
252+
| [NVIDIA/warp](https://github.com/NVIDIA/warp) | 高性能仿真/图形库 | 全量支持 |
253+
| [DLPACK(v0.8)](https://dmlc.github.io/dlpack/latest/index.html) | 跨框架张量内存共享协议 | 全量支持 |
245254
<!-- --8<-- [end:adaptation] -->
246255

247256
<!-- --8<-- [start:support] -->
@@ -278,7 +287,7 @@ PaddleScience 作为一个开源项目,欢迎来各行各业的伙伴携手共
278287

279288
- PaddleScience 的部分模块和案例设计受 [NVIDIA-Modulus](https://github.com/NVIDIA/modulus/tree/main)、[DeepXDE](https://github.com/lululxvi/deepxde/tree/master)、[PaddleNLP](https://github.com/PaddlePaddle/PaddleNLP/tree/develop)、[PaddleClas](https://github.com/PaddlePaddle/PaddleClas/tree/develop) 等优秀开源套件的启发。
280289
<!-- --8<-- [end:thanks] -->
281-
- PaddleScience 的部分案例和代码由以下优秀社区开发者贡献(按 [Contributors](https://github.com/PaddlePaddle/PaddleScience/graphs/contributors) 排序):
290+
- PaddleScience 的部分案例和代码由以下优秀社区开发者贡献,(完整的贡献者请参考: [Contributors](https://github.com/PaddlePaddle/PaddleScience/graphs/contributors)):
282291
[Asthestarsfalll](https://github.com/Asthestarsfalll),
283292
[co63oc](https://github.com/co63oc),
284293
[MayYouBeProsperous](https://github.com/MayYouBeProsperous),
@@ -305,6 +314,7 @@ PaddleScience 作为一个开源项目,欢迎来各行各业的伙伴携手共
305314
[ccsuzzh](https://github.com/ccsuzzh),
306315
[enkilee](https://github.com/enkilee),
307316
[GreatV](https://github.com/GreatV)
317+
...
308318

309319
## 🤝合作单位
310320

docs/index.md

Lines changed: 2 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -92,7 +92,7 @@
9292
| 光孤子 | [Optical soliton](./zh/examples/nlsmb.md) | 机理驱动 | MLP | 无监督学习 | - | [Paper](https://doi.org/10.1007/s11071-023-08824-w)|
9393
| 光纤怪波 | [Optical rogue wave](./zh/examples/nlsmb.md) | 机理驱动 | MLP | 无监督学习 | - | [Paper](https://doi.org/10.1007/s11071-023-08824-w)|
9494
| 域分解 | [XPINN](./zh/examples/xpinns.md) | 机理驱动 | MLP | 无监督学习 | - | [Paper](https://doi.org/10.4208/cicp.OA-2020-0164)|
95-
| 布鲁塞尔扩散系统 | [3D-Brusselator](./zh/examples/brusselator.md) | 数据驱动 | LNO | 监督学习 | - | [Paper](https://arxiv.org/abs/2303.10528)|
95+
| 布鲁塞尔扩散系统 | [3D-Brusselator](./zh/examples/brusselator3d.md) | 数据驱动 | LNO | 监督学习 | - | [Paper](https://arxiv.org/abs/2303.10528)|
9696

9797
<br>
9898
<p align="center"><b>技术科学(AI for Technology)</b></p>
@@ -176,33 +176,12 @@
176176
./README.md:feature
177177
--8<--
178178

179-
## 🎈其他领域支持
179+
## 🎈生态工具
180180

181181
--8<--
182182
./README.md:adaptation
183183
--8<--
184184

185-
<div class="container">
186-
<a href="https://github.com/lululxvi/deepxde/tree/master?tab=readme-ov-file#deepxde">
187-
<div class="card card-deepxde">
188-
DeepXDE
189-
<br><span class="text-large">全量支持</span></br>
190-
</div>
191-
</a>
192-
<a href="https://github.com/PaddlePaddle/modulus-sym/tree/paddle?tab=readme-ov-file#modulus-symbolic-betapaddle-backend">
193-
<div class="card card-deepmd">
194-
Modulus-sym
195-
<br><span class="text-large">全量支持</span></br>
196-
</div>
197-
</a>
198-
<a href="https://github.com/deepmodeling/deepmd-kit/tree/paddle?tab=readme-ov-file#deepmd-kitpaddlepaddle-backend">
199-
<div class="card card-modulus">
200-
DeepMD
201-
<br><span class="text-large">部分适配</span></br>
202-
</div>
203-
</a>
204-
</div>
205-
206185
--8<--
207186
./README.md:support
208187
--8<--

docs/zh/development.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -291,7 +291,7 @@ equation = {..., "newpde": new_pde}
291291
292292
### 2.5 构建几何模块[可选]
293293
294-
模型训练、验证时所用的输入、标签数据的来源,根据具体案例场景的不同而变化。大部分基于 PINN 的案例,其数据来自几何形状内部、表面采样得到的坐标点、法向量、SDF 值;而基于数据驱动的方法,其输入、标签数据大多数来自于外部文件,或通过 numpy 等第三方库构造的存放在内存中的数据。本章节主要对第一种情况所需的几何模块进行介绍,第二种情况则不一定需要几何模块,其构造方式可以参考 [#2.6 构建约束条件](#2.6)。
294+
模型训练、验证时所用的输入、标签数据的来源,根据具体案例场景的不同而变化。大部分基于 PINN 的案例,其数据来自几何形状内部、表面采样得到的坐标点、法向量、SDF 值;而基于数据驱动的方法,其输入、标签数据大多数来自于外部文件,或通过 numpy 等第三方库构造的存放在内存中的数据。本章节主要对第一种情况所需的几何模块进行介绍,第二种情况则不一定需要几何模块,其构造方式可以参考 [#2.6 构建约束条件](#26)。
295295
296296
#### 2.5.1 构建已有几何
297297

docs/zh/examples/deephpms.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -323,7 +323,7 @@ examples/deephpms/burgers.py:187:196
323323
--8<--
324324
```
325325

326-
各个参数含义与 [第一阶段约束构建](#361) 一致,唯一的区别是这个约束中的第二个参数,损失函数,采用 PaddleScience 预留的自定义 loss 函数类 `FunctionalLoss`,该类支持编写代码时自定义 loss 的计算方法,而不是使用诸如 `MSE` 等现有方法。本约束中的自定义 loss 函数代码请参考 [自定义 loss 和 metric](#38)
326+
各个参数含义与 [第一阶段约束构建](#361) 一致,唯一的区别是这个约束中的第二个参数,损失函数,采用 PaddleScience 预留的自定义 loss 函数类 `FunctionalLoss`,该类支持编写代码时自定义 loss 的计算方法,而不是使用诸如 `MSE` 等现有方法。本约束中的自定义 loss 函数代码请参考 [自定义 loss 和 metric](#38-loss-metric)
327327

328328
在约束构建完毕之后,以我们刚才的命名为关键字,封装到一个字典中,方便后续访问。
329329

@@ -355,7 +355,7 @@ examples/deephpms/burgers.py:148:155
355355

356356
#### 3.7.2 第二阶段评估器构建
357357

358-
评价指标 `metric``FunctionalMetric`,这是 PaddleScience 预留的自定义 metric 函数类,该类支持编写代码时自定义 metric 的计算方法,而不是使用诸如 `MSE``L2` 等现有方法。自定义 metric 函数代码请参考下一部分 [自定义 loss 和 metric](#38)
358+
评价指标 `metric``FunctionalMetric`,这是 PaddleScience 预留的自定义 metric 函数类,该类支持编写代码时自定义 metric 的计算方法,而不是使用诸如 `MSE``L2` 等现有方法。自定义 metric 函数代码请参考下一部分 [自定义 loss 和 metric](#38-loss-metric)
359359

360360
``` py linenums="209"
361361
--8<--

docs/zh/examples/hpinns.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -240,7 +240,7 @@ examples/hpinns/holography.py:66:127
240240
4. `label_keys`: 标签变量名;
241241
5. `alias_dict`: 变量别名。
242242

243-
第二个参数是损失函数,此处的 `FunctionalLoss` 为 PaddleScience 预留的自定义 loss 函数类,该类支持编写代码时自定义 loss 的计算方法,而不是使用诸如 `MSE` 等现有方法,本问题中由于存在多个 loss 项,因此需要定义多个 loss 计算函数,这也是需要构建多个约束的原因。自定义 loss 函数代码请参考 [自定义 loss 和 metric](#38)
243+
第二个参数是损失函数,此处的 `FunctionalLoss` 为 PaddleScience 预留的自定义 loss 函数类,该类支持编写代码时自定义 loss 的计算方法,而不是使用诸如 `MSE` 等现有方法,本问题中由于存在多个 loss 项,因此需要定义多个 loss 计算函数,这也是需要构建多个约束的原因。自定义 loss 函数代码请参考 [自定义 loss 和 metric](#38-loss-metric)
244244

245245
第三个参数是方程表达式,用于描述如何计算约束目标,此处填入 `output_expr`,计算后的值将会按照指定名称存入输出列表中,从而保证 loss 计算时可以使用这些值。
246246

@@ -264,7 +264,7 @@ examples/hpinns/holography.py:133:181
264264
--8<--
265265
```
266266

267-
评价指标 `metric``FunctionalMetric`,这是 PaddleScience 预留的自定义 metric 函数类,该类支持编写代码时自定义 metric 的计算方法,而不是使用诸如 `MSE``L2` 等现有方法。自定义 metric 函数代码请参考下一部分 [自定义 loss 和 metric](#38)
267+
评价指标 `metric``FunctionalMetric`,这是 PaddleScience 预留的自定义 metric 函数类,该类支持编写代码时自定义 metric 的计算方法,而不是使用诸如 `MSE``L2` 等现有方法。自定义 metric 函数代码请参考下一部分 [自定义 loss 和 metric](#38-loss-metric)
268268

269269
其余配置与 [约束构建](#36) 的设置类似。
270270

docs/zh/examples/tempoGAN.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -191,7 +191,7 @@ examples/tempoGAN/tempoGAN.py:98:127
191191
1. `name`: 数据集类型,此处 `NamedArrayDataset` 表示从 Array 中读取的 `.mat` 类型的数据集;
192192
2. `input`: Array 类型的输入数据;
193193
3. `label`: Array 类型的标签数据;
194-
4. `transforms`: 所有数据 transform 方法,此处 `FunctionalTransform` 为PaddleScience 预留的自定义数据 transform 类,该类支持编写代码时自定义输入数据的 transform,具体代码请参考 [自定义 loss 和 data transform](#38)
194+
4. `transforms`: 所有数据 transform 方法,此处 `FunctionalTransform` 为PaddleScience 预留的自定义数据 transform 类,该类支持编写代码时自定义输入数据的 transform,具体代码请参考 [自定义 loss 和 data transform](#38-loss-data-transform)
195195

196196
`batch_size` 字段表示 batch的大小;
197197

@@ -201,7 +201,7 @@ examples/tempoGAN/tempoGAN.py:98:127
201201
2. `drop_last`: 是否需要丢弃最后无法凑整一个 mini-batch 的样本,默认值为 False;
202202
3. `shuffle`: 是否需要在生成样本下标时打乱顺序,默认值为 False;
203203

204-
第二个参数是损失函数,此处的 `FunctionalLoss` 为 PaddleScience 预留的自定义 loss 函数类,该类支持编写代码时自定义 loss 的计算方法,而不是使用诸如 `MSE` 等现有方法,具体代码请参考 [自定义 loss 和 data transform](#38)
204+
第二个参数是损失函数,此处的 `FunctionalLoss` 为 PaddleScience 预留的自定义 loss 函数类,该类支持编写代码时自定义 loss 的计算方法,而不是使用诸如 `MSE` 等现有方法,具体代码请参考 [自定义 loss 和 data transform](#38-loss-data-transform)
205205

206206
第三个参数是约束条件的 `output_expr`,如上所述,是为了让程序可以将输入数据作为 `label`
207207

docs/zh/examples/topopt.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -190,7 +190,7 @@ examples/topopt/topopt.py:50:75
190190

191191
读取配置中 `"batch_size"` 字段表示训练时指定的批大小,`"sampler"` 字段表示 dataloader 的相关采样配置。
192192

193-
第二个参数是损失函数,这里使用[自定义损失](#381),通过 `cfg.vol_coeff` 确定损失公式中 $\beta$ 对应的值。
193+
第二个参数是损失函数,这里使用[自定义损失](#381-loss),通过 `cfg.vol_coeff` 确定损失公式中 $\beta$ 对应的值。
194194

195195
第三个参数是约束条件的名字,方便后续对其索引。此次命名为 `"sup_constraint"`
196196

0 commit comments

Comments
 (0)