From 415dbcc72acecd232481995dd62f29dcb234e220 Mon Sep 17 00:00:00 2001 From: FilippoOlivo Date: Wed, 12 Mar 2025 09:20:43 +0100 Subject: [PATCH] Update doc condition --- pina/condition/condition_interface.py | 3 ++- pina/condition/data_condition.py | 11 ++++++++--- pina/condition/input_equation_condition.py | 4 ++-- pina/condition/input_target_condition.py | 22 ++++++++++++++++------ 4 files changed, 28 insertions(+), 12 deletions(-) diff --git a/pina/condition/condition_interface.py b/pina/condition/condition_interface.py index 7ff66ed..d31030d 100644 --- a/pina/condition/condition_interface.py +++ b/pina/condition/condition_interface.py @@ -45,7 +45,8 @@ class ConditionInterface(metaclass=ABCMeta): objects is consistent. :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 or Graph objects. diff --git a/pina/condition/data_condition.py b/pina/condition/data_condition.py index 2b3eeb0..5f158af 100644 --- a/pina/condition/data_condition.py +++ b/pina/condition/data_condition.py @@ -26,8 +26,10 @@ class DataCondition(ConditionInterface): types of input data. :param input: Input data for the condition. - :type input: torch.Tensor | LabelTensor | 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 conditional_variables: Conditional variables for the condition. :type conditional_variables: torch.Tensor | LabelTensor :return: Subclass of DataCondition. @@ -61,7 +63,10 @@ class DataCondition(ConditionInterface): variables (if any). :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. :type conditional_variables: torch.Tensor or LabelTensor diff --git a/pina/condition/input_equation_condition.py b/pina/condition/input_equation_condition.py index f41b695..90bd924 100644 --- a/pina/condition/input_equation_condition.py +++ b/pina/condition/input_equation_condition.py @@ -26,7 +26,7 @@ class InputEquationCondition(ConditionInterface): the type of input data. :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 equation function. :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. :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 equation function. diff --git a/pina/condition/input_target_condition.py b/pina/condition/input_target_condition.py index e3924f0..7239051 100644 --- a/pina/condition/input_target_condition.py +++ b/pina/condition/input_target_condition.py @@ -25,11 +25,15 @@ class InputTargetCondition(ConditionInterface): the types of input and target data. :param input: Input data for the condition. - :type input: torch.Tensor | Graph | torch_geometric.data.Data | list | \ - tuple + :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. - :type target: torch.Tensor | Graph | torch_geometric.data.Data | list \ - | tuple + :type target: torch.Tensor | LabelTensor | Graph | + torch_geometric.data.Data | list[Graph] | + list[torch_geometric.data.Data] | tuple[Graph] | + tuple[torch_geometric.data.Data] :return: Subclass of InputTargetCondition :rtype: TensorInputTensorTargetCondition | \ TensorInputGraphTargetCondition | \ @@ -81,9 +85,15 @@ class InputTargetCondition(ConditionInterface): Initialize the InputTargetCondition, storing the input and target data. :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. - :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:: If either ``input`` or ``target`` are composed by a list of