diff --git a/docs/source/_static/custom.css b/docs/source/_static/custom.css index 293706e..0217f33 100644 --- a/docs/source/_static/custom.css +++ b/docs/source/_static/custom.css @@ -1,40 +1,12 @@ -/* Hero section */ -.hero { - text-align: center; - padding: 3rem 0; -} -.hero img { - max-width: 320px; -} -.hero .tagline { - font-size: 1.25rem; - color: var(--pst-color-text-muted); - margin: 1rem 0 2rem; -} - -/* Feature cards β€” subtle lift on hover */ -.sd-card { - transition: transform 0.2s ease, box-shadow 0.2s ease; -} -.sd-card:hover { - transform: translateY(-2px); - box-shadow: 0 4px 12px rgba(0,0,0,0.1); -} - -/* Card links β€” no underline */ -.sd-card a { - text-decoration: none; +/* Keep the navigation consistent with the main PINA documentation. */ +.nav-link.nav-external::after { + display: none; } -/* Hero buttons β€” always white text */ -.hero .btn { - color: #fff !important; -} -.hero .btn:hover { - color: #fff !important; +.bd-content .toctree-wrapper > ul { + padding-left: 1.25rem; } -/* Hide external-link icons in navigation tabs only. */ -.nav-link.nav-external::after { - display: none; +.bd-content .toctree-wrapper li { + margin: 0.5rem 0; } diff --git a/docs/source/_templates/external-nav.html b/docs/source/_templates/external-nav.html new file mode 100644 index 0000000..8aeeab1 --- /dev/null +++ b/docs/source/_templates/external-nav.html @@ -0,0 +1,7 @@ + diff --git a/docs/source/_templates/global-sidebar-nav.html b/docs/source/_templates/global-sidebar-nav.html new file mode 100644 index 0000000..1fca78a --- /dev/null +++ b/docs/source/_templates/global-sidebar-nav.html @@ -0,0 +1,14 @@ + diff --git a/docs/source/conf.py b/docs/source/conf.py index 52e5a08..ab70e4e 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -36,13 +36,15 @@ "sphinx.ext.coverage", "sphinx.ext.viewcode", "sphinx.ext.mathjax", - "sphinx.ext.intersphinx", + "sphinx_design", + "nbsphinx", + "nbsphinx_link", ] # 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", "docstrings", "nextgen", "Thumbs.db", ".DS_Store", "**/.gitkeep"] +exclude_patterns = ["build", "docstrings", "nextgen", "Thumbs.db", ".DS_Store", "**/.gitkeep", "guides/*/index.rst"] # The reST default role (used for this markup: `text`) to use for all documents. default_role = "literal" @@ -66,7 +68,10 @@ templates_path = ["_templates"] # The suffix(es) of source filenames. -source_suffix = ".rst" +source_suffix = { + '.rst': 'restructuredtext', + '.ipynb': 'jupyter_notebook', +} # The master toctree document. master_doc = "index" @@ -165,8 +170,13 @@ "type": "fontawesome", }, ], - "show_prev_next": False, + "show_prev_next": True, + "collapse_navigation": False, + "navigation_depth": 2, + "show_nav_level": 1, + "sidebar_includehidden": True, "navbar_start": ["navbar-logo"], + "navbar_center": ["external-nav"], "navbar_end": ["navbar-icon-links"], "header_links_before_dropdown": 5, } @@ -191,16 +201,13 @@ # Output file base name for HTML help builder. htmlhelp_basename = "pinatutorialsdoc" -# Link to external html files -html_extra_path = ["tutorials"] +# Tutorial pages are Sphinx sources, not files to copy verbatim. +html_extra_path = [] html_static_path = ["_static"] html_css_files = ["custom.css"] -# Avoid side bar for html files -html_sidebars = { - "index": [], -} +html_sidebars = {"**": ["sidebar-collapse", "global-sidebar-nav"]} # -- Options for LaTeX output --------------------------------------------- @@ -257,3 +264,14 @@ # Do consider meth ending with _ (needed for in-place methods of torch) strip_signature_backslash = True + +# -- nbsphinx configuration ------------------------------------------------ + +# Render outputs already saved in the notebooks without executing them. +nbsphinx_execute = "never" + +# Custom CSS for notebooks +nbsphinx_codecell_lexer = "python3" + +# Show link to source notebook +nbsphinx_show_notebook_link = True diff --git a/docs/source/guides/getting-started/index.rst b/docs/source/guides/getting-started/index.rst new file mode 100644 index 0000000..c04f616 --- /dev/null +++ b/docs/source/guides/getting-started/index.rst @@ -0,0 +1,15 @@ +Getting Started with PINA +========================= + +Learn the core components of PINA. + +.. toctree:: + :maxdepth: 1 + + tutorial17 + tutorial16 + tutorial18 + tutorial11 + tutorial19 + tutorial6 + tutorial12 diff --git a/docs/source/guides/getting-started/tutorial11.nblink b/docs/source/guides/getting-started/tutorial11.nblink new file mode 100644 index 0000000..d660570 --- /dev/null +++ b/docs/source/guides/getting-started/tutorial11.nblink @@ -0,0 +1 @@ +{"path":"../../../../tutorials/00-getting-started/tutorial11/tutorial.ipynb"} diff --git a/docs/source/guides/getting-started/tutorial12.nblink b/docs/source/guides/getting-started/tutorial12.nblink new file mode 100644 index 0000000..2bb5fe8 --- /dev/null +++ b/docs/source/guides/getting-started/tutorial12.nblink @@ -0,0 +1 @@ +{"path":"../../../../tutorials/00-getting-started/tutorial12/tutorial.ipynb"} diff --git a/docs/source/guides/getting-started/tutorial16.nblink b/docs/source/guides/getting-started/tutorial16.nblink new file mode 100644 index 0000000..e49ef48 --- /dev/null +++ b/docs/source/guides/getting-started/tutorial16.nblink @@ -0,0 +1 @@ +{"path":"../../../../tutorials/00-getting-started/tutorial16/tutorial.ipynb"} diff --git a/docs/source/guides/getting-started/tutorial17.nblink b/docs/source/guides/getting-started/tutorial17.nblink new file mode 100644 index 0000000..89760c4 --- /dev/null +++ b/docs/source/guides/getting-started/tutorial17.nblink @@ -0,0 +1 @@ +{"path":"../../../../tutorials/00-getting-started/tutorial17/tutorial.ipynb"} diff --git a/docs/source/guides/getting-started/tutorial18.nblink b/docs/source/guides/getting-started/tutorial18.nblink new file mode 100644 index 0000000..56e0b4e --- /dev/null +++ b/docs/source/guides/getting-started/tutorial18.nblink @@ -0,0 +1 @@ +{"path":"../../../../tutorials/00-getting-started/tutorial18/tutorial.ipynb"} diff --git a/docs/source/guides/getting-started/tutorial19.nblink b/docs/source/guides/getting-started/tutorial19.nblink new file mode 100644 index 0000000..2686885 --- /dev/null +++ b/docs/source/guides/getting-started/tutorial19.nblink @@ -0,0 +1 @@ +{"path":"../../../../tutorials/00-getting-started/tutorial19/tutorial.ipynb"} diff --git a/docs/source/guides/getting-started/tutorial6.nblink b/docs/source/guides/getting-started/tutorial6.nblink new file mode 100644 index 0000000..70608a1 --- /dev/null +++ b/docs/source/guides/getting-started/tutorial6.nblink @@ -0,0 +1 @@ +{"path":"../../../../tutorials/00-getting-started/tutorial6/tutorial.ipynb"} diff --git a/tutorials/tutorial5/Data_Darcy.mat b/docs/source/guides/neural-operators/Data_Darcy.mat similarity index 100% rename from tutorials/tutorial5/Data_Darcy.mat rename to docs/source/guides/neural-operators/Data_Darcy.mat diff --git a/tutorials/tutorial10/data/Data_KS.mat b/docs/source/guides/neural-operators/data/Data_KS.mat similarity index 100% rename from tutorials/tutorial10/data/Data_KS.mat rename to docs/source/guides/neural-operators/data/Data_KS.mat diff --git a/tutorials/tutorial10/data/Data_KS2.mat b/docs/source/guides/neural-operators/data/Data_KS2.mat similarity index 100% rename from tutorials/tutorial10/data/Data_KS2.mat rename to docs/source/guides/neural-operators/data/Data_KS2.mat diff --git a/tutorials/tutorial24/data/advection_input_testing.pt b/docs/source/guides/neural-operators/data/advection_input_testing.pt similarity index 100% rename from tutorials/tutorial24/data/advection_input_testing.pt rename to docs/source/guides/neural-operators/data/advection_input_testing.pt diff --git a/tutorials/tutorial24/data/advection_input_training.pt b/docs/source/guides/neural-operators/data/advection_input_training.pt similarity index 100% rename from tutorials/tutorial24/data/advection_input_training.pt rename to docs/source/guides/neural-operators/data/advection_input_training.pt diff --git a/tutorials/tutorial24/data/advection_output_testing.pt b/docs/source/guides/neural-operators/data/advection_output_testing.pt similarity index 100% rename from tutorials/tutorial24/data/advection_output_testing.pt rename to docs/source/guides/neural-operators/data/advection_output_testing.pt diff --git a/tutorials/tutorial24/data/advection_output_training.pt b/docs/source/guides/neural-operators/data/advection_output_training.pt similarity index 100% rename from tutorials/tutorial24/data/advection_output_training.pt rename to docs/source/guides/neural-operators/data/advection_output_training.pt diff --git a/docs/source/guides/neural-operators/index.rst b/docs/source/guides/neural-operators/index.rst new file mode 100644 index 0000000..ce2d7f4 --- /dev/null +++ b/docs/source/guides/neural-operators/index.rst @@ -0,0 +1,12 @@ +Neural Operator Learning +======================== + +Learn mappings between function spaces with neural operators. + +.. toctree:: + :maxdepth: 1 + + tutorial21 + tutorial5 + tutorial10 + tutorial24 diff --git a/docs/source/guides/neural-operators/tutorial10.nblink b/docs/source/guides/neural-operators/tutorial10.nblink new file mode 100644 index 0000000..0e2b392 --- /dev/null +++ b/docs/source/guides/neural-operators/tutorial10.nblink @@ -0,0 +1 @@ +{"path":"../../../../tutorials/02-neural-operators/tutorial10/tutorial.ipynb", "extra-media":["../../../../tutorials/02-neural-operators/tutorial10/data"]} diff --git a/docs/source/guides/neural-operators/tutorial21.nblink b/docs/source/guides/neural-operators/tutorial21.nblink new file mode 100644 index 0000000..408584a --- /dev/null +++ b/docs/source/guides/neural-operators/tutorial21.nblink @@ -0,0 +1 @@ +{"path":"../../../../tutorials/02-neural-operators/tutorial21/tutorial.ipynb"} diff --git a/docs/source/guides/neural-operators/tutorial24.nblink b/docs/source/guides/neural-operators/tutorial24.nblink new file mode 100644 index 0000000..7a98936 --- /dev/null +++ b/docs/source/guides/neural-operators/tutorial24.nblink @@ -0,0 +1 @@ +{"path":"../../../../tutorials/02-neural-operators/tutorial24/tutorial.ipynb", "extra-media":["../../../../tutorials/02-neural-operators/tutorial24/data"]} diff --git a/docs/source/guides/neural-operators/tutorial5.nblink b/docs/source/guides/neural-operators/tutorial5.nblink new file mode 100644 index 0000000..c419558 --- /dev/null +++ b/docs/source/guides/neural-operators/tutorial5.nblink @@ -0,0 +1 @@ +{"path":"../../../../tutorials/02-neural-operators/tutorial5/tutorial.ipynb", "extra-media":["../../../../tutorials/02-neural-operators/tutorial5/Data_Darcy.mat"]} diff --git a/tutorials/tutorial7/data/pinn_solution_0.5_0.5 b/docs/source/guides/pinns/data/pinn_solution_0.5_0.5 similarity index 100% rename from tutorials/tutorial7/data/pinn_solution_0.5_0.5 rename to docs/source/guides/pinns/data/pinn_solution_0.5_0.5 diff --git a/tutorials/tutorial7/data/pts_0.5_0.5 b/docs/source/guides/pinns/data/pts_0.5_0.5 similarity index 100% rename from tutorials/tutorial7/data/pts_0.5_0.5 rename to docs/source/guides/pinns/data/pts_0.5_0.5 diff --git a/docs/source/guides/pinns/index.rst b/docs/source/guides/pinns/index.rst new file mode 100644 index 0000000..9504ee3 --- /dev/null +++ b/docs/source/guides/pinns/index.rst @@ -0,0 +1,15 @@ +Physics Informed Neural Networks +================================ + +Solve forward and inverse problems with physics-informed neural networks. + +.. toctree:: + :maxdepth: 1 + + tutorial1 + tutorial2 + tutorial3 + tutorial9 + tutorial7 + tutorial13 + tutorial14 diff --git a/docs/source/guides/pinns/tutorial1.nblink b/docs/source/guides/pinns/tutorial1.nblink new file mode 100644 index 0000000..bf171b9 --- /dev/null +++ b/docs/source/guides/pinns/tutorial1.nblink @@ -0,0 +1 @@ +{"path":"../../../../tutorials/01-pinns/tutorial1/tutorial.ipynb"} diff --git a/docs/source/guides/pinns/tutorial13.nblink b/docs/source/guides/pinns/tutorial13.nblink new file mode 100644 index 0000000..ed5e0c9 --- /dev/null +++ b/docs/source/guides/pinns/tutorial13.nblink @@ -0,0 +1 @@ +{"path":"../../../../tutorials/01-pinns/tutorial13/tutorial.ipynb"} diff --git a/docs/source/guides/pinns/tutorial14.nblink b/docs/source/guides/pinns/tutorial14.nblink new file mode 100644 index 0000000..887dd4d --- /dev/null +++ b/docs/source/guides/pinns/tutorial14.nblink @@ -0,0 +1 @@ +{"path":"../../../../tutorials/01-pinns/tutorial14/tutorial.ipynb"} diff --git a/docs/source/guides/pinns/tutorial2.nblink b/docs/source/guides/pinns/tutorial2.nblink new file mode 100644 index 0000000..dff3683 --- /dev/null +++ b/docs/source/guides/pinns/tutorial2.nblink @@ -0,0 +1 @@ +{"path":"../../../../tutorials/01-pinns/tutorial2/tutorial.ipynb"} diff --git a/docs/source/guides/pinns/tutorial3.nblink b/docs/source/guides/pinns/tutorial3.nblink new file mode 100644 index 0000000..af0397e --- /dev/null +++ b/docs/source/guides/pinns/tutorial3.nblink @@ -0,0 +1 @@ +{"path":"../../../../tutorials/01-pinns/tutorial3/tutorial.ipynb"} diff --git a/docs/source/guides/pinns/tutorial7.nblink b/docs/source/guides/pinns/tutorial7.nblink new file mode 100644 index 0000000..8918dda --- /dev/null +++ b/docs/source/guides/pinns/tutorial7.nblink @@ -0,0 +1 @@ +{"path":"../../../../tutorials/01-pinns/tutorial7/tutorial.ipynb", "extra-media":["../../../../tutorials/01-pinns/tutorial7/data"]} diff --git a/docs/source/guides/pinns/tutorial9.nblink b/docs/source/guides/pinns/tutorial9.nblink new file mode 100644 index 0000000..25112a6 --- /dev/null +++ b/docs/source/guides/pinns/tutorial9.nblink @@ -0,0 +1 @@ +{"path":"../../../../tutorials/01-pinns/tutorial9/tutorial.ipynb"} diff --git a/tutorials/tutorial22/holed_poisson.pt b/docs/source/guides/supervised-learning/holed_poisson.pt similarity index 100% rename from tutorials/tutorial22/holed_poisson.pt rename to docs/source/guides/supervised-learning/holed_poisson.pt diff --git a/docs/source/guides/supervised-learning/index.rst b/docs/source/guides/supervised-learning/index.rst new file mode 100644 index 0000000..7436dbb --- /dev/null +++ b/docs/source/guides/supervised-learning/index.rst @@ -0,0 +1,14 @@ +Supervised Learning +=================== + +Explore data-driven models and reduced-order modeling. + +.. toctree:: + :maxdepth: 1 + + tutorial20 + tutorial15 + tutorial22 + tutorial23 + tutorial4 + tutorial8 diff --git a/docs/source/guides/supervised-learning/tutorial15.nblink b/docs/source/guides/supervised-learning/tutorial15.nblink new file mode 100644 index 0000000..006bf83 --- /dev/null +++ b/docs/source/guides/supervised-learning/tutorial15.nblink @@ -0,0 +1 @@ +{"path":"../../../../tutorials/03-supervised-learning/tutorial15/tutorial.ipynb"} diff --git a/docs/source/guides/supervised-learning/tutorial20.nblink b/docs/source/guides/supervised-learning/tutorial20.nblink new file mode 100644 index 0000000..7100c93 --- /dev/null +++ b/docs/source/guides/supervised-learning/tutorial20.nblink @@ -0,0 +1 @@ +{"path":"../../../../tutorials/03-supervised-learning/tutorial20/tutorial.ipynb"} diff --git a/docs/source/guides/supervised-learning/tutorial22.nblink b/docs/source/guides/supervised-learning/tutorial22.nblink new file mode 100644 index 0000000..c0327ab --- /dev/null +++ b/docs/source/guides/supervised-learning/tutorial22.nblink @@ -0,0 +1 @@ +{"path":"../../../../tutorials/03-supervised-learning/tutorial22/tutorial.ipynb", "extra-media":["../../../../tutorials/03-supervised-learning/tutorial22/holed_poisson.pt"]} diff --git a/docs/source/guides/supervised-learning/tutorial23.nblink b/docs/source/guides/supervised-learning/tutorial23.nblink new file mode 100644 index 0000000..abaf9ab --- /dev/null +++ b/docs/source/guides/supervised-learning/tutorial23.nblink @@ -0,0 +1 @@ +{"path":"../../../../tutorials/03-supervised-learning/tutorial23/tutorial.ipynb"} diff --git a/docs/source/guides/supervised-learning/tutorial4.nblink b/docs/source/guides/supervised-learning/tutorial4.nblink new file mode 100644 index 0000000..680f0c8 --- /dev/null +++ b/docs/source/guides/supervised-learning/tutorial4.nblink @@ -0,0 +1 @@ +{"path":"../../../../tutorials/03-supervised-learning/tutorial4/tutorial.ipynb"} diff --git a/docs/source/guides/supervised-learning/tutorial8.nblink b/docs/source/guides/supervised-learning/tutorial8.nblink new file mode 100644 index 0000000..e65465f --- /dev/null +++ b/docs/source/guides/supervised-learning/tutorial8.nblink @@ -0,0 +1 @@ +{"path":"../../../../tutorials/03-supervised-learning/tutorial8/tutorial.ipynb"} diff --git a/docs/source/index.rst b/docs/source/index.rst index 44e6b16..c6c8e7a 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -1,54 +1,50 @@ -Welcome to the PINA Tutorials -======================================== - -This site collects step-by-step tutorials to help you understand the principles and potential of **PINA**. -Whether you are just getting started or looking to deepen your understanding, these resources will guide you. - -For installation instructions and API documentation, visit the -`PINA documentation `_. - -Getting started with PINA ----------------------------------------- - -- `Introductory Tutorial: A Beginner's Guide to PINA `_ -- `How to build a Problem in PINA `_ -- `Introduction to Solver classes `_ -- `Introduction to Trainer class `_ -- `Data structure for SciML: Tensor, LabelTensor, Data and Graph `_ -- `Building domains with PINA's BaseDomain class `_ -- `Introduction to PINA Equation class `_ - -Physics Informed Neural Networks --------------------------------- - -- `Introductory Tutorial: Physics Informed Neural Networks with PINA `_ -- `Enhancing PINNs with Extra Features to solve the Poisson Problem `_ -- `Applying Hard Constraints in PINNs to solve the Wave Problem `_ -- `Applying Periodic Boundary Conditions in PINNs to solve the Helmholtz Problem `_ -- `Inverse Problem Solving with Physics-Informed Neural Network `_ -- `Learning Multiscale PDEs Using Fourier Feature Networks `_ -- `Learning Bifurcating PDE Solutions with Physics-Informed Deep Ensembles `_ - -Neural Operator Learning ----------------------------------------- - -- `Introductory Tutorial: Neural Operator Learning with PINA `_ -- `Modeling 2D Darcy Flow with the Fourier Neural Operator `_ -- `Solving the Kuramoto-Sivashinsky Equation with Averaging Neural Operator `_ -- `Advection Equation with data driven DeepONet `_ - -Supervised Learning -------------------- - -- `Introductory Tutorial: Supervised Learning with PINA `_ -- `Chemical Properties Prediction with Graph Neural Networks `_ -- `Reduced Order Model with Graph Neural Networks for Unstructured Domains `_ -- `Data-driven System Identification with SINDy `_ -- `Unstructured Convolutional Autoencoders with Continuous Convolution `_ -- `Reduced Order Modeling with POD-RBF and POD-NN Approaches for Fluid Dynamics `_ - -See Also --------- - -- `Quickstart guide `_ -- `API Reference `_ +PINA Tutorials +============== + +Explore scientific machine learning with PINA, from the fundamentals to +physics-informed neural networks, neural operators, and data-driven models. +For installation and API reference, visit the `PINA documentation `_. + +.. toctree:: + :maxdepth: 2 + :caption: Getting Started with PINA + + guides/getting-started/tutorial17 + guides/getting-started/tutorial16 + guides/getting-started/tutorial18 + guides/getting-started/tutorial11 + guides/getting-started/tutorial19 + guides/getting-started/tutorial6 + guides/getting-started/tutorial12 + +.. toctree:: + :maxdepth: 2 + :caption: Physics Informed Neural Networks + + guides/pinns/tutorial1 + guides/pinns/tutorial2 + guides/pinns/tutorial3 + guides/pinns/tutorial9 + guides/pinns/tutorial7 + guides/pinns/tutorial13 + guides/pinns/tutorial14 + +.. toctree:: + :maxdepth: 2 + :caption: Neural Operator Learning + + guides/neural-operators/tutorial21 + guides/neural-operators/tutorial5 + guides/neural-operators/tutorial10 + guides/neural-operators/tutorial24 + +.. toctree:: + :maxdepth: 2 + :caption: Supervised Learning + + guides/supervised-learning/tutorial20 + guides/supervised-learning/tutorial15 + guides/supervised-learning/tutorial22 + guides/supervised-learning/tutorial23 + guides/supervised-learning/tutorial4 + guides/supervised-learning/tutorial8 diff --git a/docs/source/tutorials/.gitkeep b/docs/source/tutorials/.gitkeep deleted file mode 100644 index e69de29..0000000 diff --git a/docs/source/tutorials/tutorial1/tutorial.html b/docs/source/tutorials/tutorial1/tutorial.html deleted file mode 100644 index fef953e..0000000 --- a/docs/source/tutorials/tutorial1/tutorial.html +++ /dev/null @@ -1,8438 +0,0 @@ - - - - - -tutorial - - - - - - - - - - - - -
- - - - - - - - - - - - - - - -
- - - diff --git a/docs/source/tutorials/tutorial10/tutorial.html b/docs/source/tutorials/tutorial10/tutorial.html deleted file mode 100644 index a4a5a9b..0000000 --- a/docs/source/tutorials/tutorial10/tutorial.html +++ /dev/null @@ -1,8362 +0,0 @@ - - - - - -tutorial - - - - - - - - - - - - -
- - - - - - - - - -
- - - diff --git a/docs/source/tutorials/tutorial11/tutorial.html b/docs/source/tutorials/tutorial11/tutorial.html deleted file mode 100644 index a726f6b..0000000 --- a/docs/source/tutorials/tutorial11/tutorial.html +++ /dev/null @@ -1,8938 +0,0 @@ - - - - - -tutorial - - - - - - - - - - - - -
- - - - - - - - - - - - - - - - - -
- - - diff --git a/docs/source/tutorials/tutorial12/tutorial.html b/docs/source/tutorials/tutorial12/tutorial.html deleted file mode 100644 index 8460c25..0000000 --- a/docs/source/tutorials/tutorial12/tutorial.html +++ /dev/null @@ -1,8088 +0,0 @@ - - - - - -tutorial - - - - - - - - - - - - -
- - - - - - -
- - diff --git a/docs/source/tutorials/tutorial13/tutorial.html b/docs/source/tutorials/tutorial13/tutorial.html deleted file mode 100644 index fc26591..0000000 --- a/docs/source/tutorials/tutorial13/tutorial.html +++ /dev/null @@ -1,8447 +0,0 @@ - - - - - -tutorial - - - - - - - - - - - - -
- - - - - - - - -
- - - diff --git a/docs/source/tutorials/tutorial14/tutorial.html b/docs/source/tutorials/tutorial14/tutorial.html deleted file mode 100644 index 2467970..0000000 --- a/docs/source/tutorials/tutorial14/tutorial.html +++ /dev/null @@ -1,8311 +0,0 @@ - - - - - -tutorial - - - - - - - - - - - - -
- - - - - - - - -
- - - diff --git a/docs/source/tutorials/tutorial15/tutorial.html b/docs/source/tutorials/tutorial15/tutorial.html deleted file mode 100644 index b85ebea..0000000 --- a/docs/source/tutorials/tutorial15/tutorial.html +++ /dev/null @@ -1,8689 +0,0 @@ - - - - - -tutorial - - - - - - - - - - - - -
- - - - - - - - - - - - - -
- - - diff --git a/docs/source/tutorials/tutorial16/tutorial.html b/docs/source/tutorials/tutorial16/tutorial.html deleted file mode 100644 index 021c13a..0000000 --- a/docs/source/tutorials/tutorial16/tutorial.html +++ /dev/null @@ -1,8440 +0,0 @@ - - - - - -tutorial - - - - - - - - - - - - -
- - - - - - - - - - - - - - - - - -
- - diff --git a/docs/source/tutorials/tutorial17/tutorial.html b/docs/source/tutorials/tutorial17/tutorial.html deleted file mode 100644 index 0ad7609..0000000 --- a/docs/source/tutorials/tutorial17/tutorial.html +++ /dev/null @@ -1,8762 +0,0 @@ - - - - - -tutorial - - - - - - - - - - - - -
- - - - - - - - - - - - - - -
- - - diff --git a/docs/source/tutorials/tutorial18/tutorial.html b/docs/source/tutorials/tutorial18/tutorial.html deleted file mode 100644 index 8b0ca8d..0000000 --- a/docs/source/tutorials/tutorial18/tutorial.html +++ /dev/null @@ -1,8214 +0,0 @@ - - - - - -tutorial - - - - - - - - - - - - -
- - - - - - -
- - - diff --git a/docs/source/tutorials/tutorial19/tutorial.html b/docs/source/tutorials/tutorial19/tutorial.html deleted file mode 100644 index 743eea6..0000000 --- a/docs/source/tutorials/tutorial19/tutorial.html +++ /dev/null @@ -1,8532 +0,0 @@ - - - - - -tutorial - - - - - - - - - - - - -
- - - - - - - - - - - - - - - - -
- - diff --git a/docs/source/tutorials/tutorial2/tutorial.html b/docs/source/tutorials/tutorial2/tutorial.html deleted file mode 100644 index 3e4207a..0000000 --- a/docs/source/tutorials/tutorial2/tutorial.html +++ /dev/null @@ -1,8761 +0,0 @@ - - - - - -tutorial - - - - - - - - - - - - -
- - - - - - - - - - - - - - - - - -
- - - diff --git a/docs/source/tutorials/tutorial20/tutorial.html b/docs/source/tutorials/tutorial20/tutorial.html deleted file mode 100644 index a2daafd..0000000 --- a/docs/source/tutorials/tutorial20/tutorial.html +++ /dev/null @@ -1,8329 +0,0 @@ - - - - - -tutorial - - - - - - - - - - - - -
- - - - - - - - -
- - - diff --git a/docs/source/tutorials/tutorial21/tutorial.html b/docs/source/tutorials/tutorial21/tutorial.html deleted file mode 100644 index 4a80567..0000000 --- a/docs/source/tutorials/tutorial21/tutorial.html +++ /dev/null @@ -1,8317 +0,0 @@ - - - - - -tutorial - - - - - - - - - - - - -
- - - - - - -
- - - diff --git a/docs/source/tutorials/tutorial22/tutorial.html b/docs/source/tutorials/tutorial22/tutorial.html deleted file mode 100644 index f446481..0000000 --- a/docs/source/tutorials/tutorial22/tutorial.html +++ /dev/null @@ -1,15401 +0,0 @@ - - - - - -tutorial - - - - - - - - - - - - -
- - - - - - - - - - - - - - - - - - -
- - - diff --git a/docs/source/tutorials/tutorial23/tutorial.html b/docs/source/tutorials/tutorial23/tutorial.html deleted file mode 100644 index 1b9f497..0000000 --- a/docs/source/tutorials/tutorial23/tutorial.html +++ /dev/null @@ -1,10078 +0,0 @@ - - - - - -tutorial - - - - - - - - - - - - -
- - - - - - - - - - - -
- - - diff --git a/docs/source/tutorials/tutorial24/tutorial.html b/docs/source/tutorials/tutorial24/tutorial.html deleted file mode 100644 index ba0002a..0000000 --- a/docs/source/tutorials/tutorial24/tutorial.html +++ /dev/null @@ -1,8413 +0,0 @@ - - - - - -tutorial - - - - - - - - - - - - -
- - - - - - - - - - - -
- - - diff --git a/docs/source/tutorials/tutorial3/tutorial.html b/docs/source/tutorials/tutorial3/tutorial.html deleted file mode 100644 index 1b46c98..0000000 --- a/docs/source/tutorials/tutorial3/tutorial.html +++ /dev/null @@ -1,8516 +0,0 @@ - - - - - -tutorial - - - - - - - - - - - - -
- - - - - - - - - - - - -
- - - diff --git a/docs/source/tutorials/tutorial4/tutorial.html b/docs/source/tutorials/tutorial4/tutorial.html deleted file mode 100644 index 8ff6adb..0000000 --- a/docs/source/tutorials/tutorial4/tutorial.html +++ /dev/null @@ -1,9147 +0,0 @@ - - - - - -tutorial - - - - - - - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - -
- - - diff --git a/docs/source/tutorials/tutorial5/tutorial.html b/docs/source/tutorials/tutorial5/tutorial.html deleted file mode 100644 index 6783b21..0000000 --- a/docs/source/tutorials/tutorial5/tutorial.html +++ /dev/null @@ -1,8345 +0,0 @@ - - - - - -tutorial - - - - - - - - - - - - -
- - - - - - - - - - -
- - - diff --git a/docs/source/tutorials/tutorial6/tutorial.html b/docs/source/tutorials/tutorial6/tutorial.html deleted file mode 100644 index 315c31c..0000000 --- a/docs/source/tutorials/tutorial6/tutorial.html +++ /dev/null @@ -1,8587 +0,0 @@ - - - - - -tutorial - - - - - - - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - -
- - diff --git a/docs/source/tutorials/tutorial7/tutorial.html b/docs/source/tutorials/tutorial7/tutorial.html deleted file mode 100644 index 28704ae..0000000 --- a/docs/source/tutorials/tutorial7/tutorial.html +++ /dev/null @@ -1,8345 +0,0 @@ - - - - - -tutorial - - - - - - - - - - - - -
- - - - - - - - - - -
- - - diff --git a/docs/source/tutorials/tutorial8/tutorial.html b/docs/source/tutorials/tutorial8/tutorial.html deleted file mode 100644 index 587cab1..0000000 --- a/docs/source/tutorials/tutorial8/tutorial.html +++ /dev/null @@ -1,8455 +0,0 @@ - - - - - -tutorial - - - - - - - - - - - - -
- - - - - - - - - - - - - -
- - - diff --git a/docs/source/tutorials/tutorial9/tutorial.html b/docs/source/tutorials/tutorial9/tutorial.html deleted file mode 100644 index 70b657e..0000000 --- a/docs/source/tutorials/tutorial9/tutorial.html +++ /dev/null @@ -1,8271 +0,0 @@ - - - - - -tutorial - - - - - - - - - - - - -
- - - - - - - -
- - - diff --git a/pyproject.toml b/pyproject.toml index 6a1259c..493e2eb 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -45,6 +45,9 @@ exporter = [ docs = [ "sphinx", "pydata-sphinx-theme", + "sphinx-design", + "nbsphinx-link", + "ipykernel", ] [tool.black] diff --git a/tutorials/tutorial11/tutorial.ipynb b/tutorials/00-getting-started/tutorial11/tutorial.ipynb similarity index 100% rename from tutorials/tutorial11/tutorial.ipynb rename to tutorials/00-getting-started/tutorial11/tutorial.ipynb diff --git a/tutorials/tutorial11/tutorial.py b/tutorials/00-getting-started/tutorial11/tutorial.py similarity index 100% rename from tutorials/tutorial11/tutorial.py rename to tutorials/00-getting-started/tutorial11/tutorial.py diff --git a/tutorials/tutorial12/tutorial.ipynb b/tutorials/00-getting-started/tutorial12/tutorial.ipynb similarity index 100% rename from tutorials/tutorial12/tutorial.ipynb rename to tutorials/00-getting-started/tutorial12/tutorial.ipynb diff --git a/tutorials/tutorial12/tutorial.py b/tutorials/00-getting-started/tutorial12/tutorial.py similarity index 100% rename from tutorials/tutorial12/tutorial.py rename to tutorials/00-getting-started/tutorial12/tutorial.py diff --git a/tutorials/tutorial16/tutorial.ipynb b/tutorials/00-getting-started/tutorial16/tutorial.ipynb similarity index 100% rename from tutorials/tutorial16/tutorial.ipynb rename to tutorials/00-getting-started/tutorial16/tutorial.ipynb diff --git a/tutorials/tutorial16/tutorial.py b/tutorials/00-getting-started/tutorial16/tutorial.py similarity index 100% rename from tutorials/tutorial16/tutorial.py rename to tutorials/00-getting-started/tutorial16/tutorial.py diff --git a/tutorials/tutorial17/tutorial.ipynb b/tutorials/00-getting-started/tutorial17/tutorial.ipynb similarity index 99% rename from tutorials/tutorial17/tutorial.ipynb rename to tutorials/00-getting-started/tutorial17/tutorial.ipynb index 3e3ea68..fbfe57b 100644 --- a/tutorials/tutorial17/tutorial.ipynb +++ b/tutorials/00-getting-started/tutorial17/tutorial.ipynb @@ -125,7 +125,7 @@ "id": "7b91de38", "metadata": {}, "source": [ - "#### ***Problem & Data***\n", + "### ***Problem & Data***\n", "\n", "We'll start by defining a `BayesianProblem` inheriting from `BaseProblem` to handle input/output data. This is suitable when data is available. For other cases like PDEs without data, use:\n", "\n", @@ -210,12 +210,12 @@ "id": "98cba096", "metadata": {}, "source": [ - "#### ***Model Design***\n", + "### ***Model Design***\n", "\n", "We will now solve the problem using a **simple PyTorch Neural Network** with **Dropout**, which we will implement from scratch following [2]. \n", "It's important to note that PINA provides a wide range of **state-of-the-art (SOTA)** architectures in the `pina.model` module, which you can explore further [here](https://PINA-org.github.io/PINA/_rst/_code.html#models).\n", "\n", - "#### ***Solver Selection***\n", + "### ***Solver Selection***\n", "\n", "For this task, we will use a straightforward **supervised learning** approach by importing the `SupervisedSingleModelSolver` from `pina.solver`. The solver is responsible for defining the training strategy. \n", "\n", @@ -229,7 +229,7 @@ "\\mathcal{L}(v) = \\| v \\|^2_2.\n", "$$\n", "\n", - "#### **Training**\n", + "### **Training**\n", "\n", "Next, we will use the `Trainer` class to train the model. The `Trainer` class, based on **PyTorch Lightning**, offers many features that help:\n", "- **Improve model accuracy**\n", @@ -283,7 +283,7 @@ "id": "5bf9b0d5", "metadata": {}, "source": [ - "#### ***Model Training Complete! Now Visualize the Solutions***\n", + "### ***Model Training Complete! Now Visualize the Solutions***\n", "\n", "The model has been trained! Since we used **Dropout** during training, the model is probabilistic (Bayesian) [3]. This means that each time we evaluate the forward pass on the input points $x_i$, the results will differ due to the stochastic nature of Dropout.\n", "\n", diff --git a/tutorials/tutorial17/tutorial.py b/tutorials/00-getting-started/tutorial17/tutorial.py similarity index 99% rename from tutorials/tutorial17/tutorial.py rename to tutorials/00-getting-started/tutorial17/tutorial.py index c540402..3c42836 100644 --- a/tutorials/tutorial17/tutorial.py +++ b/tutorials/00-getting-started/tutorial17/tutorial.py @@ -105,7 +105,7 @@ from pina.domain import EllipsoidDomain, Difference, CartesianDomain, Union -# #### ***Problem & Data*** +# ### ***Problem & Data*** # # We'll start by defining a `BayesianProblem` inheriting from `BaseProblem` to handle input/output data. This is suitable when data is available. For other cases like PDEs without data, use: # @@ -170,12 +170,12 @@ class BayesianProblem(BaseProblem): print(f"Similarly to: \n {label_tensor[:, 0]=}") -# #### ***Model Design*** +# ### ***Model Design*** # # We will now solve the problem using a **simple PyTorch Neural Network** with **Dropout**, which we will implement from scratch following [2]. # It's important to note that PINA provides a wide range of **state-of-the-art (SOTA)** architectures in the `pina.model` module, which you can explore further [here](https://PINA-org.github.io/PINA/_rst/_code.html#models). # -# #### ***Solver Selection*** +# ### ***Solver Selection*** # # For this task, we will use a straightforward **supervised learning** approach by importing the `SupervisedSingleModelSolver` from `pina.solver`. The solver is responsible for defining the training strategy. # @@ -189,7 +189,7 @@ class BayesianProblem(BaseProblem): # \mathcal{L}(v) = \| v \|^2_2. # $$ # -# #### **Training** +# ### **Training** # # Next, we will use the `Trainer` class to train the model. The `Trainer` class, based on **PyTorch Lightning**, offers many features that help: # - **Improve model accuracy** @@ -233,7 +233,7 @@ def forward(self, x): trainer.train() -# #### ***Model Training Complete! Now Visualize the Solutions*** +# ### ***Model Training Complete! Now Visualize the Solutions*** # # The model has been trained! Since we used **Dropout** during training, the model is probabilistic (Bayesian) [3]. This means that each time we evaluate the forward pass on the input points $x_i$, the results will differ due to the stochastic nature of Dropout. # diff --git a/tutorials/tutorial18/tutorial.ipynb b/tutorials/00-getting-started/tutorial18/tutorial.ipynb similarity index 100% rename from tutorials/tutorial18/tutorial.ipynb rename to tutorials/00-getting-started/tutorial18/tutorial.ipynb diff --git a/tutorials/tutorial18/tutorial.py b/tutorials/00-getting-started/tutorial18/tutorial.py similarity index 100% rename from tutorials/tutorial18/tutorial.py rename to tutorials/00-getting-started/tutorial18/tutorial.py diff --git a/tutorials/tutorial19/tutorial.ipynb b/tutorials/00-getting-started/tutorial19/tutorial.ipynb similarity index 99% rename from tutorials/tutorial19/tutorial.ipynb rename to tutorials/00-getting-started/tutorial19/tutorial.ipynb index 11e279c..4a1a340 100644 --- a/tutorials/tutorial19/tutorial.ipynb +++ b/tutorials/00-getting-started/tutorial19/tutorial.ipynb @@ -421,7 +421,7 @@ "id": "7a2ef072", "metadata": {}, "source": [ - "In PINA Conditions, you always need to pass a list of `Graph` or `Data`, see [here]() for details. In case you are loading a PyG dataset remember to put it in this format!" + "In PINA Conditions, you always need to pass a list of `Graph` or `Data`. In case you are loading a PyG dataset remember to put it in this format!" ] }, { diff --git a/tutorials/tutorial19/tutorial.py b/tutorials/00-getting-started/tutorial19/tutorial.py similarity index 98% rename from tutorials/tutorial19/tutorial.py rename to tutorials/00-getting-started/tutorial19/tutorial.py index 62fcc0a..07b9cd6 100644 --- a/tutorials/tutorial19/tutorial.py +++ b/tutorials/00-getting-started/tutorial19/tutorial.py @@ -281,7 +281,7 @@ print(data.extract(attr="x", labels=["a"])) # here we extract 1 feature -# In PINA Conditions, you always need to pass a list of `Graph` or `Data`, see [here]() for details. In case you are loading a PyG dataset remember to put it in this format! +# In PINA Conditions, you always need to pass a list of `Graph` or `Data`. In case you are loading a PyG dataset remember to put it in this format! # In[ ]: diff --git a/tutorials/tutorial6/tutorial.ipynb b/tutorials/00-getting-started/tutorial6/tutorial.ipynb similarity index 100% rename from tutorials/tutorial6/tutorial.ipynb rename to tutorials/00-getting-started/tutorial6/tutorial.ipynb diff --git a/tutorials/tutorial6/tutorial.py b/tutorials/00-getting-started/tutorial6/tutorial.py similarity index 100% rename from tutorials/tutorial6/tutorial.py rename to tutorials/00-getting-started/tutorial6/tutorial.py diff --git a/tutorials/tutorial1/tutorial.ipynb b/tutorials/01-pinns/tutorial1/tutorial.ipynb similarity index 100% rename from tutorials/tutorial1/tutorial.ipynb rename to tutorials/01-pinns/tutorial1/tutorial.ipynb diff --git a/tutorials/tutorial1/tutorial.py b/tutorials/01-pinns/tutorial1/tutorial.py similarity index 100% rename from tutorials/tutorial1/tutorial.py rename to tutorials/01-pinns/tutorial1/tutorial.py diff --git a/tutorials/tutorial13/tutorial.ipynb b/tutorials/01-pinns/tutorial13/tutorial.ipynb similarity index 100% rename from tutorials/tutorial13/tutorial.ipynb rename to tutorials/01-pinns/tutorial13/tutorial.ipynb diff --git a/tutorials/tutorial13/tutorial.py b/tutorials/01-pinns/tutorial13/tutorial.py similarity index 100% rename from tutorials/tutorial13/tutorial.py rename to tutorials/01-pinns/tutorial13/tutorial.py diff --git a/tutorials/tutorial14/tutorial.ipynb b/tutorials/01-pinns/tutorial14/tutorial.ipynb similarity index 100% rename from tutorials/tutorial14/tutorial.ipynb rename to tutorials/01-pinns/tutorial14/tutorial.ipynb diff --git a/tutorials/tutorial14/tutorial.py b/tutorials/01-pinns/tutorial14/tutorial.py similarity index 100% rename from tutorials/tutorial14/tutorial.py rename to tutorials/01-pinns/tutorial14/tutorial.py diff --git a/tutorials/tutorial2/tutorial.ipynb b/tutorials/01-pinns/tutorial2/tutorial.ipynb similarity index 100% rename from tutorials/tutorial2/tutorial.ipynb rename to tutorials/01-pinns/tutorial2/tutorial.ipynb diff --git a/tutorials/tutorial2/tutorial.py b/tutorials/01-pinns/tutorial2/tutorial.py similarity index 100% rename from tutorials/tutorial2/tutorial.py rename to tutorials/01-pinns/tutorial2/tutorial.py diff --git a/tutorials/tutorial3/tutorial.ipynb b/tutorials/01-pinns/tutorial3/tutorial.ipynb similarity index 100% rename from tutorials/tutorial3/tutorial.ipynb rename to tutorials/01-pinns/tutorial3/tutorial.ipynb diff --git a/tutorials/tutorial3/tutorial.py b/tutorials/01-pinns/tutorial3/tutorial.py similarity index 100% rename from tutorials/tutorial3/tutorial.py rename to tutorials/01-pinns/tutorial3/tutorial.py diff --git a/tutorials/01-pinns/tutorial7/data/pinn_solution_0.5_0.5 b/tutorials/01-pinns/tutorial7/data/pinn_solution_0.5_0.5 new file mode 100644 index 0000000..d40bbb9 Binary files /dev/null and b/tutorials/01-pinns/tutorial7/data/pinn_solution_0.5_0.5 differ diff --git a/tutorials/01-pinns/tutorial7/data/pts_0.5_0.5 b/tutorials/01-pinns/tutorial7/data/pts_0.5_0.5 new file mode 100644 index 0000000..4279d7e Binary files /dev/null and b/tutorials/01-pinns/tutorial7/data/pts_0.5_0.5 differ diff --git a/tutorials/tutorial7/tutorial.ipynb b/tutorials/01-pinns/tutorial7/tutorial.ipynb similarity index 100% rename from tutorials/tutorial7/tutorial.ipynb rename to tutorials/01-pinns/tutorial7/tutorial.ipynb diff --git a/tutorials/tutorial7/tutorial.py b/tutorials/01-pinns/tutorial7/tutorial.py similarity index 100% rename from tutorials/tutorial7/tutorial.py rename to tutorials/01-pinns/tutorial7/tutorial.py diff --git a/tutorials/tutorial9/tutorial.ipynb b/tutorials/01-pinns/tutorial9/tutorial.ipynb similarity index 100% rename from tutorials/tutorial9/tutorial.ipynb rename to tutorials/01-pinns/tutorial9/tutorial.ipynb diff --git a/tutorials/tutorial9/tutorial.py b/tutorials/01-pinns/tutorial9/tutorial.py similarity index 100% rename from tutorials/tutorial9/tutorial.py rename to tutorials/01-pinns/tutorial9/tutorial.py diff --git a/tutorials/02-neural-operators/tutorial10/data/Data_KS.mat b/tutorials/02-neural-operators/tutorial10/data/Data_KS.mat new file mode 100644 index 0000000..08f724c Binary files /dev/null and b/tutorials/02-neural-operators/tutorial10/data/Data_KS.mat differ diff --git a/tutorials/02-neural-operators/tutorial10/data/Data_KS2.mat b/tutorials/02-neural-operators/tutorial10/data/Data_KS2.mat new file mode 100644 index 0000000..51c6134 Binary files /dev/null and b/tutorials/02-neural-operators/tutorial10/data/Data_KS2.mat differ diff --git a/tutorials/tutorial10/tutorial.ipynb b/tutorials/02-neural-operators/tutorial10/tutorial.ipynb similarity index 98% rename from tutorials/tutorial10/tutorial.ipynb rename to tutorials/02-neural-operators/tutorial10/tutorial.ipynb index 1ccdee5..7c314b5 100644 --- a/tutorials/tutorial10/tutorial.ipynb +++ b/tutorials/02-neural-operators/tutorial10/tutorial.ipynb @@ -378,7 +378,7 @@ "\n", "1. **Train the network for longer or with different layer sizes**: Experiment with various configurations, such as adjusting the number of layers or hidden dimensions, to further improve accuracy and observe the impact on performance.\n", "\n", - "2. **Use a more challenging dataset**: Try using the more complex dataset [Data_KS2.mat](dat/Data_KS2.mat) where $A_k \\in [-0.5, 0.5]$, $\\ell_k \\in [1, 2, 3]$, and $\\phi_k \\in [0, 2\\pi]$ for a more difficult task. This dataset may require longer training and testing.\n", + "2. **Use a more challenging dataset**: Try using the more complex dataset [Data_KS2.mat](data/Data_KS2.mat) where $A_k \\in [-0.5, 0.5]$, $\\ell_k \\in [1, 2, 3]$, and $\\phi_k \\in [0, 2\\pi]$ for a more difficult task. This dataset may require longer training and testing.\n", "\n", "3. **... and many more...**: Explore other models, such as the [FNO](https://PINA-org.github.io/PINA/_rst/models/fno.html), [DeepOnet](https://PINA-org.github.io/PINA/_rst/models/deeponet.html), or implement your own operator using the [KernelNeuralOperator](https://PINA-org.github.io/PINA/_rst/models/base_no.html) class to compare performance and find the best model for your task.\n", "\n", diff --git a/tutorials/tutorial10/tutorial.py b/tutorials/02-neural-operators/tutorial10/tutorial.py similarity index 98% rename from tutorials/tutorial10/tutorial.py rename to tutorials/02-neural-operators/tutorial10/tutorial.py index 15bfd38..d4c4877 100644 --- a/tutorials/tutorial10/tutorial.py +++ b/tutorials/02-neural-operators/tutorial10/tutorial.py @@ -298,7 +298,7 @@ def forward(self, x): # # 1. **Train the network for longer or with different layer sizes**: Experiment with various configurations, such as adjusting the number of layers or hidden dimensions, to further improve accuracy and observe the impact on performance. # -# 2. **Use a more challenging dataset**: Try using the more complex dataset [Data_KS2.mat](dat/Data_KS2.mat) where $A_k \in [-0.5, 0.5]$, $\ell_k \in [1, 2, 3]$, and $\phi_k \in [0, 2\pi]$ for a more difficult task. This dataset may require longer training and testing. +# 2. **Use a more challenging dataset**: Try using the more complex dataset [Data_KS2.mat](data/Data_KS2.mat) where $A_k \in [-0.5, 0.5]$, $\ell_k \in [1, 2, 3]$, and $\phi_k \in [0, 2\pi]$ for a more difficult task. This dataset may require longer training and testing. # # 3. **... and many more...**: Explore other models, such as the [FNO](https://PINA-org.github.io/PINA/_rst/models/fno.html), [DeepOnet](https://PINA-org.github.io/PINA/_rst/models/deeponet.html), or implement your own operator using the [KernelNeuralOperator](https://PINA-org.github.io/PINA/_rst/models/base_no.html) class to compare performance and find the best model for your task. # diff --git a/tutorials/tutorial21/tutorial.ipynb b/tutorials/02-neural-operators/tutorial21/tutorial.ipynb similarity index 100% rename from tutorials/tutorial21/tutorial.ipynb rename to tutorials/02-neural-operators/tutorial21/tutorial.ipynb diff --git a/tutorials/tutorial21/tutorial.py b/tutorials/02-neural-operators/tutorial21/tutorial.py similarity index 100% rename from tutorials/tutorial21/tutorial.py rename to tutorials/02-neural-operators/tutorial21/tutorial.py diff --git a/tutorials/02-neural-operators/tutorial24/data/advection_input_testing.pt b/tutorials/02-neural-operators/tutorial24/data/advection_input_testing.pt new file mode 100644 index 0000000..1273300 Binary files /dev/null and b/tutorials/02-neural-operators/tutorial24/data/advection_input_testing.pt differ diff --git a/tutorials/02-neural-operators/tutorial24/data/advection_input_training.pt b/tutorials/02-neural-operators/tutorial24/data/advection_input_training.pt new file mode 100644 index 0000000..b643278 Binary files /dev/null and b/tutorials/02-neural-operators/tutorial24/data/advection_input_training.pt differ diff --git a/tutorials/02-neural-operators/tutorial24/data/advection_output_testing.pt b/tutorials/02-neural-operators/tutorial24/data/advection_output_testing.pt new file mode 100644 index 0000000..2e9f16d Binary files /dev/null and b/tutorials/02-neural-operators/tutorial24/data/advection_output_testing.pt differ diff --git a/tutorials/02-neural-operators/tutorial24/data/advection_output_training.pt b/tutorials/02-neural-operators/tutorial24/data/advection_output_training.pt new file mode 100644 index 0000000..41d134b Binary files /dev/null and b/tutorials/02-neural-operators/tutorial24/data/advection_output_training.pt differ diff --git a/tutorials/tutorial24/tutorial.ipynb b/tutorials/02-neural-operators/tutorial24/tutorial.ipynb similarity index 100% rename from tutorials/tutorial24/tutorial.ipynb rename to tutorials/02-neural-operators/tutorial24/tutorial.ipynb diff --git a/tutorials/tutorial24/tutorial.py b/tutorials/02-neural-operators/tutorial24/tutorial.py similarity index 100% rename from tutorials/tutorial24/tutorial.py rename to tutorials/02-neural-operators/tutorial24/tutorial.py diff --git a/tutorials/02-neural-operators/tutorial5/Data_Darcy.mat b/tutorials/02-neural-operators/tutorial5/Data_Darcy.mat new file mode 100644 index 0000000..6b9a06d Binary files /dev/null and b/tutorials/02-neural-operators/tutorial5/Data_Darcy.mat differ diff --git a/tutorials/tutorial5/tutorial.ipynb b/tutorials/02-neural-operators/tutorial5/tutorial.ipynb similarity index 100% rename from tutorials/tutorial5/tutorial.ipynb rename to tutorials/02-neural-operators/tutorial5/tutorial.ipynb diff --git a/tutorials/tutorial5/tutorial.py b/tutorials/02-neural-operators/tutorial5/tutorial.py similarity index 100% rename from tutorials/tutorial5/tutorial.py rename to tutorials/02-neural-operators/tutorial5/tutorial.py diff --git a/tutorials/tutorial15/tutorial.ipynb b/tutorials/03-supervised-learning/tutorial15/tutorial.ipynb similarity index 100% rename from tutorials/tutorial15/tutorial.ipynb rename to tutorials/03-supervised-learning/tutorial15/tutorial.ipynb diff --git a/tutorials/tutorial15/tutorial.py b/tutorials/03-supervised-learning/tutorial15/tutorial.py similarity index 100% rename from tutorials/tutorial15/tutorial.py rename to tutorials/03-supervised-learning/tutorial15/tutorial.py diff --git a/tutorials/tutorial20/tutorial.ipynb b/tutorials/03-supervised-learning/tutorial20/tutorial.ipynb similarity index 100% rename from tutorials/tutorial20/tutorial.ipynb rename to tutorials/03-supervised-learning/tutorial20/tutorial.ipynb diff --git a/tutorials/tutorial20/tutorial.py b/tutorials/03-supervised-learning/tutorial20/tutorial.py similarity index 100% rename from tutorials/tutorial20/tutorial.py rename to tutorials/03-supervised-learning/tutorial20/tutorial.py diff --git a/tutorials/03-supervised-learning/tutorial22/holed_poisson.pt b/tutorials/03-supervised-learning/tutorial22/holed_poisson.pt new file mode 100644 index 0000000..c93129a Binary files /dev/null and b/tutorials/03-supervised-learning/tutorial22/holed_poisson.pt differ diff --git a/tutorials/tutorial22/tutorial.ipynb b/tutorials/03-supervised-learning/tutorial22/tutorial.ipynb similarity index 100% rename from tutorials/tutorial22/tutorial.ipynb rename to tutorials/03-supervised-learning/tutorial22/tutorial.ipynb diff --git a/tutorials/tutorial22/tutorial.py b/tutorials/03-supervised-learning/tutorial22/tutorial.py similarity index 100% rename from tutorials/tutorial22/tutorial.py rename to tutorials/03-supervised-learning/tutorial22/tutorial.py diff --git a/tutorials/tutorial23/tutorial.ipynb b/tutorials/03-supervised-learning/tutorial23/tutorial.ipynb similarity index 100% rename from tutorials/tutorial23/tutorial.ipynb rename to tutorials/03-supervised-learning/tutorial23/tutorial.ipynb diff --git a/tutorials/tutorial23/tutorial.py b/tutorials/03-supervised-learning/tutorial23/tutorial.py similarity index 100% rename from tutorials/tutorial23/tutorial.py rename to tutorials/03-supervised-learning/tutorial23/tutorial.py diff --git a/tutorials/tutorial4/tutorial.ipynb b/tutorials/03-supervised-learning/tutorial4/tutorial.ipynb similarity index 100% rename from tutorials/tutorial4/tutorial.ipynb rename to tutorials/03-supervised-learning/tutorial4/tutorial.ipynb diff --git a/tutorials/tutorial4/tutorial.py b/tutorials/03-supervised-learning/tutorial4/tutorial.py similarity index 100% rename from tutorials/tutorial4/tutorial.py rename to tutorials/03-supervised-learning/tutorial4/tutorial.py diff --git a/tutorials/tutorial8/tutorial.ipynb b/tutorials/03-supervised-learning/tutorial8/tutorial.ipynb similarity index 100% rename from tutorials/tutorial8/tutorial.ipynb rename to tutorials/03-supervised-learning/tutorial8/tutorial.ipynb diff --git a/tutorials/tutorial8/tutorial.py b/tutorials/03-supervised-learning/tutorial8/tutorial.py similarity index 100% rename from tutorials/tutorial8/tutorial.py rename to tutorials/03-supervised-learning/tutorial8/tutorial.py