feat(neuralop): support paddle

README.rst

@@ -7,7 +7,52 @@
 
 
 ===============
-Neural Operator
+Neural Operator(Paddle backend)
+===============
+
+.. image::  doc/_static/paddle_logo.png
+
+.. important::
+
+   This branch(paddle) experimentally integrates `Paddle backend <https://www.paddlepaddle.org.cn/en/install/quick?docurl=/documentation/docs/en/develop/install/pip/linux-pip_en.html>`_ to Neural Operator.
+   It was developed from version 0.3.0 of Neural Operator. It is recommended to install **nightly-build(develop)** Paddle before running any code in this branch.
+   It was verified on Ubuntu 20.04. It may meet some problems if you are using other environment.
+
+Installation
+------------
+
+.. code::
+
+   # install nightly-build paddlepaddle
+   python -m pip install --pre paddlepaddle-gpu -i https://www.paddlepaddle.org.cn/packages/nightly/cu118/
+
+   # triton
+   pip install -U --index-url https://aiinfra.pkgs.visualstudio.com/PublicPackages/_packaging/Triton-Nightly/pypi/simple/ triton-nightly
+
+   # install paddle_harmonics
+   git clone https://github.com/co63oc/PaddleScience.git
+   cd PaddleScience
+   git checkout fix2
+   cd jointContribution/paddle_harmonics
+   pip install -e . -i https://pypi.tuna.tsinghua.edu.cn/simple
+   export PYTHONPATH=</path to/PaddleScience/jointContribution/paddle_harmonics>:$PYTHONPATH
+
+   # install nightly-build ppsci
+   python -m pip install https://paddle-qa.bj.bcebos.com/PaddleScience/whl/latest/dist/paddlesci-0.0.0-py3-none-any.whl -i https://pypi.tuna.tsinghua.edu.cn/simple
+
+   # install neuraloperator
+   cd neuraloperator
+   pip install -e . -i https://pypi.tuna.tsinghua.edu.cn/simple
+
+Unit Test
+------------
+
+.. code::
+
+   cd neuraloperator/example
+   pytest
+
+Below is Neural Operator's original README
 ===============
 
 ``neuraloperator`` is a comprehensive library for 

config/burgers_config.yaml

@@ -64,7 +64,7 @@ default: &DEFAULT
 
   # Dataset related
   data:
-    folder: '/home/ubuntu/data/burgers/burgers.npz' 
+    folder: '/home/ubuntu/data/burgers/burgers.npz'
     batch_size: 16
     n_train: 800
     test_batch_sizes: [16]
@@ -92,4 +92,4 @@ default: &DEFAULT
     entity: "" # put your username here
     sweep: False
     log_output: True
-    log_test_interval: 1
+    log_test_interval: 1

config/burgers_pino_config.yaml

@@ -69,7 +69,7 @@ default: &DEFAULT
 
   # Dataset related
   data:
-    folder: '/home/ubuntu/data/burgers/burgers.npz' 
+    folder: '/home/ubuntu/data/burgers/burgers.npz'
     batch_size: 16
     n_train: 800
     test_batch_sizes: [16]
@@ -97,4 +97,4 @@ default: &DEFAULT
     entity: "" # put your username here
     sweep: False
     log_output: True
-    log_test_interval: 1
+    log_test_interval: 1

config/darcy_config.yaml

@@ -30,7 +30,7 @@ default: &DEFAULT
     implementation: 'factorized'
     separable: 0
     preactivation: 0
-    
+
     use_mlp: 1
     mlp:
         expansion: 0.5
@@ -82,7 +82,7 @@ default: &DEFAULT
   wandb:
     log: False
     name: None # If None, config will be used but you can override it here
-    group: '' 
+    group: ''
     project: ""
     entity: "" # put your username here
     sweep: False

config/default_config.yaml

@@ -28,7 +28,7 @@ default: &DEFAULT
     norm: None
     skip: 'soft-gating'
     implementation: 'reconstructed'
-    
+
     use_mlp: 1
     mlp_expansion: 0.5
     mlp_dropout: 0
@@ -66,7 +66,7 @@ default: &DEFAULT
     n_train: 10000
     train_resolution: 128
     n_tests: [2000, 1000, 1000] #, 1000]
-    test_resolutions: [128, 256, 512] #, 1024] 
+    test_resolutions: [128, 256, 512] #, 1024]
     test_batch_sizes: [16, 8, 4] #, 1]
     positional_encoding: True
 
@@ -86,7 +86,7 @@ default: &DEFAULT
   wandb:
     log: True
     name: None # If None, config will be used but you can override it here
-    group: 'super-resolution' 
+    group: 'super-resolution'
     project: "Refactored-TFNO"
     entity: "nvr-ai-algo" # put your username here
     sweep: False
@@ -107,7 +107,7 @@ original_fno:
     fft_norm: 'forward'
     norm: None
     skip: 'linear'
-    
+
     use_mlp: 0
     mlp:
         expansion: 0.5
@@ -122,8 +122,8 @@ original_fno:
     log: False
     name: None # If None, config will be used but you can override it here
     group: 'wandb_group'
-    
-  
+
+
 distributed_mg_tucker:
   tfno2d:
     factorization: Tucker
@@ -141,4 +141,3 @@ distributed_mg_tucker:
     levels: 1
     padding: 16
     stitching: True
-

config/test_config.yaml

@@ -18,7 +18,7 @@ default: &DEFAULT
     norm: None
     skip: 'soft-gating'
     implementation: 'factorized'
-    
+
     use_mlp: 1
     mlp:
         expansion: 0.5
@@ -32,7 +32,7 @@ default: &DEFAULT
     joint_factorization: False
     fno_block_precision: 'full' #or 'half', 'mixed'
     stabilizer: None #or 'tanh'
-  
+
   data:
     batch_size: 4
     n_train: 10

doc/requirements_doc.txt

@@ -1,6 +1,6 @@
-sphinx
-numpydoc
 matplotlib
-sphinx-gallery
 myst-nb
+numpydoc
+sphinx
+sphinx-gallery
 tensorly_sphinx_theme

doc/source/compress_images.sh

@@ -1,5 +1,5 @@
 # Adapted from https://stackoverflow.com/questions/59111396/loop-through-the-directories-to-get-the-image-files
-# Usage 
+# Usage
 # chmod 755 compress_images.bash
 # bash compress_images.sh ./_static/images
 

doc/source/conf.py

@@ -16,15 +16,18 @@
 
 
 # -- Project information -----------------------------------------------------
-
-project = 'neuraloperator'
 from datetime import datetime
+
+import neuralop
+
+project = "neuraloperator"
+
+
 year = datetime.now().year
-copyright = f'{year}, Jean Kossaifi, Nikola Kovachki, Zongyi Li and Anima Anandkumar'
-author = 'Jean Kossaifi, Nikola Kovachki, Zongyi Li and Anima Anandkumar'
+copyright = f"{year}, Jean Kossaifi, Nikola Kovachki, Zongyi Li and Anima Anandkumar"
+author = "Jean Kossaifi, Nikola Kovachki, Zongyi Li and Anima Anandkumar"
 
 # The full version, including alpha/beta/rc tags
-import neuralop
 release = neuralop.__version__
 
 
@@ -34,78 +37,78 @@
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
 # ones.
 extensions = [
-    'sphinx.ext.autodoc',
-    'sphinx.ext.autosummary',
-    'sphinx.ext.todo',
-    'sphinx.ext.viewcode',
-    'sphinx.ext.githubpages',
-    'sphinx.ext.mathjax', #'sphinx.ext.imgmath',
-    'numpydoc.numpydoc',
-    'sphinx_gallery.gen_gallery',
+    "sphinx.ext.autodoc",
+    "sphinx.ext.autosummary",
+    "sphinx.ext.todo",
+    "sphinx.ext.viewcode",
+    "sphinx.ext.githubpages",
+    "sphinx.ext.mathjax",  # 'sphinx.ext.imgmath',
+    "numpydoc.numpydoc",
+    "sphinx_gallery.gen_gallery",
 ]
 
 sphinx_gallery_conf = {
-     'examples_dirs': '../../examples',   # path to your example scripts
-     'gallery_dirs': 'auto_examples',  # path to where to save gallery generated output
+    "examples_dirs": "../../examples",  # path to your example scripts
+    "gallery_dirs": "auto_examples",  # path to where to save gallery generated output
 }
 
 
 # Add any paths that contain templates here, relative to this directory.
-templates_path = ['_templates']
+templates_path = ["_templates"]
 
 # List of patterns, relative to source directory, that match files and
 # directories to ignore when looking for source files.
 # This pattern also affects html_static_path and html_extra_path.
 exclude_patterns = []
 
-# NumPy 
+# NumPy
 numpydoc_class_members_toctree = False
 numpydoc_show_class_members = True
 numpydoc_show_inherited_class_members = False
 
 # generate autosummary even if no references
 autosummary_generate = True
-autodoc_member_order = 'bysource'
-autodoc_default_flags = ['members']
+autodoc_member_order = "bysource"
+autodoc_default_flags = ["members"]
 
 # Napoleon
 napoleon_google_docstring = False
 napoleon_use_rtype = False
 
 # imgmath/mathjax
-imgmath_image_format = 'svg'
+imgmath_image_format = "svg"
 
 # List of patterns, relative to source directory, that match files and
 # directories to ignore when looking for source files.
 # This pattern also affects html_static_path and html_extra_path.
-exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
+exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"]
 
 
 # -- Options for HTML output -------------------------------------------------
 
 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
 #
-html_theme = 'tensorly_sphinx_theme'
-html_logo = '_static/logos/neuraloperator_logo.png'
+html_theme = "tensorly_sphinx_theme"
+html_logo = "_static/logos/neuraloperator_logo.png"
 html_show_sphinx = False
 
 html_theme_options = {
-    'github_url': 'https://github.com/neuraloperator/neuraloperator',
+    "github_url": "https://github.com/neuraloperator/neuraloperator",
     # 'google_analytics' : 'G-QSPLEF75VT',
-    'nav_links' : [('Install', 'install'),
-                   ('User Guide', 'user_guide/index'),
-                   ('API', 'modules/api'),
-                   ('Examples', 'auto_examples/index')
-                  ],
+    "nav_links": [
+        ("Install", "install"),
+        ("User Guide", "user_guide/index"),
+        ("API", "modules/api"),
+        ("Examples", "auto_examples/index"),
+    ],
     # 'external_nav_links' : [('TensorLy', 'http://tensorly.org/dev')]
 }
 
 # Add any paths that contain custom static files (such as style sheets) here,
 # relative to this directory. They are copied after the builtin static files,
 # so a file named "default.css" will overwrite the builtin "default.css".
-html_static_path = ['_static']
+html_static_path = ["_static"]
 
 # Remove the permalinks ("¶" symbols)
 html_permalinks_icon = ""
-