Skip to content

Commit 3ef1adb

Browse files
add overview.md move installtion guide to install_setup.md, refine index.md
1 parent d3ac8cb commit 3ef1adb

File tree

3 files changed

+26
-18
lines changed

3 files changed

+26
-18
lines changed

docs/index.md

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -2,18 +2,16 @@
22

33
> *Developed with [PaddlePaddle](https://www.paddlepaddle.org.cn/)*
44
5-
PaddleScience 是一个基于深度学习框架 PaddlePaddle 开发的科学计算套件,利用深度神经网络的学习能力和自动(高阶)微分机制,解决物理、化学、气象等领域的问题。支持物理机理驱动、数据驱动、数理融合三种求解方式,并提供了基础 API 和详尽文档供用户使用与二次开发。
6-
7-
**<div align='center'>请查看 [PaddleScience 文档](https://paddlescience-docs.readthedocs.io/zh/latest/) 以全面了解 PaddleScience</div>**
5+
PaddleScience 是一个基于深度学习框架 PaddlePaddle 开发的科学计算套件,利用深度神经网络的学习能力和 PaddlePaddle 框架的自动(高阶)微分机制,解决物理、化学、气象等领域的问题。支持物理机理驱动、数据驱动、数理融合三种求解方式,并提供了基础 API 和详尽文档供用户使用与二次开发。
86

97
## 特性
108

119
- 支持简单几何和复杂 STL 几何的采样与布尔运算。
1210
- 支持包括 Dirichlet、Neumann、Robin 以及自定义边界条件。
1311
- 支持物理机理驱动、数据驱动、数理融合三种问题求解方式。涵盖流体、结构、气象等领域 8+ 案例。
1412
- 支持结果可视化输出与日志结构化保存。
15-
- 完善的 type hints,用户使用和代码贡献全流程文档,所有案例 AI studio 一键运行,降低使用门槛,提高开发效率。
16-
- 更多特性开发中...
13+
- 完善的 type hints,用户使用和代码贡献全流程文档,所有经典案例 AI studio 一键运行,降低使用门槛,提高开发效率。
14+
- 更多特性正在开发中...
1715

1816
## 支持
1917

@@ -25,4 +23,4 @@ PaddleScience 项目欢迎并依赖开发人员和开源社区中的用户,请
2523

2624
## 证书
2725

28-
[Apache License](../LICENSE)
26+
[Apache License 2.0](https://github.com/PaddlePaddle/PaddleScience/blob/develop/LICENSE)

docs/overview.md

Lines changed: 18 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,32 @@
1-
# PaddleScience 介绍
1+
# PaddleScience 模块介绍
22

3-
PaddleScience 是一个基于深度学习框架 PaddlePaddle 的科学计算套件,支持物理信息驱动、数据驱动、数理融合三种求解方式,已支持 8+ 各领域的案例,并提供了基础 API 供用户使用与二次开发
3+
PaddleScience 在代码结构上划分为 12 个模块。从一般深度学习工作流的角度来看,这 12 个模块分别负责构建输入数据、构建神经网络模型、构建损失函数、构建优化器,训练、评估、可视化等功能。从科学计算角度来看,部分模块承担了不同于 CV、NLP 任务的功能,比如用于物理机理驱动的 Equation 模块,定义方程公式和辅助高阶微分计算;用于涉及几何场景采样的 Geometry 模块,定义简单、复杂几何形状并在其内部、边界采样构造数据;Constraint 模块将不同的优化目标视为一种“约束”,使得套件能用一套训练代码统一物理机理驱动(无监督训练)、数据驱动(监督训练)、数理融合(半监督训练)三种不同的求解流程
44

5-
## 1. 运行流程
5+
## 1. 整体工作流
66

7-
![TODO](workflow.jpg)
7+
<figure markdown>
8+
![TODO](workflow.jpg){ loading=lazy }
9+
<figcaption> workflow of PaddleScience </figcaption>
10+
</figure>
811

912
## 2. 模块简介
1013

14+
<figure markdown>
15+
![TODO](modules.jpg){ loading=lazy }
16+
<figcaption> Relation of different modules </figcaption>
17+
</figure>
18+
1119
### 2.1 [Arch](./zh/api/arch.md)
1220

1321
Arch 模块负责各种神经网络模型的组网、参数初始化、前向计算等功能,内置了多种模型供用户使用。
1422

1523
### 2.2 [AutoDiff](./zh/api/autodiff.md)
1624

17-
AutoDiff 模块负责计算高阶(1、2阶)微分功能,内置全局单例模式对象 `jacobian``hessian` 供用户使用。
25+
AutoDiff 模块负责计算高阶微分功能,内置基于 Paddle 自动微分机制的全局单例 `jacobian``hessian` 供用户使用。
1826

1927
### 2.3 [Constraint](./zh/api/constraint.md)
2028

21-
为了在套件中统一物理信息驱动、数据驱动、数理融合三种求解方式,我们将数据构造、输入到输出的计算过程、损失函数等功能记录到了 Constraint 这一模块中,有了这些对象,Constraint 就能表示不同的训练目标,如
29+
为了在套件中统一物理信息驱动、数据驱动、数理融合三种求解方式,我们将数据构造、输入到输出的计算过程、损失函数等必要接口在其定义完毕之后,统一记录在 Constraint 这一模块中,有了这些接口,Constraint 就能表示不同的训练目标,如
2230

2331
- `InteriorConstraint` 定义了在给定的几何区域内部,按照给定输入到输出的计算过程,利用损失函数优化模型参数,使得模型输出满足给定的条件;
2432
- `BoundaryConstraint` 定义了在给定的几何区域边界上,按照给定输入到输出的计算过程,利用损失函数优化模型参数,使得模型输出满足给定的条件;
@@ -29,19 +37,19 @@ AutoDiff 模块负责计算高阶(1、2阶)微分功能,内置全局单例
2937

3038
### 2.4 Data
3139

32-
Data 模块负责数据的读取、包装以及预处理,由 3 个子模块分别负责。
40+
Data 模块负责数据的读取、包装和预处理,由以下 3 个子模块分别负责。
3341

3442
#### 2.4.1 [Dataset](./zh/api/data/dataset.md)
3543

3644
Dataset 模块存放各种数据集的包装类,将数据包装成统一的结构再用于读取。
3745

3846
#### 2.4.2 [Transform](./zh/api/data/process/transform.md)
3947

40-
Transform 模块存放各种数据预处理方法,包括数据平移 `Translate` 和数据缩放 `Scale`,一般与 `data.dataset` 结合使用。
48+
Transform 模块存放各种基于单样本的数据预处理方法,包括数据平移 `Translate` 和数据缩放 `Scale`,一般与 `data.dataset` 结合使用。
4149

4250
#### 2.4.3 [BatchTransform](./zh/api/data/process/batch_transform.md)
4351

44-
BatchTransform 模块存放各种基于批数据的预处理方法
52+
BatchTransform 模块存放各种基于批样本的数据预处理方法
4553

4654
### 2.5 [Equation](./zh/api/equation.md)
4755

@@ -65,7 +73,7 @@ Solver 模块负责定义求解器,作为训练、评估、推理、可视化
6573

6674
### 2.10 [Utils](./zh/api/utils.md)
6775

68-
Utils 模块内部存放了一些适用于多种场景下的函数,如在 `reader.py` 下的多种数据读取函数,以及在 `logger.py` 下的日志打印函数。
76+
Utils 模块内部存放了一些适用于多种场景下的工具类、函数,如在 `reader.py` 下的数据读取函数,在 `logger.py` 下的日志打印函数,以及在 `expression.py` 下的方程计算类
6977

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

mkdocs.yml

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,7 @@ site_description: An out-of-the-box open source library for scientific computing
1818
site_author: PaddlePaddle
1919
site_url: "https://github.com/PaddlePaddle/PaddleScience"
2020
strict: false
21+
edit_uri: edit/main/docs # 编辑按钮跳转的链接
2122

2223
# Repository
2324
repo_name: PaddleScience
@@ -28,7 +29,7 @@ copyright: Copyright &copy; 2022 - 2023 PaddlePaddle
2829

2930
# Page tree
3031
nav:
31-
- 安装使用:
32+
- PaddleScience:
3233
- 主页: index.md
3334
- 功能介绍: overview.md
3435
- 开始使用: install_setup.md
@@ -84,6 +85,7 @@ theme:
8485
- navigation.sections
8586
- navigation.prune
8687
- navigation.top
88+
- search.suggest
8789
- navigation.instant
8890
- navigation.expand
8991
- content.code.copy
@@ -124,7 +126,7 @@ markdown_extensions:
124126
- pymdownx.arithmatex:
125127
generic: true
126128
- toc:
127-
permalink: ⚓︎
129+
permalink: true
128130
- pymdownx.inlinehilite
129131
- pymdownx.superfences
130132
- admonition

0 commit comments

Comments
 (0)