Improve doc condition

This commit is contained in:
FilippoOlivo
2025-03-13 15:49:50 +01:00
committed by Nicola Demo
parent 7dd954ce50
commit 65534c998a
5 changed files with 103 additions and 66 deletions

View File

@@ -12,7 +12,13 @@ from ..graph import Graph
class DataCondition(ConditionInterface):
"""
Condition defined by input data and conditional variables. It can be used
in unsupervised learning problems.
in unsupervised learning problems. Based on the type of the input,
different condition implementations are available:
- :class:`TensorDataCondition`: For :class:`torch.Tensor` or
:class:`~pina.label_tensor.LabelTensor` input data.
- :class:`GraphDataCondition`: For :class:`~pina.graph.Graph` or
:class:`~torch_geometric.data.Data` input data.
"""
__slots__ = ["input", "conditional_variables"]