@@ -12,21 +12,38 @@ The high-level structure of the package is depicted in our API.
1212The pipeline to solve differential equations with PINA follows just five steps:
1313
1414 1. Define the `Problem `_ the user aim to solve
15- 2. Generate data using built in `Geometries `_, or load high level simulation results as :doc: `LabelTensor <label_tensor >`
15+ 2. Generate data using built in `Domains `_, or load high level simulation results as :doc: `LabelTensor <label_tensor >`
1616 3. Choose or build one or more `Models `_ to solve the problem
1717 4. Choose a solver across PINA available `Solvers `_, or build one using the :doc: `SolverInterface <solvers/solver_interface >`
18- 5. Train the model with the PINA :doc: `Trainer <solvers/solver_interface >`, enhance the train with `Callbacks `_
18+ 5. Train the model with the PINA :doc: `Trainer <solvers/solver_interface >`, enhance the train with `Callback `_
1919
20- PINA Features
21- --------------
20+
21+ Training and Datamodules
22+ -------------------------
2223.. toctree ::
2324 :titlesonly:
2425
25- LabelTensor <label_tensor.rst >
26- Condition <condition.rst >
2726 Trainer <trainer.rst >
28- Plotter <plotter.rst >
2927
28+ Data Types
29+ ------------
30+ .. toctree ::
31+ :titlesonly:
32+
33+ LabelTensor <label_tensor.rst >
34+
35+
36+ Conditions
37+ -------------
38+ .. toctree ::
39+ :titlesonly:
40+
41+ ConditionInterface <condition/condition_interface.rst >
42+ Condition <condition/condition.rst >
43+ DataCondition <condition/data_condition.rst >
44+ DomainEquationCondition <condition/domain_equation_condition.rst >
45+ InputEquationCondition <condition/input_equation_condition.rst >
46+ InputTargetCondition <condition/input_target_condition.rst >
3047
3148Solvers
3249--------------
@@ -91,19 +108,19 @@ Adaptive Activation Functions
91108.. toctree ::
92109 :titlesonly:
93110
94- Adaptive Function Interface <adaptive_functions /AdaptiveFunctionInterface.rst >
95- Adaptive ReLU <adaptive_functions /AdaptiveReLU.rst >
96- Adaptive Sigmoid <adaptive_functions /AdaptiveSigmoid.rst >
97- Adaptive Tanh <adaptive_functions /AdaptiveTanh.rst >
98- Adaptive SiLU <adaptive_functions /AdaptiveSiLU.rst >
99- Adaptive Mish <adaptive_functions /AdaptiveMish.rst >
100- Adaptive ELU <adaptive_functions /AdaptiveELU.rst >
101- Adaptive CELU <adaptive_functions /AdaptiveCELU.rst >
102- Adaptive GELU <adaptive_functions /AdaptiveGELU.rst >
103- Adaptive Softmin <adaptive_functions /AdaptiveSoftmin.rst >
104- Adaptive Softmax <adaptive_functions /AdaptiveSoftmax.rst >
105- Adaptive SIREN <adaptive_functions /AdaptiveSIREN.rst >
106- Adaptive Exp <adaptive_functions /AdaptiveExp.rst >
111+ Adaptive Function Interface <adaptive_function /AdaptiveFunctionInterface.rst >
112+ Adaptive ReLU <adaptive_function /AdaptiveReLU.rst >
113+ Adaptive Sigmoid <adaptive_function /AdaptiveSigmoid.rst >
114+ Adaptive Tanh <adaptive_function /AdaptiveTanh.rst >
115+ Adaptive SiLU <adaptive_function /AdaptiveSiLU.rst >
116+ Adaptive Mish <adaptive_function /AdaptiveMish.rst >
117+ Adaptive ELU <adaptive_function /AdaptiveELU.rst >
118+ Adaptive CELU <adaptive_function /AdaptiveCELU.rst >
119+ Adaptive GELU <adaptive_function /AdaptiveGELU.rst >
120+ Adaptive Softmin <adaptive_function /AdaptiveSoftmin.rst >
121+ Adaptive Softmax <adaptive_function /AdaptiveSoftmax.rst >
122+ Adaptive SIREN <adaptive_function /AdaptiveSIREN.rst >
123+ Adaptive Exp <adaptive_function /AdaptiveExp.rst >
107124
108125
109126Equations and Operators
@@ -127,38 +144,39 @@ Problem
127144 TimeDependentProblem <problem/timedepproblem.rst >
128145 ParametricProblem <problem/parametricproblem.rst >
129146
130- Geometries
147+ Domains
131148-----------------
132149
133150.. toctree ::
134151 :titlesonly:
135152
136- Location < geometry/location .rst >
137- CartesianDomain <geometry /cartesian.rst >
138- EllipsoidDomain <geometry /ellipsoid.rst >
139- SimplexDomain <geometry /simplex.rst >
153+ Domain < domain/domain .rst >
154+ CartesianDomain <domain /cartesian.rst >
155+ EllipsoidDomain <domain /ellipsoid.rst >
156+ SimplexDomain <domain /simplex.rst >
140157
141- Geometry set operations
158+ domain set operations
142159------------------------
143160
144161.. toctree ::
145162 :titlesonly:
146163
147- OperationInterface <geometry /operation_interface.rst >
148- Union <geometry /union_domain.rst >
149- Intersection <geometry /intersection_domain.rst >
150- Difference <geometry /difference_domain.rst >
151- Exclusion <geometry /exclusion_domain.rst >
164+ OperationInterface <domain /operation_interface.rst >
165+ Union <domain /union_domain.rst >
166+ Intersection <domain /intersection_domain.rst >
167+ Difference <domain /difference_domain.rst >
168+ Exclusion <domain /exclusion_domain.rst >
152169
153- Callbacks
170+ Callback
154171--------------------
155172
156173.. toctree ::
157174 :titlesonly:
158175
159- Processing Callbacks <callbacks/processing_callbacks.rst >
160- Optimizer Callbacks <callbacks/optimizer_callbacks.rst >
161- Adaptive Refinment Callback <callbacks/adaptive_refinment_callbacks.rst >
176+ Processing callback <callback/processing_callback.rst >
177+ Optimizer callback <callback/optimizer_callback.rst >
178+ Refinment callback <callback/adaptive_refinment_callback.rst >
179+ Weighting callback <callback/linear_weight_update_callback.rst >
162180
163181Metrics and Losses
164182--------------------
0 commit comments