Fix

PaddlePaddle · Oct 24, 2023 · 32943ea · 32943ea
2 parents 9b63a12 + bdf1fdc
commit 32943ea
Show file tree

Hide file tree

Showing 23 changed files with 2,536 additions and 73 deletions.
diff --git a/README.md b/README.md
@@ -14,7 +14,7 @@
 [**PaddleScience使用文档**](https://paddlescience-docs.readthedocs.io/zh/latest/)
 
 <!-- --8<-- [start:description] -->
-## 简介
+## 👀简介
 
 PaddleScience 是一个基于深度学习框架 PaddlePaddle 开发的科学计算套件，利用深度神经网络的学习能力和 PaddlePaddle 框架的自动(高阶)微分机制，解决物理、化学、气象等领域的问题。支持物理机理驱动、数据驱动、数理融合三种求解方式，并提供了基础 API 和详尽文档供用户使用与二次开发。
 <!-- --8<-- [end:description] -->
@@ -23,8 +23,22 @@ PaddleScience 是一个基于深度学习框架 PaddlePaddle 开发的科学计
     <img src="https://paddle-org.bj.bcebos.com/paddlescience/docs/overview/panorama.png" width="100%" height="100%">
 </div>
 
+<!-- --8<-- [start:examples_list] -->
+<!-- ## 📝案例列表
+
+| 案例名称 | 优化算法 | 所属领域 | 问题类型 | 数据来源 | 参考结果 |
+|:--|:--|:--|:--|:--|:--|
+| - | - | - | - | - | - |
+| - | - | - | - | - | - |
+| - | - | - | - | - | - |
+| - | - | - | - | - | - |
+| - | - | - | - | - | - |
+| - | - | - | - | - | - |
+| - | - | - | - | - | - | -->
+<!-- --8<-- [end:examples_list] -->
+
 <!-- --8<-- [start:update] -->
-## 最近更新
+## 🕘最近更新
 
 - 添加二维血管案例([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))。
@@ -33,7 +47,7 @@ PaddleScience 是一个基于深度学习框架 PaddlePaddle 开发的科学计
 <!-- --8<-- [end:update] -->
 
 <!-- --8<-- [start:feature] -->
-## 特性
+## ✨特性
 
 - 支持简单几何和复杂 STL 几何的采样与布尔运算。
 - 支持包括 Dirichlet、Neumann、Robin 以及自定义边界条件。
@@ -44,7 +58,7 @@ PaddleScience 是一个基于深度学习框架 PaddlePaddle 开发的科学计
 - 更多特性正在开发中...
 <!-- --8<-- [end:feature] -->
 
-## 安装使用
+## 🚀安装使用
 
 1. 执行以下命令，从 github 上克隆 PaddleScience 项目，进入 PaddleScience 目录，并将该目录添加到系统环境变量中
 
@@ -80,36 +94,62 @@ PaddleScience 是一个基于深度学习框架 PaddlePaddle 开发的科学计
     # write your code here...
     ```
 
-更多安装方式请参考 [**安装与使用**](https://paddlescience-docs.readthedocs.io/zh/latest/zh/install_setup/)
+完整安装流程请参考 [**安装与使用**](https://paddlescience-docs.readthedocs.io/zh/latest/zh/install_setup/)
 
-## 快速开始
+## ⚡️快速开始
 
 请参考 [**快速开始**](https://paddlescience-docs.readthedocs.io/zh/latest/zh/quickstart/)
 
-## 经典案例
-
-请参考 [**经典案例**](https://paddlescience-docs.readthedocs.io/zh/latest/zh/examples/viv/)
-
 <!-- --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] -->
-## 贡献代码
+## 👫开源共建
+
+PaddleScience 项目欢迎并依赖开发人员和开源社区中的用户，会不定期推出开源活动。
+
+> 在开源活动中如需使用 PaddleScience 进行开发，可参考 [**PaddleScience 开发与贡献指南**](https://paddlescience-docs.readthedocs.io/zh/latest/zh/development/) 以提升开发效率和质量。
+
+- 🎁快乐开源
+
+    旨在鼓励更多的开发者参与到飞桨科学计算社区的开源建设中，帮助社区修复 bug 或贡献 feature，加入开源、共建飞桨。了解编程基本知识的入门用户即可参与，活动进行中：
+    [PaddleScience 快乐开源活动表单](https://github.com/PaddlePaddle/PaddleScience/issues/379)
+
+- 🔥第五期黑客松
+
+    面向全球开发者的深度学习领域编程活动，鼓励开发者了解与参与飞桨深度学习开源项目与文心大模型开发实践。活动进行中：[【PaddlePaddle Hackathon 5th】开源贡献个人挑战赛](https://github.com/PaddlePaddle/community/blob/master/hackathon/hackathon_5th/%E3%80%90PaddlePaddle%20Hackathon%205th%E3%80%91%E5%BC%80%E6%BA%90%E8%B4%A1%E7%8C%AE%E4%B8%AA%E4%BA%BA%E6%8C%91%E6%88%98%E8%B5%9B%E7%A7%91%E5%AD%A6%E8%AE%A1%E7%AE%97%E4%BB%BB%E5%8A%A1%E5%90%88%E9%9B%86.md#%E4%BB%BB%E5%8A%A1%E5%BC%80%E5%8F%91%E6%B5%81%E7%A8%8B%E4%B8%8E%E9%AA%8C%E6%94%B6%E6%A0%87%E5%87%86)
 
-PaddleScience 项目欢迎并依赖开发人员和开源社区中的用户，请参阅 [**贡献指南**](https://paddlescience-docs.readthedocs.io/zh/latest/zh/development/)。
 <!-- --8<-- [end:contribution] -->
 
 <!-- --8<-- [start:thanks] -->
-## 致谢
+## ❤️致谢
 
-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) 等优秀开源套件的启发。
+- 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) 等优秀开源套件的启发。
 <!-- --8<-- [end:thanks] -->
+- PaddleScience 的部分案例和代码由以下优秀社区开发者贡献（按 [Contributors](https://github.com/PaddlePaddle/PaddleScience/graphs/contributors) 排序）：
+    [Asthestarsfalll](https://github.com/Asthestarsfalll)，
+    [co63oc](https://github.com/co63oc)，
+    [AndPuQing](https://github.com/AndPuQing)，
+    [MayYouBeProsperous](https://github.com/MayYouBeProsperous)，
+    [yangguohao](https://github.com/yangguohao)，
+    [mrcangye](https://github.com/mrcangye)，
+    [jjyaoao](https://github.com/jjyaoao)，
+    [jiamingkong](https://github.com/jiamingkong)，
+    [Liyulingyue](https://github.com/Liyulingyue)，
+    [XYM](https://github.com/XYM)，
+    [xusuyong](https://github.com/xusuyong)，
+    [NKNaN](https://github.com/NKNaN)，
+    [ruoyunbai](https://github.com/ruoyunbai)，
+    [sanbuphy](https://github.com/sanbuphy)，
+    [ccsuzzh](https://github.com/ccsuzzh)，
+    [enkilee](https://github.com/enkilee)，
+    [GreatV](https://github.com/GreatV)
 
 <!-- --8<-- [start:license] -->
-## 证书
+## 📜证书
 
 [Apache License 2.0](https://github.com/PaddlePaddle/PaddleScience/blob/develop/LICENSE)
 <!-- --8<-- [end:license] -->
diff --git a/docs/index.md b/docs/index.md
@@ -10,29 +10,33 @@
 
 ![panorama](https://paddle-org.bj.bcebos.com/paddlescience/docs/overview/panorama.png)
 
-!!! tip "快速安装"
+--8<--
+./README.md:examples_list
+--8<--
 
-    === "方式1: 源码安装[推荐]"
+## 🚀快速安装
 
-        --8<--
-        ./README.md:git_install
-        --8<--
+=== "方式1: 源码安装[推荐]"
 
-    === "方式2: pip安装"
+    --8<--
+    ./README.md:git_install
+    --8<--
 
-        ``` shell
-        pip install paddlesci
-        ```
+=== "方式2: pip安装"
 
-    === "[完整安装流程](./zh/install_setup.md)"
+    ``` shell
+    pip install paddlesci
+    ```
 
-        ``` shell
-        pip install paddlesci
-        ```
+=== "[完整安装流程](./zh/install_setup.md)"
 
---8<--
-./README.md:update
---8<--
+    ``` shell
+    pip install paddlesci
+    ```
+
+    ``` shell
+    pip install paddlesci
+    ```
 
 --8<--
 ./README.md:feature
@@ -50,6 +54,40 @@
 ./README.md:thanks
 --8<--
 
-## 证书
+- PaddleScience 的部分代码由以下优秀社区开发者贡献（按 [Contributors](https://github.com/PaddlePaddle/PaddleScience/graphs/contributors) 排序）：
+
+    <style>
+        .avatar {
+            height: 64px;
+            width: 64px;
+            border: 2px solid rgba(128, 128, 128, 0.308);
+            border-radius: 50%;
+        }
+
+        .avatar:hover {
+            box-shadow: 0 8px 16px 0 rgba(0, 0, 0, 0.4);
+            transition: 0.4s;
+            transform:translateY(-10px);
+        }
+    </style>
+    <a href="https://github.com/Asthestarsfalll"><img class="avatar" src="https://avatars.githubusercontent.com/Asthestarsfalll" alt="avatar" /></a>
+    <a href="https://github.com/co63oc"><img class="avatar" src="https://avatars.githubusercontent.com/co63oc" alt="avatar" /></a>
+    <a href="https://github.com/AndPuQing"><img class="avatar" src="https://avatars.githubusercontent.com/AndPuQing" alt="avatar" /></a>
+    <a href="https://github.com/MayYouBeProsperous"><img class="avatar" src="https://avatars.githubusercontent.com/MayYouBeProsperous" alt="avatar" /></a>
+    <a href="https://github.com/yangguohao"><img class="avatar" src="https://avatars.githubusercontent.com/yangguohao" alt="avatar" /></a>
+    <a href="https://github.com/mrcangye"><img class="avatar" src="https://avatars.githubusercontent.com/mrcangye" alt="avatar" /></a>
+    <a href="https://github.com/jjyaoao"><img class="avatar" src="https://avatars.githubusercontent.com/jjyaoao" alt="avatar" /></a>
+    <a href="https://github.com/jiamingkong"><img class="avatar" src="https://avatars.githubusercontent.com/jiamingkong" alt="avatar" /></a>
+    <a href="https://github.com/Liyulingyue"><img class="avatar" src="https://avatars.githubusercontent.com/Liyulingyue" alt="avatar" /></a>
+    <a href="https://github.com/XYM-1"><img class="avatar" src="https://avatars.githubusercontent.com/XYM-1" alt="avatar" /></a>
+    <a href="https://github.com/xusuyong"><img class="avatar" src="https://avatars.githubusercontent.com/xusuyong" alt="avatar" /></a>
+    <a href="https://github.com/NKNaN"><img class="avatar" src="https://avatars.githubusercontent.com/NKNaN" alt="avatar" /></a>
+    <a href="https://github.com/ruoyunbai"><img class="avatar" src="https://avatars.githubusercontent.com/ruoyunbai" alt="avatar" /></a>
+    <a href="https://github.com/sanbuphy"><img class="avatar" src="https://avatars.githubusercontent.com/sanbuphy" alt="avatar" /></a>
+    <a href="https://github.com/ccsuzzh"><img class="avatar" src="https://avatars.githubusercontent.com/ccsuzzh" alt="avatar" /></a>
+    <a href="https://github.com/enkilee"><img class="avatar" src="https://avatars.githubusercontent.com/enkilee" alt="avatar" /></a>
+    <a href="https://github.com/GreatV"><img class="avatar" src="https://avatars.githubusercontent.com/GreatV" alt="avatar" /></a>
 
-[Apache License 2.0](https://github.com/PaddlePaddle/PaddleScience/blob/develop/LICENSE)
+--8<--
+./README.md:license
+--8<--
diff --git a/docs/zh/development.md b/docs/zh/development.md
@@ -547,7 +547,7 @@ eta_mse_validator = ppsci.validate.SupervisedValidator(
     ]
     ```
 
-完成上述新评估器代码编写的工作之后，我们就能像 PaddleScience 内置评估器一样，以 `ppsci.equation.NewValidator` 的方式，调用我们编写的新评估器类，并用于创建评估器实例。同样地，在评估器构建完毕后之后，建议将所有评估器包装到一个字典中方便后续索引。
+完成上述新评估器代码编写的工作之后，我们就能像 PaddleScience 内置评估器一样，以 `ppsci.validate.NewValidator` 的方式，调用我们编写的新评估器类，并用于创建评估器实例。同样地，在评估器构建完毕后之后，建议将所有评估器包装到一个字典中方便后续索引。
 
 ``` py title="examples/demo/demo.py"
 new_validator = ppsci.validate.NewValidator(...)