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

Update doc condition

Browse Source
This commit is contained in:
FilippoOlivo
2025-03-12 09:20:43 +01:00
committed by Nicola Demo
parent cbbaa4062f
commit 415dbcc72a
4 changed files with 28 additions and 12 deletions
Download Patch File Download Diff File Expand all files Collapse all files

3
pina/condition/condition_interface.py
View File

@@ -45,7 +45,8 @@ class ConditionInterface(metaclass=ABCMeta):
objects is consistent. objects is consistent.
:param data_list: List of graph type objects. :param data_list: List of graph type objects.
:type data_list: list(torch_geometric.data.Data) | list(Graph) :type data_list: torch_geometric.data.Data | Graph|
list[torch_geometric.data.Data] | list[Graph]
:raises ValueError: Input data must be either torch_geometric.data.Data :raises ValueError: Input data must be either torch_geometric.data.Data
or Graph objects. or Graph objects.

11
pina/condition/data_condition.py
View File

@@ -26,8 +26,10 @@ class DataCondition(ConditionInterface):
types of input data. types of input data.
:param input: Input data for the condition. :param input: Input data for the condition.
:type input: torch.Tensor | LabelTensor | Graph | :type input: torch.Tensor | LabelTensor | Graph |
torch_geometric.data.Data torch_geometric.data.Data | list[Graph] |
list[torch_geometric.data.Data] | tuple[Graph] |
tuple[torch_geometric.data.Data]
:param conditional_variables: Conditional variables for the condition. :param conditional_variables: Conditional variables for the condition.
:type conditional_variables: torch.Tensor | LabelTensor :type conditional_variables: torch.Tensor | LabelTensor
:return: Subclass of DataCondition. :return: Subclass of DataCondition.
@@ -61,7 +63,10 @@ class DataCondition(ConditionInterface):
variables (if any). variables (if any).
:param input: Input data for the condition. :param input: Input data for the condition.
:type input: torch.Tensor or Graph or torch_geometric.data.Data :type input: torch.Tensor | LabelTensor | Graph |
torch_geometric.data.Data | list[Graph] |
list[torch_geometric.data.Data] | tuple[Graph] |
tuple[torch_geometric.data.Data]
:param conditional_variables: Conditional variables for the condition. :param conditional_variables: Conditional variables for the condition.
:type conditional_variables: torch.Tensor or LabelTensor :type conditional_variables: torch.Tensor or LabelTensor

4
pina/condition/input_equation_condition.py
View File

@@ -26,7 +26,7 @@ class InputEquationCondition(ConditionInterface):
the type of input data. the type of input data.
:param input: Input data. It can be a LabelTensor or a Graph object. :param input: Input data. It can be a LabelTensor or a Graph object.
:type input: LabelTensor | Graph :type input: LabelTensor | Graph | list[Graph] | tuple[Graph]
:param EquationInterface equation: Equation object containing the :param EquationInterface equation: Equation object containing the
equation function. equation function.
:return: Subclass of InputEquationCondition, based on the input type. :return: Subclass of InputEquationCondition, based on the input type.
@@ -61,7 +61,7 @@ class InputEquationCondition(ConditionInterface):
Initialize the InputEquationCondition by storing the input and equation. Initialize the InputEquationCondition by storing the input and equation.
:param input: Input data for the condition. :param input: Input data for the condition.
:type input: torch.Tensor | Graph :type input: LabelTensor | Graph | list[Graph] | tuple[Graph]
:param EquationInterface equation: Equation object containing the :param EquationInterface equation: Equation object containing the
equation function. equation function.

22
pina/condition/input_target_condition.py
View File

@@ -25,11 +25,15 @@ class InputTargetCondition(ConditionInterface):
the types of input and target data. the types of input and target data.
:param input: Input data for the condition. :param input: Input data for the condition.
:type input: torch.Tensor | Graph | torch_geometric.data.Data | list | \ :type input: torch.Tensor | LabelTensor | Graph |
tuple torch_geometric.data.Data | list[Graph] |
list[torch_geometric.data.Data] | tuple[Graph] |
tuple[torch_geometric.data.Data]
:param target: Target data for the condition. :param target: Target data for the condition.
:type target: torch.Tensor | Graph | torch_geometric.data.Data | list \ :type target: torch.Tensor | LabelTensor | Graph |
| tuple torch_geometric.data.Data | list[Graph] |
list[torch_geometric.data.Data] | tuple[Graph] |
tuple[torch_geometric.data.Data]
:return: Subclass of InputTargetCondition :return: Subclass of InputTargetCondition
:rtype: TensorInputTensorTargetCondition | \ :rtype: TensorInputTensorTargetCondition | \
TensorInputGraphTargetCondition | \ TensorInputGraphTargetCondition | \
@@ -81,9 +85,15 @@ class InputTargetCondition(ConditionInterface):
Initialize the InputTargetCondition, storing the input and target data. Initialize the InputTargetCondition, storing the input and target data.
:param input: Input data for the condition. :param input: Input data for the condition.
:type input: torch.Tensor | Graph | torch_geometric.data.Data :type input: torch.Tensor | LabelTensor | Graph |
torch_geometric.data.Data | list[Graph] |
list[torch_geometric.data.Data] | tuple[Graph] |
tuple[torch_geometric.data.Data]
:param target: Target data for the condition. :param target: Target data for the condition.
:type target: torch.Tensor | Graph | torch_geometric.data.Data :type target: torch.Tensor | LabelTensor | Graph |
torch_geometric.data.Data | list[Graph] |
list[torch_geometric.data.Data] | tuple[Graph] |
tuple[torch_geometric.data.Data]
.. note:: .. note::
If either ``input`` or ``target`` are composed by a list of If either ``input`` or ``target`` are composed by a list of