folivo/PINA
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Improve doc condition

Browse Source
This commit is contained in:
FilippoOlivo
2025-03-13 15:49:50 +01:00
parent b9b25e7b4a
commit 08de548e34
5 changed files with 103 additions and 66 deletions
Download Patch File Download Diff File Expand all files Collapse all files

15
pina/condition/input_target_condition.py
View File

@@ -12,7 +12,20 @@ from .condition_interface import ConditionInterface
class InputTargetCondition(ConditionInterface):
"""
Condition defined by input and target data. This condition can be used in
both supervised learning and Physics-informed problems.
both supervised learning and Physics-informed problems. Based on the type of
the input and target, different condition implementations are available:
- :class:`TensorInputTensorTargetCondition`: For :class:`torch.Tensor` or
:class:`~pina.label_tensor.LabelTensor` input and target data.
- :class:`TensorInputGraphTargetCondition`: For :class:`torch.Tensor` or
:class:`~pina.label_tensor.LabelTensor` input and
:class:`~pina.graph.Graph` or :class:`~torch_geometric.data.Data`
target data.
- :class:`GraphInputTensorTargetCondition`: For :class:`~pina.graph.Graph`
or :class:`~torch_geometric.data.Data` input and :class:`torch.Tensor`
or :class:`~pina.label_tensor.LabelTensor` target data.
- :class:`GraphInputGraphTargetCondition`: For :class:`~pina.graph.Graph` or
:class:`~torch_geometric.data.Data` input and target data.
"""
__slots__ = ["input", "target"]