Merge branch 'develop' into clean_code

Author: HydrogenSulfate

.gitmodules

@@ -0,0 +1,3 @@
+[submodule "competition/IJCAI_2024_CAR"]
+	path = competition/IJCAI_2024_CAR
+	url = https://atomgit.com/paddlenumberone/ijcai_car.git

README.md

@@ -13,6 +13,8 @@
 
 [**PaddleScience使用文档**](https://paddlescience-docs.readthedocs.io/zh/latest/)
 
+🔥 [IJCAI 2024: 任意三维几何外形车辆的风阻快速预测竞赛](https://competition.atomgit.com/competitionInfo?id=7f3f276465e9e845fd3a811d2d6925b5)，欢迎报名参赛。
+
 <!-- --8<-- [start:description] -->
 ## 👀简介
 
@@ -36,6 +38,7 @@ PaddleScience 是一个基于深度学习框架 PaddlePaddle 开发的科学计
 | 微分方程 | [分数阶微分方程](https://github.com/PaddlePaddle/PaddleScience/blob/develop/examples/fpde/fractional_poisson_2d.py) | 机理驱动 | MLP | 无监督学习 | - | - |
 | 光孤子 | [Optical soliton](https://paddlescience-docs.readthedocs.io/zh/latest/zh/examples/nlsmb) | 机理驱动 | MLP | 无监督学习 | - | [Paper](https://doi.org/10.1007/s11071-023-08824-w)|
 | 光纤怪波 | [Optical rogue wave](https://paddlescience-docs.readthedocs.io/zh/latest/zh/examples/nlsmb) | 机理驱动 | MLP | 无监督学习 | - | [Paper](https://doi.org/10.1007/s11071-023-08824-w)|
+| 相场方程 | [Allen-Cahn](https://paddlescience-docs.readthedocs.io/zh/latest/zh/examples/allen_cahn) | 机理驱动 | MLP | 无监督学习 | - | |
 
 <br>
 <p align="center"><b>技术科学(AI for Technology)</b></p>
@@ -219,9 +222,9 @@ PaddleScience 项目欢迎并依赖开发人员和开源社区中的用户，会
     旨在鼓励更多的开发者参与到飞桨科学计算社区的开源建设中，帮助社区修复 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)
+    面向全球开发者的深度学习领域编程活动，鼓励开发者了解与参与飞桨深度学习开源项目与文心大模型开发实践。活动进行中：[【PaddlePaddle Hackathon 5th】开源贡献个人挑战赛](https://github.com/PaddlePaddle/community/blob/master/hackathon/hackathon_6th/%E3%80%90Hackathon%206th%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)
 <!-- --8<-- [end:contribution] -->
 
 <!-- --8<-- [start:collaboration] -->

competition/IJCAI_2024_CAR

@@ -0,0 +1,20 @@
+# Competition
+
+This part is for all competitions.
+Codes of all competitions are stored by submoudule. If you need to obtain it, please initialize the submoudule after cloning PaddleScience.
+
+When you initialize the submoudule, some competitions need your username and password(or token). You can register on the corresponding official website and then get it, usually in "Settings" - "Create Personal Token".
+
+## submodule initialization
+
+``` sh
+# for example IJCAI_2024_CAR
+cd PaddleScience
+git submodule update --init --recursive competition/IJCAI_2024_CAR
+```
+
+## competition list
+
+| competition name | submodule name | competition website | official website |
+|-------------|-------------|-------------|-------------|
+| IJCAI | IJCAI_2024_CAR | [IJCAI_2024_CAR](https://competition.atomgit.com/competitionInfo?id=7f3f276465e9e845fd3a811d2d6925b5) | [atomgit](https://atomgit.com/) |

competition/README.md

@@ -11,3 +11,15 @@
 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 # See the License for the specific language governing permissions and
 # limitations under the License.
+
+from deploy.python_infer.base import Predictor
+from deploy.python_infer.pinn_predictor import PINNPredictor
+
+# alias as PINNPredictor can be used in most cases
+GeneralPredictor = PINNPredictor
+
+__all__ = [
+    "Predictor",
+    "PINNPredictor",
+    "GeneralPredictor",
+]

deploy/python_infer/__init__.py

@@ -36,7 +36,7 @@ class Predictor:
 
     Args:
         pdmodel_path (Optional[str]): Path to the PaddlePaddle model file. Defaults to None.
-        pdpiparams_path (Optional[str]): Path to the PaddlePaddle model parameters file. Defaults to None.
+        pdiparams_path (Optional[str]): Path to the PaddlePaddle model parameters file. Defaults to None.
         device (Literal["gpu", "cpu", "npu", "xpu"], optional): Device to use for inference. Defaults to "cpu".
         engine (Literal["native", "tensorrt", "onnx", "mkldnn"], optional): Inference engine to use. Defaults to "native".
         precision (Literal["fp32", "fp16", "int8"], optional): Precision to use for inference. Defaults to "fp32".
@@ -51,7 +51,7 @@ class Predictor:
     def __init__(
         self,
         pdmodel_path: Optional[str] = None,
-        pdpiparams_path: Optional[str] = None,
+        pdiparams_path: Optional[str] = None,
         *,
         device: Literal["gpu", "cpu", "npu", "xpu"] = "cpu",
         engine: Literal["native", "tensorrt", "onnx", "mkldnn"] = "native",
@@ -65,7 +65,7 @@ def __init__(
         num_cpu_threads: int = 10,
     ):
         self.pdmodel_path = pdmodel_path
-        self.pdpiparams_path = pdpiparams_path
+        self.pdiparams_path = pdiparams_path
 
         self._check_device(device)
         self.device = device
@@ -104,13 +104,13 @@ def _create_paddle_predictor(
                 f"Given 'pdmodel_path': {self.pdmodel_path} does not exist. "
                 "Please check if it is correct."
             )
-        if not osp.exists(self.pdpiparams_path):
+        if not osp.exists(self.pdiparams_path):
             raise FileNotFoundError(
-                f"Given 'pdpiparams_path': {self.pdpiparams_path} does not exist. "
+                f"Given 'pdiparams_path': {self.pdiparams_path} does not exist. "
                 "Please check if it is correct."
             )
 
-        config = paddle_inference.Config(self.pdmodel_path, self.pdpiparams_path)
+        config = paddle_inference.Config(self.pdmodel_path, self.pdiparams_path)
         if self.device == "gpu":
             config.enable_use_gpu(self.gpu_mem, self.gpu_id)
             if self.engine == "tensorrt":

deploy/python_infer/base.py

@@ -38,7 +38,7 @@ def __init__(
     ):
         super().__init__(
             cfg.INFER.pdmodel_path,
-            cfg.INFER.pdpiparams_path,
+            cfg.INFER.pdiparams_path,
             device=cfg.INFER.device,
             engine=cfg.INFER.engine,
             precision=cfg.INFER.precision,

deploy/python_infer/pinn_predictor.py

@@ -4,6 +4,8 @@
 ./README.md:status
 --8<--
 
+🔥 [IJCAI 2024: 任意三维几何外形车辆的风阻快速预测竞赛](https://competition.atomgit.com/competitionInfo?id=7f3f276465e9e845fd3a811d2d6925b5)，欢迎报名参赛。
+
 <style>
     .container {
         display: flex;
@@ -81,6 +83,7 @@
 | 微分方程 | [分数阶微分方程](https://github.com/PaddlePaddle/PaddleScience/blob/develop/examples/fpde/fractional_poisson_2d.py) | 机理驱动 | MLP | 无监督学习 | - | - |
 | 光孤子 | [Optical soliton](./zh/examples/nlsmb.md) | 机理驱动 | MLP | 无监督学习 | - | [Paper](https://doi.org/10.1007/s11071-023-08824-w)|
 | 光纤怪波 | [Optical rogue wave](./zh/examples/nlsmb.md) | 机理驱动 | MLP | 无监督学习 | - | [Paper](https://doi.org/10.1007/s11071-023-08824-w)|
+| 相场方程 | [Allen-Cahn](./zh/examples/allen_cahn.md) | 机理驱动 | MLP | 无监督学习 | - | |
 
 <br>
 <p align="center"><b>技术科学(AI for Technology)</b></p>

docs/index.md

@@ -27,5 +27,6 @@
         - DGMR
         - ChipDeepONets
         - AutoEncoder
+        - CuboidTransformer
       show_root_heading: true
       heading_level: 3

docs/zh/api/arch.md

@@ -0,0 +1,11 @@
+# Python_infer(Python 推理) 模块
+
+::: deploy.python_infer
+    handler: python
+    options:
+      members:
+        - Predictor
+        - GeneralPredictor
+        - PINNPredictor
+      show_root_heading: true
+      heading_level: 3