From d411543b760022319f208c1696e495045407f3f6 Mon Sep 17 00:00:00 2001 From: Dario Coscia Date: Thu, 13 Mar 2025 15:43:22 +0100 Subject: [PATCH] update rsts --- docs/source/_rst/_code.rst | 88 +++++++++++-------- .../_rst/adaptive_functions/AdaptiveCELU.rst | 9 -- .../_rst/adaptive_functions/AdaptiveELU.rst | 9 -- .../_rst/adaptive_functions/AdaptiveExp.rst | 9 -- .../AdaptiveFunctionInterface.rst | 8 -- .../_rst/adaptive_functions/AdaptiveGELU.rst | 9 -- .../_rst/adaptive_functions/AdaptiveMish.rst | 9 -- .../_rst/adaptive_functions/AdaptiveReLU.rst | 9 -- .../_rst/adaptive_functions/AdaptiveSIREN.rst | 9 -- .../_rst/adaptive_functions/AdaptiveSiLU.rst | 9 -- .../adaptive_functions/AdaptiveSigmoid.rst | 9 -- .../adaptive_functions/AdaptiveSoftmax.rst | 9 -- .../adaptive_functions/AdaptiveSoftmin.rst | 9 -- .../_rst/adaptive_functions/AdaptiveTanh.rst | 9 -- .../callback/adaptive_refinment_callbacks.rst | 7 ++ .../linear_weight_update_callback.rst | 7 ++ .../optimizer_callbacks.rst | 2 +- .../processing_callbacks.rst | 2 +- .../adaptive_refinment_callbacks.rst | 7 -- docs/source/_rst/condition.rst | 7 -- docs/source/_rst/condition/condition.rst | 7 ++ .../_rst/condition/condition_interface.rst | 7 ++ docs/source/_rst/condition/data_condition.rst | 15 ++++ .../condition/domain_equation_condition.rst | 7 ++ .../condition/input_equation_condition.rst | 15 ++++ .../_rst/condition/input_target_condition.rst | 23 +++++ docs/source/_rst/data/data_module.rst | 7 ++ docs/source/_rst/data/dataset.rst | 7 ++ .../_rst/{geometry => domain}/cartesian.rst | 4 +- .../difference_domain.rst | 4 +- docs/source/_rst/domain/domain.rst | 9 ++ .../_rst/{geometry => domain}/ellipsoid.rst | 4 +- .../{geometry => domain}/exclusion_domain.rst | 4 +- .../intersection_domain.rst | 4 +- .../operation_interface.rst | 4 +- .../_rst/{geometry => domain}/simplex.rst | 4 +- .../{geometry => domain}/union_domain.rst | 4 +- docs/source/_rst/geometry/location.rst | 9 -- docs/source/_tutorial.rst | 26 +++--- 39 files changed, 195 insertions(+), 205 deletions(-) delete mode 100644 docs/source/_rst/adaptive_functions/AdaptiveCELU.rst delete mode 100644 docs/source/_rst/adaptive_functions/AdaptiveELU.rst delete mode 100644 docs/source/_rst/adaptive_functions/AdaptiveExp.rst delete mode 100644 docs/source/_rst/adaptive_functions/AdaptiveFunctionInterface.rst delete mode 100644 docs/source/_rst/adaptive_functions/AdaptiveGELU.rst delete mode 100644 docs/source/_rst/adaptive_functions/AdaptiveMish.rst delete mode 100644 docs/source/_rst/adaptive_functions/AdaptiveReLU.rst delete mode 100644 docs/source/_rst/adaptive_functions/AdaptiveSIREN.rst delete mode 100644 docs/source/_rst/adaptive_functions/AdaptiveSiLU.rst delete mode 100644 docs/source/_rst/adaptive_functions/AdaptiveSigmoid.rst delete mode 100644 docs/source/_rst/adaptive_functions/AdaptiveSoftmax.rst delete mode 100644 docs/source/_rst/adaptive_functions/AdaptiveSoftmin.rst delete mode 100644 docs/source/_rst/adaptive_functions/AdaptiveTanh.rst create mode 100644 docs/source/_rst/callback/adaptive_refinment_callbacks.rst create mode 100644 docs/source/_rst/callback/linear_weight_update_callback.rst rename docs/source/_rst/{callbacks => callback}/optimizer_callbacks.rst (66%) rename docs/source/_rst/{callbacks => callback}/processing_callbacks.rst (76%) delete mode 100644 docs/source/_rst/callbacks/adaptive_refinment_callbacks.rst delete mode 100644 docs/source/_rst/condition.rst create mode 100644 docs/source/_rst/condition/condition.rst create mode 100644 docs/source/_rst/condition/condition_interface.rst create mode 100644 docs/source/_rst/condition/data_condition.rst create mode 100644 docs/source/_rst/condition/domain_equation_condition.rst create mode 100644 docs/source/_rst/condition/input_equation_condition.rst create mode 100644 docs/source/_rst/condition/input_target_condition.rst create mode 100644 docs/source/_rst/data/data_module.rst create mode 100644 docs/source/_rst/data/dataset.rst rename docs/source/_rst/{geometry => domain}/cartesian.rst (59%) rename docs/source/_rst/{geometry => domain}/difference_domain.rst (50%) create mode 100644 docs/source/_rst/domain/domain.rst rename docs/source/_rst/{geometry => domain}/ellipsoid.rst (59%) rename docs/source/_rst/{geometry => domain}/exclusion_domain.rst (50%) rename docs/source/_rst/{geometry => domain}/intersection_domain.rst (50%) rename docs/source/_rst/{geometry => domain}/operation_interface.rst (52%) rename docs/source/_rst/{geometry => domain}/simplex.rst (60%) rename docs/source/_rst/{geometry => domain}/union_domain.rst (50%) delete mode 100644 docs/source/_rst/geometry/location.rst diff --git a/docs/source/_rst/_code.rst b/docs/source/_rst/_code.rst index 16a4298..70851e9 100644 --- a/docs/source/_rst/_code.rst +++ b/docs/source/_rst/_code.rst @@ -12,22 +12,39 @@ The high-level structure of the package is depicted in our API. The pipeline to solve differential equations with PINA follows just five steps: 1. Define the `Problem`_ the user aim to solve - 2. Generate data using built in `Geometries`_, or load high level simulation results as :doc:`LabelTensor ` + 2. Generate data using built in `Domains`_, or load high level simulation results as :doc:`LabelTensor ` 3. Choose or build one or more `Models`_ to solve the problem 4. Choose a solver across PINA available `Solvers`_, or build one using the :doc:`SolverInterface ` - 5. Train the model with the PINA :doc:`Trainer `, enhance the train with `Callbacks`_ + 5. Train the model with the PINA :doc:`Trainer `, enhance the train with `Callback`_ -PINA Features --------------- + +Training and Datamodules +------------------------- +.. toctree:: + :titlesonly: + + Trainer + +Data Types +------------ .. toctree:: :titlesonly: LabelTensor - Condition - Trainer - Plotter +Conditions +------------- +.. toctree:: + :titlesonly: + + ConditionInterface + Condition + DataCondition + DomainEquationCondition + InputEquationCondition + InputTargetCondition + Solvers -------------- @@ -91,19 +108,19 @@ Adaptive Activation Functions .. toctree:: :titlesonly: - Adaptive Function Interface - Adaptive ReLU - Adaptive Sigmoid - Adaptive Tanh - Adaptive SiLU - Adaptive Mish - Adaptive ELU - Adaptive CELU - Adaptive GELU - Adaptive Softmin - Adaptive Softmax - Adaptive SIREN - Adaptive Exp + Adaptive Function Interface + Adaptive ReLU + Adaptive Sigmoid + Adaptive Tanh + Adaptive SiLU + Adaptive Mish + Adaptive ELU + Adaptive CELU + Adaptive GELU + Adaptive Softmin + Adaptive Softmax + Adaptive SIREN + Adaptive Exp Equations and Operators @@ -127,38 +144,39 @@ Problem TimeDependentProblem ParametricProblem -Geometries +Domains ----------------- .. toctree:: :titlesonly: - Location - CartesianDomain - EllipsoidDomain - SimplexDomain + Domain + CartesianDomain + EllipsoidDomain + SimplexDomain -Geometry set operations +domain set operations ------------------------ .. toctree:: :titlesonly: - OperationInterface - Union - Intersection - Difference - Exclusion + OperationInterface + Union + Intersection + Difference + Exclusion -Callbacks +Callback -------------------- .. toctree:: :titlesonly: - Processing Callbacks - Optimizer Callbacks - Adaptive Refinment Callback + Processing callback + Optimizer callback + Refinment callback + Weighting callback Metrics and Losses -------------------- diff --git a/docs/source/_rst/adaptive_functions/AdaptiveCELU.rst b/docs/source/_rst/adaptive_functions/AdaptiveCELU.rst deleted file mode 100644 index 9736ee6..0000000 --- a/docs/source/_rst/adaptive_functions/AdaptiveCELU.rst +++ /dev/null @@ -1,9 +0,0 @@ -AdaptiveCELU -============ - -.. currentmodule:: pina.adaptive_functions.adaptive_func - -.. autoclass:: AdaptiveCELU - :members: - :show-inheritance: - :inherited-members: AdaptiveActivationFunctionInterface diff --git a/docs/source/_rst/adaptive_functions/AdaptiveELU.rst b/docs/source/_rst/adaptive_functions/AdaptiveELU.rst deleted file mode 100644 index ad04717..0000000 --- a/docs/source/_rst/adaptive_functions/AdaptiveELU.rst +++ /dev/null @@ -1,9 +0,0 @@ -AdaptiveELU -=========== - -.. currentmodule:: pina.adaptive_functions.adaptive_func - -.. autoclass:: AdaptiveELU - :members: - :show-inheritance: - :inherited-members: AdaptiveActivationFunctionInterface diff --git a/docs/source/_rst/adaptive_functions/AdaptiveExp.rst b/docs/source/_rst/adaptive_functions/AdaptiveExp.rst deleted file mode 100644 index 7d07cd5..0000000 --- a/docs/source/_rst/adaptive_functions/AdaptiveExp.rst +++ /dev/null @@ -1,9 +0,0 @@ -AdaptiveExp -=========== - -.. currentmodule:: pina.adaptive_functions.adaptive_func - -.. autoclass:: AdaptiveExp - :members: - :show-inheritance: - :inherited-members: AdaptiveActivationFunctionInterface diff --git a/docs/source/_rst/adaptive_functions/AdaptiveFunctionInterface.rst b/docs/source/_rst/adaptive_functions/AdaptiveFunctionInterface.rst deleted file mode 100644 index 7cdf754..0000000 --- a/docs/source/_rst/adaptive_functions/AdaptiveFunctionInterface.rst +++ /dev/null @@ -1,8 +0,0 @@ -AdaptiveActivationFunctionInterface -======================================= - -.. currentmodule:: pina.adaptive_functions.adaptive_func_interface - -.. automodule:: pina.adaptive_functions.adaptive_func_interface - :members: - :show-inheritance: diff --git a/docs/source/_rst/adaptive_functions/AdaptiveGELU.rst b/docs/source/_rst/adaptive_functions/AdaptiveGELU.rst deleted file mode 100644 index 86e5875..0000000 --- a/docs/source/_rst/adaptive_functions/AdaptiveGELU.rst +++ /dev/null @@ -1,9 +0,0 @@ -AdaptiveGELU -============ - -.. currentmodule:: pina.adaptive_functions.adaptive_func - -.. autoclass:: AdaptiveGELU - :members: - :show-inheritance: - :inherited-members: AdaptiveActivationFunctionInterface diff --git a/docs/source/_rst/adaptive_functions/AdaptiveMish.rst b/docs/source/_rst/adaptive_functions/AdaptiveMish.rst deleted file mode 100644 index 4e1e3b4..0000000 --- a/docs/source/_rst/adaptive_functions/AdaptiveMish.rst +++ /dev/null @@ -1,9 +0,0 @@ -AdaptiveMish -============ - -.. currentmodule:: pina.adaptive_functions.adaptive_func - -.. autoclass:: AdaptiveMish - :members: - :show-inheritance: - :inherited-members: AdaptiveActivationFunctionInterface diff --git a/docs/source/_rst/adaptive_functions/AdaptiveReLU.rst b/docs/source/_rst/adaptive_functions/AdaptiveReLU.rst deleted file mode 100644 index ea08c29..0000000 --- a/docs/source/_rst/adaptive_functions/AdaptiveReLU.rst +++ /dev/null @@ -1,9 +0,0 @@ -AdaptiveReLU -============ - -.. currentmodule:: pina.adaptive_functions.adaptive_func - -.. autoclass:: AdaptiveReLU - :members: - :show-inheritance: - :inherited-members: AdaptiveActivationFunctionInterface diff --git a/docs/source/_rst/adaptive_functions/AdaptiveSIREN.rst b/docs/source/_rst/adaptive_functions/AdaptiveSIREN.rst deleted file mode 100644 index 96133bd..0000000 --- a/docs/source/_rst/adaptive_functions/AdaptiveSIREN.rst +++ /dev/null @@ -1,9 +0,0 @@ -AdaptiveSIREN -============= - -.. currentmodule:: pina.adaptive_functions.adaptive_func - -.. autoclass:: AdaptiveSIREN - :members: - :show-inheritance: - :inherited-members: AdaptiveActivationFunctionInterface diff --git a/docs/source/_rst/adaptive_functions/AdaptiveSiLU.rst b/docs/source/_rst/adaptive_functions/AdaptiveSiLU.rst deleted file mode 100644 index 2f359fd..0000000 --- a/docs/source/_rst/adaptive_functions/AdaptiveSiLU.rst +++ /dev/null @@ -1,9 +0,0 @@ -AdaptiveSiLU -============ - -.. currentmodule:: pina.adaptive_functions.adaptive_func - -.. autoclass:: AdaptiveSiLU - :members: - :show-inheritance: - :inherited-members: AdaptiveActivationFunctionInterface diff --git a/docs/source/_rst/adaptive_functions/AdaptiveSigmoid.rst b/docs/source/_rst/adaptive_functions/AdaptiveSigmoid.rst deleted file mode 100644 index 6f495a8..0000000 --- a/docs/source/_rst/adaptive_functions/AdaptiveSigmoid.rst +++ /dev/null @@ -1,9 +0,0 @@ -AdaptiveSigmoid -=============== - -.. currentmodule:: pina.adaptive_functions.adaptive_func - -.. autoclass:: AdaptiveSigmoid - :members: - :show-inheritance: - :inherited-members: AdaptiveActivationFunctionInterface diff --git a/docs/source/_rst/adaptive_functions/AdaptiveSoftmax.rst b/docs/source/_rst/adaptive_functions/AdaptiveSoftmax.rst deleted file mode 100644 index 5cab9c6..0000000 --- a/docs/source/_rst/adaptive_functions/AdaptiveSoftmax.rst +++ /dev/null @@ -1,9 +0,0 @@ -AdaptiveSoftmax -=============== - -.. currentmodule:: pina.adaptive_functions.adaptive_func - -.. autoclass:: AdaptiveSoftmax - :members: - :show-inheritance: - :inherited-members: AdaptiveActivationFunctionInterface diff --git a/docs/source/_rst/adaptive_functions/AdaptiveSoftmin.rst b/docs/source/_rst/adaptive_functions/AdaptiveSoftmin.rst deleted file mode 100644 index a0e6c94..0000000 --- a/docs/source/_rst/adaptive_functions/AdaptiveSoftmin.rst +++ /dev/null @@ -1,9 +0,0 @@ -AdaptiveSoftmin -=============== - -.. currentmodule:: pina.adaptive_functions.adaptive_func - -.. autoclass:: AdaptiveSoftmin - :members: - :show-inheritance: - :inherited-members: AdaptiveActivationFunctionInterface diff --git a/docs/source/_rst/adaptive_functions/AdaptiveTanh.rst b/docs/source/_rst/adaptive_functions/AdaptiveTanh.rst deleted file mode 100644 index 3e48651..0000000 --- a/docs/source/_rst/adaptive_functions/AdaptiveTanh.rst +++ /dev/null @@ -1,9 +0,0 @@ -AdaptiveTanh -============ - -.. currentmodule:: pina.adaptive_functions.adaptive_func - -.. autoclass:: AdaptiveTanh - :members: - :show-inheritance: - :inherited-members: AdaptiveActivationFunctionInterface diff --git a/docs/source/_rst/callback/adaptive_refinment_callbacks.rst b/docs/source/_rst/callback/adaptive_refinment_callbacks.rst new file mode 100644 index 0000000..8afad65 --- /dev/null +++ b/docs/source/_rst/callback/adaptive_refinment_callbacks.rst @@ -0,0 +1,7 @@ +Refinments callbacks +======================= + +.. currentmodule:: pina.callback.adaptive_refinement_callback +.. autoclass:: R3Refinement + :members: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/_rst/callback/linear_weight_update_callback.rst b/docs/source/_rst/callback/linear_weight_update_callback.rst new file mode 100644 index 0000000..fe45b56 --- /dev/null +++ b/docs/source/_rst/callback/linear_weight_update_callback.rst @@ -0,0 +1,7 @@ +Weighting callbacks +======================== + +.. currentmodule:: pina.callback.linear_weight_update_callback +.. autoclass:: LinearWeightUpdate + :members: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/_rst/callbacks/optimizer_callbacks.rst b/docs/source/_rst/callback/optimizer_callbacks.rst similarity index 66% rename from docs/source/_rst/callbacks/optimizer_callbacks.rst rename to docs/source/_rst/callback/optimizer_callbacks.rst index 7ee418f..0afdc26 100644 --- a/docs/source/_rst/callbacks/optimizer_callbacks.rst +++ b/docs/source/_rst/callback/optimizer_callbacks.rst @@ -1,7 +1,7 @@ Optimizer callbacks ===================== -.. currentmodule:: pina.callbacks.optimizer_callbacks +.. currentmodule:: pina.callback.optimizer_callback .. autoclass:: SwitchOptimizer :members: :show-inheritance: \ No newline at end of file diff --git a/docs/source/_rst/callbacks/processing_callbacks.rst b/docs/source/_rst/callback/processing_callbacks.rst similarity index 76% rename from docs/source/_rst/callbacks/processing_callbacks.rst rename to docs/source/_rst/callback/processing_callbacks.rst index bd3bbc8..71f3d1f 100644 --- a/docs/source/_rst/callbacks/processing_callbacks.rst +++ b/docs/source/_rst/callback/processing_callbacks.rst @@ -1,7 +1,7 @@ Processing callbacks ======================= -.. currentmodule:: pina.callbacks.processing_callbacks +.. currentmodule:: pina.callbacks.processing_callback .. autoclass:: MetricTracker :members: :show-inheritance: diff --git a/docs/source/_rst/callbacks/adaptive_refinment_callbacks.rst b/docs/source/_rst/callbacks/adaptive_refinment_callbacks.rst deleted file mode 100644 index 11b313e..0000000 --- a/docs/source/_rst/callbacks/adaptive_refinment_callbacks.rst +++ /dev/null @@ -1,7 +0,0 @@ -Adaptive Refinments callbacks -=============================== - -.. currentmodule:: pina.callbacks.adaptive_refinment_callbacks -.. autoclass:: R3Refinement - :members: - :show-inheritance: \ No newline at end of file diff --git a/docs/source/_rst/condition.rst b/docs/source/_rst/condition.rst deleted file mode 100644 index 088b966..0000000 --- a/docs/source/_rst/condition.rst +++ /dev/null @@ -1,7 +0,0 @@ -Condition -========= -.. currentmodule:: pina.condition - -.. autoclass:: Condition - :members: - :show-inheritance: \ No newline at end of file diff --git a/docs/source/_rst/condition/condition.rst b/docs/source/_rst/condition/condition.rst new file mode 100644 index 0000000..51edfaf --- /dev/null +++ b/docs/source/_rst/condition/condition.rst @@ -0,0 +1,7 @@ +Conditions +============= +.. currentmodule:: pina.condition.condition + +.. autoclass:: Condition + :members: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/_rst/condition/condition_interface.rst b/docs/source/_rst/condition/condition_interface.rst new file mode 100644 index 0000000..8845962 --- /dev/null +++ b/docs/source/_rst/condition/condition_interface.rst @@ -0,0 +1,7 @@ +ConditionInterface +====================== +.. currentmodule:: pina.condition.condition_interface + +.. autoclass:: ConditionInterface + :members: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/_rst/condition/data_condition.rst b/docs/source/_rst/condition/data_condition.rst new file mode 100644 index 0000000..b7c322e --- /dev/null +++ b/docs/source/_rst/condition/data_condition.rst @@ -0,0 +1,15 @@ +Data Conditions +================== +.. currentmodule:: pina.condition.data_condition + +.. autoclass:: DataCondition + :members: + :show-inheritance: + +.. autoclass:: GraphDataCondition + :members: + :show-inheritance: + +.. autoclass:: TensorDataCondition + :members: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/_rst/condition/domain_equation_condition.rst b/docs/source/_rst/condition/domain_equation_condition.rst new file mode 100644 index 0000000..505c8b8 --- /dev/null +++ b/docs/source/_rst/condition/domain_equation_condition.rst @@ -0,0 +1,7 @@ +Domain Equation Condition +=========================== +.. currentmodule:: pina.condition.domain_equation_condition + +.. autoclass:: DomainEquationCondition + :members: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/_rst/condition/input_equation_condition.rst b/docs/source/_rst/condition/input_equation_condition.rst new file mode 100644 index 0000000..4f5450e --- /dev/null +++ b/docs/source/_rst/condition/input_equation_condition.rst @@ -0,0 +1,15 @@ +Input Equation Condition +=========================== +.. currentmodule:: pina.condition.input_equation_condition + +.. autoclass:: InputEquationCondition + :members: + :show-inheritance: + +.. autoclass:: InputTensorEquationCondition + :members: + :show-inheritance: + +.. autoclass:: InputGraphEquationCondition + :members: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/_rst/condition/input_target_condition.rst b/docs/source/_rst/condition/input_target_condition.rst new file mode 100644 index 0000000..960b7d6 --- /dev/null +++ b/docs/source/_rst/condition/input_target_condition.rst @@ -0,0 +1,23 @@ +Input Target Condition +=========================== +.. currentmodule:: pina.condition.input_target_condition + +.. autoclass:: InputTargetCondition + :members: + :show-inheritance: + +.. autoclass:: TensorInputTensorTargetCondition + :members: + :show-inheritance: + +.. autoclass:: TensorInputGraphTargetCondition + :members: + :show-inheritance: + +.. autoclass:: GraphInputTensorTargetCondition + :members: + :show-inheritance: + +.. autoclass:: GraphInputGraphTargetCondition + :members: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/_rst/data/data_module.rst b/docs/source/_rst/data/data_module.rst new file mode 100644 index 0000000..3275fa2 --- /dev/null +++ b/docs/source/_rst/data/data_module.rst @@ -0,0 +1,7 @@ +PinaDataModule +====================== +.. currentmodule:: pina.data.data_module + +.. autoclass:: PinaDataModule + :members: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/_rst/data/dataset.rst b/docs/source/_rst/data/dataset.rst new file mode 100644 index 0000000..d00bb77 --- /dev/null +++ b/docs/source/_rst/data/dataset.rst @@ -0,0 +1,7 @@ +PinaDataset +====================== +.. currentmodule:: pina.data.dataset + +.. autoclass:: PinaDataset + :members: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/_rst/geometry/cartesian.rst b/docs/source/_rst/domain/cartesian.rst similarity index 59% rename from docs/source/_rst/geometry/cartesian.rst rename to docs/source/_rst/domain/cartesian.rst index b57c02b..97f5e89 100644 --- a/docs/source/_rst/geometry/cartesian.rst +++ b/docs/source/_rst/domain/cartesian.rst @@ -1,8 +1,8 @@ CartesianDomain ====================== -.. currentmodule:: pina.geometry.cartesian +.. currentmodule:: pina.domain.cartesian -.. automodule:: pina.geometry.cartesian +.. automodule:: pina.domain.cartesian .. autoclass:: CartesianDomain :members: diff --git a/docs/source/_rst/geometry/difference_domain.rst b/docs/source/_rst/domain/difference_domain.rst similarity index 50% rename from docs/source/_rst/geometry/difference_domain.rst rename to docs/source/_rst/domain/difference_domain.rst index fc0b293..f25daa5 100644 --- a/docs/source/_rst/geometry/difference_domain.rst +++ b/docs/source/_rst/domain/difference_domain.rst @@ -1,8 +1,8 @@ Difference ====================== -.. currentmodule:: pina.geometry.difference_domain +.. currentmodule:: pina.domain.difference_domain -.. automodule:: pina.geometry.difference_domain +.. automodule:: pina.domain.difference_domain .. autoclass:: Difference :members: diff --git a/docs/source/_rst/domain/domain.rst b/docs/source/_rst/domain/domain.rst new file mode 100644 index 0000000..654bb48 --- /dev/null +++ b/docs/source/_rst/domain/domain.rst @@ -0,0 +1,9 @@ +Domain +=========== +.. currentmodule:: pina.domain.domain_interface + +.. automodule:: pina.domain.domain_interface + +.. autoclass:: Domain + :members: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/_rst/geometry/ellipsoid.rst b/docs/source/_rst/domain/ellipsoid.rst similarity index 59% rename from docs/source/_rst/geometry/ellipsoid.rst rename to docs/source/_rst/domain/ellipsoid.rst index 09af427..ee0d2b7 100644 --- a/docs/source/_rst/geometry/ellipsoid.rst +++ b/docs/source/_rst/domain/ellipsoid.rst @@ -1,8 +1,8 @@ EllipsoidDomain ====================== -.. currentmodule:: pina.geometry.ellipsoid +.. currentmodule:: pina.domain.ellipsoid -.. automodule:: pina.geometry.ellipsoid +.. automodule:: pina.domain.ellipsoid .. autoclass:: EllipsoidDomain :members: diff --git a/docs/source/_rst/geometry/exclusion_domain.rst b/docs/source/_rst/domain/exclusion_domain.rst similarity index 50% rename from docs/source/_rst/geometry/exclusion_domain.rst rename to docs/source/_rst/domain/exclusion_domain.rst index a07aafc..8d18be1 100644 --- a/docs/source/_rst/geometry/exclusion_domain.rst +++ b/docs/source/_rst/domain/exclusion_domain.rst @@ -1,8 +1,8 @@ Exclusion ====================== -.. currentmodule:: pina.geometry.exclusion_domain +.. currentmodule:: pina.domain.exclusion_domain -.. automodule:: pina.geometry.exclusion_domain +.. automodule:: pina.domain.exclusion_domain .. autoclass:: Exclusion :members: diff --git a/docs/source/_rst/geometry/intersection_domain.rst b/docs/source/_rst/domain/intersection_domain.rst similarity index 50% rename from docs/source/_rst/geometry/intersection_domain.rst rename to docs/source/_rst/domain/intersection_domain.rst index a3c1356..8b24986 100644 --- a/docs/source/_rst/geometry/intersection_domain.rst +++ b/docs/source/_rst/domain/intersection_domain.rst @@ -1,8 +1,8 @@ Intersection ====================== -.. currentmodule:: pina.geometry.intersection_domain +.. currentmodule:: pina.domain.intersection_domain -.. automodule:: pina.geometry.intersection_domain +.. automodule:: pina.domain.intersection_domain .. autoclass:: Intersection :members: diff --git a/docs/source/_rst/geometry/operation_interface.rst b/docs/source/_rst/domain/operation_interface.rst similarity index 52% rename from docs/source/_rst/geometry/operation_interface.rst rename to docs/source/_rst/domain/operation_interface.rst index 00a2d84..0acd393 100644 --- a/docs/source/_rst/geometry/operation_interface.rst +++ b/docs/source/_rst/domain/operation_interface.rst @@ -1,8 +1,8 @@ OperationInterface ====================== -.. currentmodule:: pina.geometry.operation_interface +.. currentmodule:: pina.domain.operation_interface -.. automodule:: pina.geometry.operation_interface +.. automodule:: pina.domain.operation_interface .. autoclass:: OperationInterface :members: diff --git a/docs/source/_rst/geometry/simplex.rst b/docs/source/_rst/domain/simplex.rst similarity index 60% rename from docs/source/_rst/geometry/simplex.rst rename to docs/source/_rst/domain/simplex.rst index b5a83e4..7accd7f 100644 --- a/docs/source/_rst/geometry/simplex.rst +++ b/docs/source/_rst/domain/simplex.rst @@ -1,8 +1,8 @@ SimplexDomain ====================== -.. currentmodule:: pina.geometry.simplex +.. currentmodule:: pina.domain.simplex -.. automodule:: pina.geometry.simplex +.. automodule:: pina.domain.simplex .. autoclass:: SimplexDomain :members: diff --git a/docs/source/_rst/geometry/union_domain.rst b/docs/source/_rst/domain/union_domain.rst similarity index 50% rename from docs/source/_rst/geometry/union_domain.rst rename to docs/source/_rst/domain/union_domain.rst index ad172d7..921e430 100644 --- a/docs/source/_rst/geometry/union_domain.rst +++ b/docs/source/_rst/domain/union_domain.rst @@ -1,8 +1,8 @@ Union ====================== -.. currentmodule:: pina.geometry.union_domain +.. currentmodule:: pina.domain.union_domain -.. automodule:: pina.geometry.union_domain +.. automodule:: pina.domain.union_domain .. autoclass:: Union :members: diff --git a/docs/source/_rst/geometry/location.rst b/docs/source/_rst/geometry/location.rst deleted file mode 100644 index 5d680a1..0000000 --- a/docs/source/_rst/geometry/location.rst +++ /dev/null @@ -1,9 +0,0 @@ -Location -==================== -.. currentmodule:: pina.geometry.location - -.. automodule:: pina.geometry.location - -.. autoclass:: Location - :members: - :show-inheritance: \ No newline at end of file diff --git a/docs/source/_tutorial.rst b/docs/source/_tutorial.rst index 4e2d205..c12bfa6 100644 --- a/docs/source/_tutorial.rst +++ b/docs/source/_tutorial.rst @@ -9,10 +9,10 @@ Getting started with PINA :maxdepth: 3 :titlesonly: - Introduction to PINA for Physics Informed Neural Networks training - Introduction to PINA Equation class - PINA and PyTorch Lightning, training tips and visualizations - Building custom geometries with PINA Location class + `Introduction to PINA for Physics Informed Neural Networks training `_ + `Introduction to PINA Equation class `_ + `PINA and PyTorch Lightning, training tips and visualizations `_ + `Building custom geometries with PINA Location class `_ Physics Informed Neural Networks @@ -21,11 +21,11 @@ Physics Informed Neural Networks :maxdepth: 3 :titlesonly: - Two dimensional Poisson problem using Extra Features Learning - Two dimensional Wave problem with hard constraint - Resolution of a 2D Poisson inverse problem - Periodic Boundary Conditions for Helmotz Equation - Multiscale PDE learning with Fourier Feature Network + `Two dimensional Poisson problem using Extra Features Learning `_ + `Two dimensional Wave problem with hard constraint `_ + `Resolution of a 2D Poisson inverse problem `_ + `Periodic Boundary Conditions for Helmotz Equation `_ + `Multiscale PDE learning with Fourier Feature Network `_ Neural Operator Learning ------------------------ @@ -33,8 +33,8 @@ Neural Operator Learning :maxdepth: 3 :titlesonly: - Two dimensional Darcy flow using the Fourier Neural Operator - Time dependent Kuramoto Sivashinsky equation using the Averaging Neural Operator + `Two dimensional Darcy flow using the Fourier Neural Operator `_ + `Time dependent Kuramoto Sivashinsky equation using the Averaging Neural Operator `_ Supervised Learning ------------------- @@ -42,5 +42,5 @@ Supervised Learning :maxdepth: 3 :titlesonly: - Unstructured convolutional autoencoder via continuous convolution - POD-RBF and POD-NN for reduced order modeling + `Unstructured convolutional autoencoder via continuous convolution `_ + `POD-RBF and POD-NN for reduced order modeling `_