Skip to content

Commit

Permalink
update details in homepage and mtl module
Browse files Browse the repository at this point in the history
  • Loading branch information
HydrogenSulfate committed Dec 20, 2023
1 parent b6a512c commit ef1d22e
Show file tree
Hide file tree
Showing 6 changed files with 32 additions and 20 deletions.
6 changes: 4 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -89,6 +89,8 @@ PaddleScience 是一个基于深度学习框架 PaddlePaddle 开发的科学计
<!-- --8<-- [start:update] -->
## 🕘最近更新

- 添加多目标优化算法 [Relobralo](http://127.0.0.1:8006/PaddlePaddle/PaddleScience/zh/api/loss/mtl/#ppsci.loss.mtl.Relobralo)
- 添加气泡流求解案例([Bubble](https://paddlescience-docs.readthedocs.io/zh/latest/zh/examples/bubble/))、机翼优化案例([DeepCFD](https://paddlescience-docs.readthedocs.io/zh/latest/zh/examples/deepcfd/))、热传导仿真案例([HeatPINN](https://paddlescience-docs.readthedocs.io/zh/latest/zh/examples/heat_pinn/))、非线性短临预报模型([Nowcasting(仅推理)](https://paddlescience-docs.readthedocs.io/zh/latest/zh/examples/nowcastnet))、拓扑优化案例([TopOpt](https://paddlescience-docs.readthedocs.io/zh/latest/zh/examples/topopt))、矩形平板线弹性方程求解案例([Biharmonic2D](https://paddlescience-docs.readthedocs.io/zh/latest/zh/examples/biharmonic2d))。
- 添加二维血管案例([LabelFree-DNN-Surrogate](https://paddlescience-docs.readthedocs.io/zh/latest/zh/examples/labelfree_DNN_surrogate/#4))、空气激波案例([ShockWave](https://paddlescience-docs.readthedocs.io/zh/latest/zh/examples/shock_wave/))、去噪网络模型([DUCNN](https://github.com/PaddlePaddle/PaddleScience/tree/develop/jointContribution/DU_CNN))、风电预测模型([Deep Spatial Temporal](https://github.com/PaddlePaddle/PaddleScience/tree/develop/jointContribution/Deep-Spatio-Temporal))、域分解模型([XPINNs](https://github.com/PaddlePaddle/PaddleScience/tree/develop/jointContribution/XPINNs))、积分方程求解案例([Volterra Equation](https://paddlescience-docs.readthedocs.io/zh/latest/zh/examples/volterra_ide/))、分数阶方程求解案例([Fractional Poisson 2D](https://github.com/PaddlePaddle/PaddleScience/blob/develop/examples/fpde/fractional_poisson_2d.py))。
- 针对串联方程和复杂方程场景,`Equation` 模块支持基于 [sympy](https://docs.sympy.org/dev/tutorials/intro-tutorial/intro.html) 的符号计算,并支持和 python 函数混合使用([#507](https://github.com/PaddlePaddle/PaddleScience/pull/507)[#505](https://github.com/PaddlePaddle/PaddleScience/pull/505))。
- `Geometry` 模块和 `InteriorConstraint``InitialConstraint` 支持计算 SDF 微分功能([#539](https://github.com/PaddlePaddle/PaddleScience/pull/539))。
Expand All @@ -103,7 +105,7 @@ PaddleScience 是一个基于深度学习框架 PaddlePaddle 开发的科学计
- 支持物理机理驱动、数据驱动、数理融合三种问题求解方式。涵盖流体、结构、气象等领域 20+ 案例。
- 支持结果可视化输出与日志结构化保存。
- 完善的 type hints,用户使用和代码贡献全流程文档,经典案例 AI studio 快速体验,降低使用门槛,提高开发效率。
- 支持基于 sympy 符号计算库的方程表示
- 支持基于 sympy 符号计算库的方程表示与联立方程组计算
- 更多特性正在开发中...
<!-- --8<-- [end:feature] -->

Expand Down Expand Up @@ -226,7 +228,7 @@ PaddleScience 作为一个开源项目,欢迎来各行各业的伙伴携手共
![cooperation](./docs/images/overview/cooperation.png)

<!-- --8<-- [start:license] -->
## 📜证书
## 📜开源协议

[Apache License 2.0](https://github.com/PaddlePaddle/PaddleScience/blob/develop/LICENSE)
<!-- --8<-- [end:license] -->
6 changes: 5 additions & 1 deletion docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -96,7 +96,11 @@
pip install paddlesci
```

- **完整安装流程**[安装与使用](./zh/install_setup.md)
**完整安装流程**[安装与使用](./zh/install_setup.md)

--8<--
./README.md:update
--8<--

--8<--
./README.md:feature
Expand Down
13 changes: 1 addition & 12 deletions docs/zh/api/loss.md → docs/zh/api/loss/loss.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Loss(损失函数) 模块
# Loss.loss(损失函数) 模块

::: ppsci.loss
handler: python
Expand All @@ -18,14 +18,3 @@
- PeriodicMSELoss
show_root_heading: true
heading_level: 3

::: ppsci.loss.mtl
handler: python
options:
members:
- AGDA
- LossAggregator
- PCGrad
- Relobralo
show_root_heading: true
heading_level: 3
12 changes: 12 additions & 0 deletions docs/zh/api/loss/mtl.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
# Loss.mtl(多任务学习) 模块

::: ppsci.loss.mtl
handler: python
options:
members:
- AGDA
- LossAggregator
- PCGrad
- Relobralo
show_root_heading: true
heading_level: 3
11 changes: 7 additions & 4 deletions docs/zh/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -72,11 +72,14 @@ Equation 模块负责定义各种常见方程的计算函数,如 `NavierStokes

Geometry 模块负责定义各种常见的几何形状,如 `Interval` 线段几何、`Rectangle` 矩形几何、`Sphere` 球面几何。

### 2.7 [Loss](./api/loss.md)
### 2.7 [Loss](./api/loss/loss.md)

Loss 模块负责定义各种损失函数,在模型前向与方程计算完毕后,将结果与参考值计算损失值,供后续的梯度优化算法使用;
Loss 模块包含 [`ppsci.loss.loss`](./api/loss/loss.md)[`ppsci.loss.mtl`](./api/loss/mtl.md) 两个子模块,如下所示。

同时该模块也提供了常见的多任务学习优化功能,包括 PCGrad、AGDA,进一步提升多个 loss 共同优化(如 PINN 方法)的精度。
| 子模块名称 | 子模块功能 |
| :-- | :-- |
| [ppsci.loss.loss](./api/loss/loss.md)| 损失函数相关 |
| [ppsci.loss.mtl](./api/loss/mtl.md)| 多目标优化相关 |

### 2.8 Optimizer

Expand Down Expand Up @@ -110,7 +113,7 @@ Utils 模块内部存放了一些适用于多种场景下的工具类、函数

### 2.11 [Validate](./api/validate.md)

Validator 模块负责定义各种评估器,用于模型训练完一个 epoch 后自动在指定数据上进行评估(可选,默认不开启训练时评估)并得到评估指标。
Validator 模块负责定义各种评估器,用于在指定数据上进行评估(可选,默认不开启训练时评估)并得到评估指标。

### 2.12 [Visualize](./api/visualize.md)

Expand Down
4 changes: 3 additions & 1 deletion mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -84,7 +84,9 @@ nav:
- ppsci.data.batch_transform: zh/api/data/process/batch_transform.md
- ppsci.equation: zh/api/equation.md
- ppsci.geometry: zh/api/geometry.md
- ppsci.loss: zh/api/loss.md
- ppsci.loss:
- ppsci.loss.loss: zh/api/loss/loss.md
- ppsci.loss.mtl: zh/api/loss/mtl.md
- ppsci.metric: zh/api/metric.md
- ppsci.optimizer:
- ppsci.optimizer.optimizer: zh/api/optimizer.md
Expand Down

0 comments on commit ef1d22e

Please sign in to comment.