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

Update doc data

Browse Source
This commit is contained in:
FilippoOlivo
2025-03-12 09:25:31 +01:00
parent 3e02bb3773
commit d3629b2b54
2 changed files with 17 additions and 16 deletions
Download Patch File Download Diff File Expand all files Collapse all files

20
pina/data/data_module.py
View File

@@ -112,7 +112,7 @@ class Collator:
"""
Function used to create a batch when automatic batching is disabled.
:param list(int) batch: List of integers representing the indices of
:param list[int] batch: List of integers representing the indices of
the data points to be fetched.
:return: Dictionary containing the data points fetched from the dataset.
:rtype: dict
@@ -124,7 +124,7 @@ class Collator:
"""
Function used to collate the batch
:param list(dict) batch: List of retrieved data.
:param list[dict] batch: List of retrieved data.
:return: Dictionary containing the data points fetched from the dataset,
collated.
:rtype: dict
@@ -160,7 +160,7 @@ class Collator:
:class:`PinaTensorDataset`.
:param data_list: Elements to be collated.
:type data_list: list(torch.Tensor) | list(LabelTensor)
:type data_list: list[torch.Tensor] | list[LabelTensor]
:return: Batch of data.
:rtype: dict
@@ -180,7 +180,7 @@ class Collator:
:class:`PinaGraphDataset`.
:param data_list: Elememts to be collated.
:type data_list: list(torch_geometric.data.Data) | list(Graph)
:type data_list: list[torch_geometric.data.Data] | list[Graph]
:return: Batch of data.
:rtype: dict
@@ -206,7 +206,7 @@ class Collator:
during class initialization.
:param batch: List of retrieved data or sampled indices.
:type batch: list(int) | list(dict)
:type batch: list[int] | list[dict]
:return: Dictionary containing the data points fetched from the dataset,
collated.
:rtype: dict
@@ -582,12 +582,12 @@ class PinaDataModule(LightningDataModule):
Transfer the batch to the device. This method is used when the batch
size is None: batch has already been transferred to the device.
:param list(tuple) batch: list of tuple where the first element of the
:param list[tuple] batch: List of tuple where the first element of the
tuple is the condition name and the second element is the data.
:param torch.device device: device to which the batch is transferred.
:param int dataloader_idx: index of the dataloader.
:param torch.device device: Device to which the batch is transferred.
:param int dataloader_idx: Index of the dataloader.
:return: The batch transferred to the device.
:rtype: list(tuple)
:rtype: list[tuple]
"""
return batch
@@ -602,7 +602,7 @@ class PinaDataModule(LightningDataModule):
transferred.
:param int dataloader_idx: The index of the dataloader.
:return: The batch transferred to the device.
:rtype: list(tuple)
:rtype: list[tuple]
"""
batch = [