Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Version 0.2 #312

Open
wants to merge 15 commits into
base: 0.2
Choose a base branch
from
2 changes: 1 addition & 1 deletion .github/workflows/monthly-tag.yml
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ jobs:
strategy:
matrix:
os: [windows-latest, macos-latest, ubuntu-latest]
python-version: [3.7, 3.8]
python-version: [3.8, 3.9, '3.10', '3.11', '3.12']
steps:
- uses: actions/checkout@v2
- name: Set up Python
Expand Down
28 changes: 27 additions & 1 deletion docs/source/_rst/_code.rst
Original file line number Diff line number Diff line change
Expand Up @@ -35,8 +35,14 @@ Solvers
:titlesonly:

SolverInterface <solvers/solver_interface.rst>
PINNInterface <solvers/basepinn.rst>
PINN <solvers/pinn.rst>
GPINN <solvers/gpinn.rst>
CausalPINN <solvers/causalpinn.rst>
CompetitivePINN <solvers/competitivepinn.rst>
SAPINN <solvers/sapinn.rst>
Supervised solver <solvers/supervised.rst>
ReducedOrderModelSolver <solvers/rom.rst>
GAROM <solvers/garom.rst>


Expand Down Expand Up @@ -74,7 +80,27 @@ Layers
Continuous convolution <layers/convolution.rst>
Proper Orthogonal Decomposition <layers/pod.rst>
Periodic Boundary Condition embeddings <layers/embedding.rst>
Adpative Activation Function <layers/adaptive_func.rst>

Adaptive Activation Functions
-------------------------------

.. toctree::
:titlesonly:

Adaptive Function Interface <adaptive_functions/AdaptiveFunctionInterface.rst>
Adaptive ReLU <adaptive_functions/AdaptiveReLU.rst>
Adaptive Sigmoid <adaptive_functions/AdaptiveSigmoid.rst>
Adaptive Tanh <adaptive_functions/AdaptiveTanh.rst>
Adaptive SiLU <adaptive_functions/AdaptiveSiLU.rst>
Adaptive Mish <adaptive_functions/AdaptiveMish.rst>
Adaptive ELU <adaptive_functions/AdaptiveELU.rst>
Adaptive CELU <adaptive_functions/AdaptiveCELU.rst>
Adaptive GELU <adaptive_functions/AdaptiveGELU.rst>
Adaptive Softmin <adaptive_functions/AdaptiveSoftmin.rst>
Adaptive Softmax <adaptive_functions/AdaptiveSoftmax.rst>
Adaptive SIREN <adaptive_functions/AdaptiveSIREN.rst>
Adaptive Exp <adaptive_functions/AdaptiveExp.rst>


Equations and Operators
-------------------------
Expand Down
2 changes: 2 additions & 0 deletions docs/source/_rst/_tutorial.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,9 +10,11 @@ Getting started with PINA
:titlesonly:

Introduction to PINA for Physics Informed Neural Networks training <tutorials/tutorial1/tutorial.rst>
Introduction to PINA Equation class <tutorials/tutorial12/tutorial.rst>
PINA and PyTorch Lightning, training tips and visualizations <tutorials/tutorial11/tutorial.rst>
Building custom geometries with PINA Location class <tutorials/tutorial6/tutorial.rst>


Physics Informed Neural Networks
--------------------------------
.. toctree::
Expand Down
9 changes: 9 additions & 0 deletions docs/source/_rst/adaptive_functions/AdaptiveCELU.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
AdaptiveCELU
============

.. currentmodule:: pina.adaptive_functions.adaptive_func

.. autoclass:: AdaptiveCELU
:members:
:show-inheritance:
:inherited-members: AdaptiveActivationFunctionInterface
9 changes: 9 additions & 0 deletions docs/source/_rst/adaptive_functions/AdaptiveELU.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
AdaptiveELU
===========

.. currentmodule:: pina.adaptive_functions.adaptive_func

.. autoclass:: AdaptiveELU
:members:
:show-inheritance:
:inherited-members: AdaptiveActivationFunctionInterface
9 changes: 9 additions & 0 deletions docs/source/_rst/adaptive_functions/AdaptiveExp.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
AdaptiveExp
===========

.. currentmodule:: pina.adaptive_functions.adaptive_func

.. autoclass:: AdaptiveExp
:members:
:show-inheritance:
:inherited-members: AdaptiveActivationFunctionInterface
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
AdaptiveActivationFunctionInterface
=======================================

.. currentmodule:: pina.adaptive_functions.adaptive_func_interface

.. automodule:: pina.adaptive_functions.adaptive_func_interface
:members:
:show-inheritance:
9 changes: 9 additions & 0 deletions docs/source/_rst/adaptive_functions/AdaptiveGELU.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
AdaptiveGELU
============

.. currentmodule:: pina.adaptive_functions.adaptive_func

.. autoclass:: AdaptiveGELU
:members:
:show-inheritance:
:inherited-members: AdaptiveActivationFunctionInterface
9 changes: 9 additions & 0 deletions docs/source/_rst/adaptive_functions/AdaptiveMish.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
AdaptiveMish
============

.. currentmodule:: pina.adaptive_functions.adaptive_func

.. autoclass:: AdaptiveMish
:members:
:show-inheritance:
:inherited-members: AdaptiveActivationFunctionInterface
9 changes: 9 additions & 0 deletions docs/source/_rst/adaptive_functions/AdaptiveReLU.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
AdaptiveReLU
============

.. currentmodule:: pina.adaptive_functions.adaptive_func

.. autoclass:: AdaptiveReLU
:members:
:show-inheritance:
:inherited-members: AdaptiveActivationFunctionInterface
9 changes: 9 additions & 0 deletions docs/source/_rst/adaptive_functions/AdaptiveSIREN.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
AdaptiveSIREN
=============

.. currentmodule:: pina.adaptive_functions.adaptive_func

.. autoclass:: AdaptiveSIREN
:members:
:show-inheritance:
:inherited-members: AdaptiveActivationFunctionInterface
9 changes: 9 additions & 0 deletions docs/source/_rst/adaptive_functions/AdaptiveSiLU.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
AdaptiveSiLU
============

.. currentmodule:: pina.adaptive_functions.adaptive_func

.. autoclass:: AdaptiveSiLU
:members:
:show-inheritance:
:inherited-members: AdaptiveActivationFunctionInterface
9 changes: 9 additions & 0 deletions docs/source/_rst/adaptive_functions/AdaptiveSigmoid.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
AdaptiveSigmoid
===============

.. currentmodule:: pina.adaptive_functions.adaptive_func

.. autoclass:: AdaptiveSigmoid
:members:
:show-inheritance:
:inherited-members: AdaptiveActivationFunctionInterface
9 changes: 9 additions & 0 deletions docs/source/_rst/adaptive_functions/AdaptiveSoftmax.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
AdaptiveSoftmax
===============

.. currentmodule:: pina.adaptive_functions.adaptive_func

.. autoclass:: AdaptiveSoftmax
:members:
:show-inheritance:
:inherited-members: AdaptiveActivationFunctionInterface
9 changes: 9 additions & 0 deletions docs/source/_rst/adaptive_functions/AdaptiveSoftmin.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
AdaptiveSoftmin
===============

.. currentmodule:: pina.adaptive_functions.adaptive_func

.. autoclass:: AdaptiveSoftmin
:members:
:show-inheritance:
:inherited-members: AdaptiveActivationFunctionInterface
9 changes: 9 additions & 0 deletions docs/source/_rst/adaptive_functions/AdaptiveTanh.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
AdaptiveTanh
============

.. currentmodule:: pina.adaptive_functions.adaptive_func

.. autoclass:: AdaptiveTanh
:members:
:show-inheritance:
:inherited-members: AdaptiveActivationFunctionInterface
7 changes: 0 additions & 7 deletions docs/source/_rst/layers/adaptive_func.rst

This file was deleted.

7 changes: 7 additions & 0 deletions docs/source/_rst/solvers/basepinn.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
PINNInterface
=================
.. currentmodule:: pina.solvers.pinns.basepinn

.. autoclass:: PINNInterface
:members:
:show-inheritance:
7 changes: 7 additions & 0 deletions docs/source/_rst/solvers/causalpinn.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
CausalPINN
==============
.. currentmodule:: pina.solvers.pinns.causalpinn

.. autoclass:: CausalPINN
:members:
:show-inheritance:
7 changes: 7 additions & 0 deletions docs/source/_rst/solvers/competitivepinn.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
CompetitivePINN
=================
.. currentmodule:: pina.solvers.pinns.competitive_pinn

.. autoclass:: CompetitivePINN
:members:
:show-inheritance:
7 changes: 7 additions & 0 deletions docs/source/_rst/solvers/gpinn.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
GPINN
======
.. currentmodule:: pina.solvers.pinns.gpinn

.. autoclass:: GPINN
:members:
:show-inheritance:
2 changes: 1 addition & 1 deletion docs/source/_rst/solvers/pinn.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
PINN
======
.. currentmodule:: pina.solvers.pinn
.. currentmodule:: pina.solvers.pinns.pinn

.. autoclass:: PINN
:members:
Expand Down
7 changes: 7 additions & 0 deletions docs/source/_rst/solvers/rom.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
ReducedOrderModelSolver
==========================
.. currentmodule:: pina.solvers.rom

.. autoclass:: ReducedOrderModelSolver
:members:
:show-inheritance:
7 changes: 7 additions & 0 deletions docs/source/_rst/solvers/sapinn.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
SAPINN
======
.. currentmodule:: pina.solvers.pinns.sapinn

.. autoclass:: SAPINN
:members:
:show-inheritance:
Loading
Loading